knockapi 1.0.0 → 1.2.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 (555) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +61 -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 +9 -1
  14. data/lib/knockapi/internal/type/base_model.rb +78 -39
  15. data/lib/knockapi/internal/type/boolean.rb +8 -0
  16. data/lib/knockapi/internal/type/converter.rb +18 -0
  17. data/lib/knockapi/internal/type/enum.rb +13 -0
  18. data/lib/knockapi/internal/type/file_input.rb +7 -0
  19. data/lib/knockapi/internal/type/hash_of.rb +9 -1
  20. data/lib/knockapi/internal/type/request_parameters.rb +6 -12
  21. data/lib/knockapi/internal/type/union.rb +16 -3
  22. data/lib/knockapi/internal/type/unknown.rb +8 -0
  23. data/lib/knockapi/internal/util.rb +119 -2
  24. data/lib/knockapi/internal.rb +9 -0
  25. data/lib/knockapi/models/activity.rb +6 -6
  26. data/lib/knockapi/models/audience_add_members_params.rb +10 -8
  27. data/lib/knockapi/models/audience_add_members_response.rb +7 -0
  28. data/lib/knockapi/models/audience_list_members_response.rb +6 -6
  29. data/lib/knockapi/models/audience_member.rb +5 -6
  30. data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
  31. data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
  32. data/lib/knockapi/models/bulk_operation.rb +7 -8
  33. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
  34. data/lib/knockapi/models/condition.rb +4 -4
  35. data/lib/knockapi/models/identify_user_request.rb +16 -17
  36. data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
  37. data/lib/knockapi/models/inline_object_request.rb +8 -6
  38. data/lib/knockapi/models/inline_tenant_request.rb +2 -2
  39. data/lib/knockapi/models/message.rb +19 -23
  40. data/lib/knockapi/models/message_delivery_log.rb +18 -18
  41. data/lib/knockapi/models/message_event.rb +9 -10
  42. data/lib/knockapi/models/message_list_params.rb +14 -15
  43. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  44. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  45. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  46. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  47. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  48. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  49. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  50. data/lib/knockapi/models/object.rb +9 -1
  51. data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
  52. data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
  53. data/lib/knockapi/models/object_delete_response.rb +7 -0
  54. data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
  55. data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
  56. data/lib/knockapi/models/object_list_messages_params.rb +16 -14
  57. data/lib/knockapi/models/object_list_params.rb +3 -4
  58. data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
  59. data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
  60. data/lib/knockapi/models/object_set_params.rb +15 -13
  61. data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
  62. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
  63. data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
  64. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
  65. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
  66. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
  67. data/lib/knockapi/models/recipient.rb +3 -3
  68. data/lib/knockapi/models/recipient_reference.rb +2 -2
  69. data/lib/knockapi/models/recipient_request.rb +3 -3
  70. data/lib/knockapi/models/recipients/channel_data.rb +14 -14
  71. data/lib/knockapi/models/recipients/channel_data_request.rb +10 -10
  72. data/lib/knockapi/models/recipients/discord_channel_data.rb +16 -10
  73. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +24 -1
  74. data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
  75. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +16 -10
  76. data/lib/knockapi/models/recipients/preference_set.rb +34 -28
  77. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
  78. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +36 -36
  79. data/lib/knockapi/models/recipients/preference_set_request.rb +34 -28
  80. data/lib/knockapi/models/recipients/slack_channel_data.rb +12 -10
  81. data/lib/knockapi/models/recipients/subscription.rb +6 -6
  82. data/lib/knockapi/models/schedule.rb +11 -12
  83. data/lib/knockapi/models/schedule_create_params.rb +10 -15
  84. data/lib/knockapi/models/schedule_create_response.rb +1 -1
  85. data/lib/knockapi/models/schedule_delete_response.rb +1 -1
  86. data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
  87. data/lib/knockapi/models/schedule_update_params.rb +9 -10
  88. data/lib/knockapi/models/schedule_update_response.rb +1 -1
  89. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
  90. data/lib/knockapi/models/tenant.rb +13 -16
  91. data/lib/knockapi/models/tenant_delete_response.rb +7 -0
  92. data/lib/knockapi/models/tenant_request.rb +20 -20
  93. data/lib/knockapi/models/tenant_set_params.rb +19 -19
  94. data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
  95. data/lib/knockapi/models/user.rb +9 -11
  96. data/lib/knockapi/models/user_delete_response.rb +7 -0
  97. data/lib/knockapi/models/user_list_messages_params.rb +18 -14
  98. data/lib/knockapi/models/user_list_params.rb +3 -4
  99. data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
  100. data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
  101. data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
  102. data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
  103. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
  104. data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
  105. data/lib/knockapi/models/users/feed_list_items_response.rb +6 -6
  106. data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
  107. data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
  108. data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
  109. data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
  110. data/lib/knockapi/models.rb +213 -0
  111. data/lib/knockapi/request_options.rb +4 -0
  112. data/lib/knockapi/resources/audiences.rb +4 -4
  113. data/lib/knockapi/resources/bulk_operations.rb +2 -2
  114. data/lib/knockapi/resources/channels/bulk.rb +7 -8
  115. data/lib/knockapi/resources/integrations/census.rb +1 -1
  116. data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
  117. data/lib/knockapi/resources/messages/batch.rb +22 -22
  118. data/lib/knockapi/resources/messages.rb +32 -39
  119. data/lib/knockapi/resources/objects/bulk.rb +11 -11
  120. data/lib/knockapi/resources/objects.rb +52 -62
  121. data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
  122. data/lib/knockapi/resources/providers/slack.rb +4 -4
  123. data/lib/knockapi/resources/schedules/bulk.rb +4 -4
  124. data/lib/knockapi/resources/schedules.rb +18 -23
  125. data/lib/knockapi/resources/tenants/bulk.rb +7 -7
  126. data/lib/knockapi/resources/tenants.rb +11 -11
  127. data/lib/knockapi/resources/users/bulk.rb +11 -11
  128. data/lib/knockapi/resources/users/feeds.rb +3 -3
  129. data/lib/knockapi/resources/users/guides.rb +4 -4
  130. data/lib/knockapi/resources/users.rb +46 -54
  131. data/lib/knockapi/resources/workflows.rb +6 -11
  132. data/lib/knockapi/version.rb +1 -1
  133. data/lib/knockapi.rb +11 -2
  134. data/rbi/knockapi/client.rbi +5 -4
  135. data/rbi/knockapi/errors.rbi +35 -16
  136. data/rbi/knockapi/file_part.rbi +9 -6
  137. data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
  138. data/rbi/knockapi/internal/items_cursor.rbi +9 -4
  139. data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
  140. data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
  141. data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
  142. data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
  143. data/rbi/knockapi/internal/type/array_of.rbi +40 -24
  144. data/rbi/knockapi/internal/type/base_model.rbi +156 -73
  145. data/rbi/knockapi/internal/type/base_page.rbi +12 -8
  146. data/rbi/knockapi/internal/type/boolean.rbi +22 -14
  147. data/rbi/knockapi/internal/type/converter.rbi +70 -28
  148. data/rbi/knockapi/internal/type/enum.rbi +33 -15
  149. data/rbi/knockapi/internal/type/file_input.rbi +13 -4
  150. data/rbi/knockapi/internal/type/hash_of.rbi +40 -24
  151. data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
  152. data/rbi/knockapi/internal/type/union.rbi +60 -19
  153. data/rbi/knockapi/internal/type/unknown.rbi +22 -6
  154. data/rbi/knockapi/internal/util.rbi +273 -87
  155. data/rbi/knockapi/internal.rbi +5 -0
  156. data/rbi/knockapi/models/activity.rbi +28 -22
  157. data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
  158. data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
  159. data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
  160. data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
  161. data/rbi/knockapi/models/audience_member.rbi +23 -11
  162. data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
  163. data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
  164. data/rbi/knockapi/models/bulk_operation.rbi +70 -42
  165. data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
  166. data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
  167. data/rbi/knockapi/models/condition.rbi +78 -31
  168. data/rbi/knockapi/models/identify_user_request.rbi +90 -36
  169. data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
  170. data/rbi/knockapi/models/inline_object_request.rbi +76 -22
  171. data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
  172. data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
  173. data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
  174. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
  175. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
  176. data/rbi/knockapi/models/message.rbi +140 -72
  177. data/rbi/knockapi/models/message_archive_params.rbi +13 -5
  178. data/rbi/knockapi/models/message_delivery_log.rbi +175 -72
  179. data/rbi/knockapi/models/message_event.rbi +83 -37
  180. data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
  181. data/rbi/knockapi/models/message_get_content_response.rbi +366 -226
  182. data/rbi/knockapi/models/message_get_params.rbi +13 -5
  183. data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
  184. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
  185. data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
  186. data/rbi/knockapi/models/message_list_params.rbi +162 -58
  187. data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
  188. data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
  189. data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
  190. data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
  191. data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
  192. data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
  193. data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
  194. data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
  195. data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
  196. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +370 -227
  197. data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
  198. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
  199. data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
  200. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
  201. data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
  202. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
  203. data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
  204. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
  205. data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
  206. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
  207. data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
  208. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
  209. data/rbi/knockapi/models/object.rbi +31 -10
  210. data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
  211. data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
  212. data/rbi/knockapi/models/object_delete_params.rbi +13 -5
  213. data/rbi/knockapi/models/object_delete_response.rbi +7 -0
  214. data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
  215. data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
  216. data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
  217. data/rbi/knockapi/models/object_get_params.rbi +13 -5
  218. data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
  219. data/rbi/knockapi/models/object_list_messages_params.rbi +185 -61
  220. data/rbi/knockapi/models/object_list_params.rbi +43 -22
  221. data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
  222. data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
  223. data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
  224. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
  225. data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
  226. data/rbi/knockapi/models/object_set_params.rbi +89 -33
  227. data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
  228. data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
  229. data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
  230. data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
  231. data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
  232. data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
  233. data/rbi/knockapi/models/page_info.rbi +22 -11
  234. data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
  235. data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
  236. data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
  237. data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
  238. data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
  239. data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
  240. data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
  241. data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
  242. data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
  243. data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
  244. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
  245. data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
  246. data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
  247. data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
  248. data/rbi/knockapi/models/recipient.rbi +5 -2
  249. data/rbi/knockapi/models/recipient_reference.rbi +22 -5
  250. data/rbi/knockapi/models/recipient_request.rbi +11 -4
  251. data/rbi/knockapi/models/recipients/channel_data.rbi +113 -55
  252. data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
  253. data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
  254. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
  255. data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
  256. data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
  257. data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
  258. data/rbi/knockapi/models/recipients/preference_set.rbi +159 -100
  259. data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
  260. data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
  261. data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
  262. data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
  263. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
  264. data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
  265. data/rbi/knockapi/models/schedule.rbi +32 -27
  266. data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
  267. data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
  268. data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
  269. data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
  270. data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
  271. data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
  272. data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
  273. data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
  274. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
  275. data/rbi/knockapi/models/tenant.rbi +71 -45
  276. data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
  277. data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
  278. data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
  279. data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
  280. data/rbi/knockapi/models/tenant_request.rbi +132 -57
  281. data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
  282. data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
  283. data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
  284. data/rbi/knockapi/models/user.rbi +32 -28
  285. data/rbi/knockapi/models/user_delete_params.rbi +13 -5
  286. data/rbi/knockapi/models/user_delete_response.rbi +7 -0
  287. data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
  288. data/rbi/knockapi/models/user_get_params.rbi +13 -5
  289. data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
  290. data/rbi/knockapi/models/user_list_messages_params.rbi +183 -59
  291. data/rbi/knockapi/models/user_list_params.rbi +43 -22
  292. data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
  293. data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
  294. data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
  295. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
  296. data/rbi/knockapi/models/user_merge_params.rbi +17 -6
  297. data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
  298. data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
  299. data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
  300. data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
  301. data/rbi/knockapi/models/user_update_params.rbi +13 -5
  302. data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
  303. data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
  304. data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
  305. data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
  306. data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
  307. data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
  308. data/rbi/knockapi/models/users/feed_list_items_response.rbi +199 -108
  309. data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
  310. data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
  311. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
  312. data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
  313. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
  314. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
  315. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
  316. data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
  317. data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
  318. data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
  319. data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
  320. data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
  321. data/rbi/knockapi/models.rbi +179 -0
  322. data/rbi/knockapi/request_options.rbi +18 -7
  323. data/rbi/knockapi/resources/audiences.rbi +22 -14
  324. data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
  325. data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
  326. data/rbi/knockapi/resources/channels.rbi +2 -1
  327. data/rbi/knockapi/resources/integrations/census.rbi +8 -4
  328. data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
  329. data/rbi/knockapi/resources/integrations.rbi +2 -1
  330. data/rbi/knockapi/resources/messages/batch.rbi +58 -26
  331. data/rbi/knockapi/resources/messages.rbi +102 -43
  332. data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
  333. data/rbi/knockapi/resources/objects.rbi +177 -107
  334. data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
  335. data/rbi/knockapi/resources/providers/slack.rbi +28 -11
  336. data/rbi/knockapi/resources/providers.rbi +2 -1
  337. data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
  338. data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
  339. data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
  340. data/rbi/knockapi/resources/recipients.rbi +2 -1
  341. data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
  342. data/rbi/knockapi/resources/schedules.rbi +44 -33
  343. data/rbi/knockapi/resources/shared.rbi +2 -1
  344. data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
  345. data/rbi/knockapi/resources/tenants.rbi +51 -20
  346. data/rbi/knockapi/resources/users/bulk.rbi +21 -14
  347. data/rbi/knockapi/resources/users/feeds.rbi +20 -9
  348. data/rbi/knockapi/resources/users/guides.rbi +23 -16
  349. data/rbi/knockapi/resources/users.rbi +160 -91
  350. data/rbi/knockapi/resources/workflows.rbi +38 -29
  351. data/sig/knockapi/internal/entries_cursor.rbs +0 -2
  352. data/sig/knockapi/internal/items_cursor.rbs +0 -2
  353. data/sig/knockapi/internal/transport/base_client.rbs +16 -1
  354. data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
  355. data/sig/knockapi/internal/type/array_of.rbs +3 -0
  356. data/sig/knockapi/internal/type/base_model.rbs +13 -5
  357. data/sig/knockapi/internal/type/base_page.rbs +1 -1
  358. data/sig/knockapi/internal/type/boolean.rbs +3 -0
  359. data/sig/knockapi/internal/type/converter.rbs +2 -0
  360. data/sig/knockapi/internal/type/enum.rbs +3 -0
  361. data/sig/knockapi/internal/type/file_input.rbs +2 -0
  362. data/sig/knockapi/internal/type/hash_of.rbs +3 -0
  363. data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
  364. data/sig/knockapi/internal/type/union.rbs +3 -0
  365. data/sig/knockapi/internal/type/unknown.rbs +3 -0
  366. data/sig/knockapi/internal/util.rbs +27 -0
  367. data/sig/knockapi/internal.rbs +4 -0
  368. data/sig/knockapi/models/activity.rbs +0 -2
  369. data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
  370. data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
  371. data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
  372. data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
  373. data/sig/knockapi/models/audience_member.rbs +3 -5
  374. data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
  375. data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
  376. data/sig/knockapi/models/bulk_operation.rbs +9 -13
  377. data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
  378. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
  379. data/sig/knockapi/models/condition.rbs +4 -6
  380. data/sig/knockapi/models/identify_user_request.rbs +0 -2
  381. data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
  382. data/sig/knockapi/models/inline_object_request.rbs +0 -2
  383. data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
  384. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
  385. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
  386. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
  387. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
  388. data/sig/knockapi/models/message.rbs +15 -23
  389. data/sig/knockapi/models/message_archive_params.rbs +0 -2
  390. data/sig/knockapi/models/message_delivery_log.rbs +24 -30
  391. data/sig/knockapi/models/message_event.rbs +4 -6
  392. data/sig/knockapi/models/message_get_content_params.rbs +0 -2
  393. data/sig/knockapi/models/message_get_content_response.rbs +2 -24
  394. data/sig/knockapi/models/message_get_params.rbs +0 -2
  395. data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
  396. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
  397. data/sig/knockapi/models/message_list_events_params.rbs +0 -2
  398. data/sig/knockapi/models/message_list_params.rbs +30 -24
  399. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
  400. data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
  401. data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
  402. data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
  403. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
  404. data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
  405. data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
  406. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  407. data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
  408. data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
  409. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
  410. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
  411. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
  412. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  413. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
  414. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  415. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
  416. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  417. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
  418. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  419. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
  420. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  421. data/sig/knockapi/models/object.rbs +8 -4
  422. data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
  423. data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
  424. data/sig/knockapi/models/object_delete_params.rbs +0 -2
  425. data/sig/knockapi/models/object_delete_response.rbs +5 -0
  426. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
  427. data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
  428. data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
  429. data/sig/knockapi/models/object_get_params.rbs +0 -2
  430. data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
  431. data/sig/knockapi/models/object_list_messages_params.rbs +30 -24
  432. data/sig/knockapi/models/object_list_params.rbs +6 -8
  433. data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
  434. data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
  435. data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
  436. data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
  437. data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
  438. data/sig/knockapi/models/object_set_params.rbs +0 -2
  439. data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
  440. data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
  441. data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
  442. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
  443. data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
  444. data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
  445. data/sig/knockapi/models/page_info.rbs +0 -2
  446. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
  447. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
  448. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
  449. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
  450. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
  451. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
  452. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
  453. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
  454. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
  455. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
  456. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
  457. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
  458. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
  459. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
  460. data/sig/knockapi/models/recipient.rbs +2 -2
  461. data/sig/knockapi/models/recipient_reference.rbs +2 -4
  462. data/sig/knockapi/models/recipient_request.rbs +3 -3
  463. data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
  464. data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
  465. data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
  466. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
  467. data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
  468. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
  469. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
  470. data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
  471. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
  472. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
  473. data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
  474. data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
  475. data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
  476. data/sig/knockapi/models/recipients/subscription.rbs +3 -5
  477. data/sig/knockapi/models/schedule.rbs +3 -5
  478. data/sig/knockapi/models/schedule_create_params.rbs +3 -5
  479. data/sig/knockapi/models/schedule_create_response.rbs +1 -1
  480. data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
  481. data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
  482. data/sig/knockapi/models/schedule_list_params.rbs +0 -2
  483. data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
  484. data/sig/knockapi/models/schedule_update_params.rbs +5 -7
  485. data/sig/knockapi/models/schedule_update_response.rbs +1 -1
  486. data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
  487. data/sig/knockapi/models/tenant.rbs +9 -15
  488. data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
  489. data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
  490. data/sig/knockapi/models/tenant_get_params.rbs +0 -2
  491. data/sig/knockapi/models/tenant_list_params.rbs +0 -2
  492. data/sig/knockapi/models/tenant_request.rbs +13 -19
  493. data/sig/knockapi/models/tenant_set_params.rbs +13 -19
  494. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
  495. data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
  496. data/sig/knockapi/models/user.rbs +0 -2
  497. data/sig/knockapi/models/user_delete_params.rbs +0 -2
  498. data/sig/knockapi/models/user_delete_response.rbs +5 -0
  499. data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
  500. data/sig/knockapi/models/user_get_params.rbs +0 -2
  501. data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
  502. data/sig/knockapi/models/user_list_messages_params.rbs +30 -24
  503. data/sig/knockapi/models/user_list_params.rbs +6 -8
  504. data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
  505. data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
  506. data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
  507. data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
  508. data/sig/knockapi/models/user_merge_params.rbs +0 -2
  509. data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
  510. data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
  511. data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
  512. data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
  513. data/sig/knockapi/models/user_update_params.rbs +0 -2
  514. data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
  515. data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
  516. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
  517. data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
  518. data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
  519. data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
  520. data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
  521. data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
  522. data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
  523. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
  524. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
  525. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
  526. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
  527. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
  528. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
  529. data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
  530. data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
  531. data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
  532. data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
  533. data/sig/knockapi/models.rbs +173 -0
  534. data/sig/knockapi/request_options.rbs +1 -1
  535. data/sig/knockapi/resources/audiences.rbs +2 -2
  536. data/sig/knockapi/resources/bulk_operations.rbs +1 -1
  537. data/sig/knockapi/resources/channels/bulk.rbs +1 -1
  538. data/sig/knockapi/resources/messages.rbs +15 -17
  539. data/sig/knockapi/resources/objects/bulk.rbs +5 -5
  540. data/sig/knockapi/resources/objects.rbs +19 -19
  541. data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
  542. data/sig/knockapi/resources/providers/slack.rbs +1 -1
  543. data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
  544. data/sig/knockapi/resources/schedules.rbs +3 -3
  545. data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
  546. data/sig/knockapi/resources/tenants.rbs +4 -4
  547. data/sig/knockapi/resources/users/bulk.rbs +5 -5
  548. data/sig/knockapi/resources/users.rbs +19 -19
  549. metadata +29 -8
  550. data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
  551. data/lib/knockapi/resources/messages/activities.rb +0 -47
  552. data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
  553. data/rbi/knockapi/resources/messages/activities.rbi +0 -38
  554. data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
  555. data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -6,14 +6,25 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Knockapi::ObjectGetChannelDataParams,
13
+ Knockapi::Internal::AnyHash
14
+ )
15
+ end
16
+
9
17
  sig do
10
- params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
11
- .returns(T.attached_class)
18
+ params(request_options: Knockapi::RequestOptions::OrHash).returns(
19
+ T.attached_class
20
+ )
21
+ end
22
+ def self.new(request_options: {})
12
23
  end
13
- def self.new(request_options: {}); end
14
24
 
15
- sig { override.returns({request_options: Knockapi::RequestOptions}) }
16
- def to_hash; end
25
+ sig { override.returns({ request_options: Knockapi::RequestOptions }) }
26
+ def to_hash
27
+ end
17
28
  end
18
29
  end
19
30
  end
@@ -6,14 +6,22 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(Knockapi::ObjectGetParams, Knockapi::Internal::AnyHash)
12
+ end
13
+
9
14
  sig do
10
- params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
11
- .returns(T.attached_class)
15
+ params(request_options: Knockapi::RequestOptions::OrHash).returns(
16
+ T.attached_class
17
+ )
18
+ end
19
+ def self.new(request_options: {})
12
20
  end
13
- def self.new(request_options: {}); end
14
21
 
15
- sig { override.returns({request_options: Knockapi::RequestOptions}) }
16
- def to_hash; end
22
+ sig { override.returns({ request_options: Knockapi::RequestOptions }) }
23
+ def to_hash
24
+ end
17
25
  end
18
26
  end
19
27
  end
@@ -6,14 +6,25 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Knockapi::ObjectGetPreferencesParams,
13
+ Knockapi::Internal::AnyHash
14
+ )
15
+ end
16
+
9
17
  sig do
10
- params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
11
- .returns(T.attached_class)
18
+ params(request_options: Knockapi::RequestOptions::OrHash).returns(
19
+ T.attached_class
20
+ )
21
+ end
22
+ def self.new(request_options: {})
12
23
  end
13
- def self.new(request_options: {}); end
14
24
 
15
- sig { override.returns({request_options: Knockapi::RequestOptions}) }
16
- def to_hash; end
25
+ sig { override.returns({ request_options: Knockapi::RequestOptions }) }
26
+ def to_hash
27
+ end
17
28
  end
18
29
  end
19
30
  end
@@ -6,6 +6,11 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(Knockapi::ObjectListMessagesParams, Knockapi::Internal::AnyHash)
12
+ end
13
+
9
14
  # The cursor to fetch entries after.
10
15
  sig { returns(T.nilable(String)) }
11
16
  attr_reader :after
@@ -28,25 +33,34 @@ module Knockapi
28
33
  attr_writer :channel_id
29
34
 
30
35
  # Limits the results to messages with the given engagement status.
31
- sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol])) }
36
+ sig do
37
+ returns(
38
+ T.nilable(
39
+ T::Array[
40
+ Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
41
+ ]
42
+ )
43
+ )
44
+ end
32
45
  attr_reader :engagement_status
33
46
 
34
47
  sig do
35
48
  params(
36
- engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol]
37
- )
38
- .void
49
+ engagement_status:
50
+ T::Array[
51
+ Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
52
+ ]
53
+ ).void
39
54
  end
40
55
  attr_writer :engagement_status
41
56
 
42
- sig { returns(T.nilable(Knockapi::Models::ObjectListMessagesParams::InsertedAt)) }
57
+ sig { returns(T.nilable(Knockapi::ObjectListMessagesParams::InsertedAt)) }
43
58
  attr_reader :inserted_at
44
59
 
45
60
  sig do
46
61
  params(
47
- inserted_at: T.any(Knockapi::Models::ObjectListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash)
48
- )
49
- .void
62
+ inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt::OrHash
63
+ ).void
50
64
  end
51
65
  attr_writer :inserted_at
52
66
 
@@ -73,10 +87,20 @@ module Knockapi
73
87
  attr_writer :source
74
88
 
75
89
  # Limits the results to messages with the given delivery status.
76
- sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol])) }
90
+ sig do
91
+ returns(
92
+ T.nilable(
93
+ T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol]
94
+ )
95
+ )
96
+ end
77
97
  attr_reader :status
78
98
 
79
- sig { params(status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol]).void }
99
+ sig do
100
+ params(
101
+ status: T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol]
102
+ ).void
103
+ end
80
104
  attr_writer :status
81
105
 
82
106
  # Limits the results to items with the corresponding tenant.
@@ -122,20 +146,23 @@ module Knockapi
122
146
  after: String,
123
147
  before: String,
124
148
  channel_id: String,
125
- engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol],
126
- inserted_at: T.any(Knockapi::Models::ObjectListMessagesParams::InsertedAt, Knockapi::Internal::AnyHash),
149
+ engagement_status:
150
+ T::Array[
151
+ Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
152
+ ],
153
+ inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt::OrHash,
127
154
  message_ids: T::Array[String],
128
155
  page_size: Integer,
129
156
  source: String,
130
- status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol],
157
+ status:
158
+ T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol],
131
159
  tenant: String,
132
160
  trigger_data: String,
133
161
  workflow_categories: T::Array[String],
134
162
  workflow_recipient_run_id: String,
135
163
  workflow_run_id: String,
136
- request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
137
- )
138
- .returns(T.attached_class)
164
+ request_options: Knockapi::RequestOptions::OrHash
165
+ ).returns(T.attached_class)
139
166
  end
140
167
  def self.new(
141
168
  # The cursor to fetch entries after.
@@ -170,51 +197,107 @@ module Knockapi
170
197
  # returned by the workflow trigger request.
171
198
  workflow_run_id: nil,
172
199
  request_options: {}
173
- ); end
200
+ )
201
+ end
202
+
174
203
  sig do
175
- override
176
- .returns(
177
- {
178
- after: String,
179
- before: String,
180
- channel_id: String,
181
- engagement_status: T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::OrSymbol],
182
- inserted_at: Knockapi::Models::ObjectListMessagesParams::InsertedAt,
183
- message_ids: T::Array[String],
184
- page_size: Integer,
185
- source: String,
186
- status: T::Array[Knockapi::Models::ObjectListMessagesParams::Status::OrSymbol],
187
- tenant: String,
188
- trigger_data: String,
189
- workflow_categories: T::Array[String],
190
- workflow_recipient_run_id: String,
191
- workflow_run_id: String,
192
- request_options: Knockapi::RequestOptions
193
- }
194
- )
204
+ override.returns(
205
+ {
206
+ after: String,
207
+ before: String,
208
+ channel_id: String,
209
+ engagement_status:
210
+ T::Array[
211
+ Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
212
+ ],
213
+ inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt,
214
+ message_ids: T::Array[String],
215
+ page_size: Integer,
216
+ source: String,
217
+ status:
218
+ T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol],
219
+ tenant: String,
220
+ trigger_data: String,
221
+ workflow_categories: T::Array[String],
222
+ workflow_recipient_run_id: String,
223
+ workflow_run_id: String,
224
+ request_options: Knockapi::RequestOptions
225
+ }
226
+ )
227
+ end
228
+ def to_hash
195
229
  end
196
- def to_hash; end
197
230
 
198
231
  module EngagementStatus
199
232
  extend Knockapi::Internal::Type::Enum
200
233
 
201
234
  TaggedSymbol =
202
- T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus) }
235
+ T.type_alias do
236
+ T.all(Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus)
237
+ end
203
238
  OrSymbol = T.type_alias { T.any(Symbol, String) }
204
239
 
205
- SEEN = T.let(:seen, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
206
- READ = T.let(:read, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
207
- INTERACTED =
208
- T.let(:interacted, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
240
+ SEEN =
241
+ T.let(
242
+ :seen,
243
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
244
+ )
245
+ UNSEEN =
246
+ T.let(
247
+ :unseen,
248
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
249
+ )
250
+ READ =
251
+ T.let(
252
+ :read,
253
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
254
+ )
255
+ UNREAD =
256
+ T.let(
257
+ :unread,
258
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
259
+ )
260
+ ARCHIVED =
261
+ T.let(
262
+ :archived,
263
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
264
+ )
265
+ UNARCHIVED =
266
+ T.let(
267
+ :unarchived,
268
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
269
+ )
209
270
  LINK_CLICKED =
210
- T.let(:link_clicked, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
211
- ARCHIVED = T.let(:archived, Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol)
271
+ T.let(
272
+ :link_clicked,
273
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
274
+ )
275
+ INTERACTED =
276
+ T.let(
277
+ :interacted,
278
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
279
+ )
212
280
 
213
- sig { override.returns(T::Array[Knockapi::Models::ObjectListMessagesParams::EngagementStatus::TaggedSymbol]) }
214
- def self.values; end
281
+ sig do
282
+ override.returns(
283
+ T::Array[
284
+ Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
285
+ ]
286
+ )
287
+ end
288
+ def self.values
289
+ end
215
290
  end
216
291
 
217
292
  class InsertedAt < Knockapi::Internal::Type::BaseModel
293
+ OrHash =
294
+ T.type_alias do
295
+ T.any(
296
+ Knockapi::ObjectListMessagesParams::InsertedAt,
297
+ Knockapi::Internal::AnyHash
298
+ )
299
+ end
300
+
218
301
  # Limits the results to messages inserted after the given date.
219
302
  sig { returns(T.nilable(String)) }
220
303
  attr_reader :gt
@@ -243,7 +326,11 @@ module Knockapi
243
326
  sig { params(lte: String).void }
244
327
  attr_writer :lte
245
328
 
246
- sig { params(gt: String, gte: String, lt: String, lte: String).returns(T.attached_class) }
329
+ sig do
330
+ params(gt: String, gte: String, lt: String, lte: String).returns(
331
+ T.attached_class
332
+ )
333
+ end
247
334
  def self.new(
248
335
  # Limits the results to messages inserted after the given date.
249
336
  gt: nil,
@@ -253,28 +340,65 @@ module Knockapi
253
340
  lt: nil,
254
341
  # Limits the results to messages inserted before or on the given date.
255
342
  lte: nil
256
- ); end
257
- sig { override.returns({gt: String, gte: String, lt: String, lte: String}) }
258
- def to_hash; end
343
+ )
344
+ end
345
+
346
+ sig do
347
+ override.returns({ gt: String, gte: String, lt: String, lte: String })
348
+ end
349
+ def to_hash
350
+ end
259
351
  end
260
352
 
261
353
  module Status
262
354
  extend Knockapi::Internal::Type::Enum
263
355
 
264
- TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListMessagesParams::Status) }
356
+ TaggedSymbol =
357
+ T.type_alias do
358
+ T.all(Symbol, Knockapi::ObjectListMessagesParams::Status)
359
+ end
265
360
  OrSymbol = T.type_alias { T.any(Symbol, String) }
266
361
 
267
- QUEUED = T.let(:queued, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
268
- SENT = T.let(:sent, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
269
- DELIVERED = T.let(:delivered, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
362
+ QUEUED =
363
+ T.let(
364
+ :queued,
365
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
366
+ )
367
+ SENT =
368
+ T.let(:sent, Knockapi::ObjectListMessagesParams::Status::TaggedSymbol)
369
+ DELIVERED =
370
+ T.let(
371
+ :delivered,
372
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
373
+ )
270
374
  DELIVERY_ATTEMPTED =
271
- T.let(:delivery_attempted, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
272
- UNDELIVERED = T.let(:undelivered, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
273
- NOT_SENT = T.let(:not_sent, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
274
- BOUNCED = T.let(:bounced, Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol)
375
+ T.let(
376
+ :delivery_attempted,
377
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
378
+ )
379
+ UNDELIVERED =
380
+ T.let(
381
+ :undelivered,
382
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
383
+ )
384
+ NOT_SENT =
385
+ T.let(
386
+ :not_sent,
387
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
388
+ )
389
+ BOUNCED =
390
+ T.let(
391
+ :bounced,
392
+ Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
393
+ )
275
394
 
276
- sig { override.returns(T::Array[Knockapi::Models::ObjectListMessagesParams::Status::TaggedSymbol]) }
277
- def self.values; end
395
+ sig do
396
+ override.returns(
397
+ T::Array[Knockapi::ObjectListMessagesParams::Status::TaggedSymbol]
398
+ )
399
+ end
400
+ def self.values
401
+ end
278
402
  end
279
403
  end
280
404
  end
@@ -6,6 +6,11 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(Knockapi::ObjectListParams, Knockapi::Internal::AnyHash)
12
+ end
13
+
9
14
  # The cursor to fetch entries after.
10
15
  sig { returns(T.nilable(String)) }
11
16
  attr_reader :after
@@ -21,10 +26,18 @@ module Knockapi
21
26
  attr_writer :before
22
27
 
23
28
  # Includes preferences of the objects in the response.
24
- sig { returns(T.nilable(T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol])) }
29
+ sig do
30
+ returns(
31
+ T.nilable(T::Array[Knockapi::ObjectListParams::Include::OrSymbol])
32
+ )
33
+ end
25
34
  attr_reader :include
26
35
 
27
- sig { params(include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol]).void }
36
+ sig do
37
+ params(
38
+ include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol]
39
+ ).void
40
+ end
28
41
  attr_writer :include
29
42
 
30
43
  # The number of items per page.
@@ -38,11 +51,10 @@ module Knockapi
38
51
  params(
39
52
  after: String,
40
53
  before: String,
41
- include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol],
54
+ include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol],
42
55
  page_size: Integer,
43
- request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
44
- )
45
- .returns(T.attached_class)
56
+ request_options: Knockapi::RequestOptions::OrHash
57
+ ).returns(T.attached_class)
46
58
  end
47
59
  def self.new(
48
60
  # The cursor to fetch entries after.
@@ -54,31 +66,40 @@ module Knockapi
54
66
  # The number of items per page.
55
67
  page_size: nil,
56
68
  request_options: {}
57
- ); end
69
+ )
70
+ end
71
+
58
72
  sig do
59
- override
60
- .returns(
61
- {
62
- after: String,
63
- before: String,
64
- include: T::Array[Knockapi::Models::ObjectListParams::Include::OrSymbol],
65
- page_size: Integer,
66
- request_options: Knockapi::RequestOptions
67
- }
68
- )
73
+ override.returns(
74
+ {
75
+ after: String,
76
+ before: String,
77
+ include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol],
78
+ page_size: Integer,
79
+ request_options: Knockapi::RequestOptions
80
+ }
81
+ )
82
+ end
83
+ def to_hash
69
84
  end
70
- def to_hash; end
71
85
 
72
86
  module Include
73
87
  extend Knockapi::Internal::Type::Enum
74
88
 
75
- TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::ObjectListParams::Include) }
89
+ TaggedSymbol =
90
+ T.type_alias { T.all(Symbol, Knockapi::ObjectListParams::Include) }
76
91
  OrSymbol = T.type_alias { T.any(Symbol, String) }
77
92
 
78
- PREFERENCES = T.let(:preferences, Knockapi::Models::ObjectListParams::Include::TaggedSymbol)
93
+ PREFERENCES =
94
+ T.let(:preferences, Knockapi::ObjectListParams::Include::TaggedSymbol)
79
95
 
80
- sig { override.returns(T::Array[Knockapi::Models::ObjectListParams::Include::TaggedSymbol]) }
81
- def self.values; end
96
+ sig do
97
+ override.returns(
98
+ T::Array[Knockapi::ObjectListParams::Include::TaggedSymbol]
99
+ )
100
+ end
101
+ def self.values
102
+ end
82
103
  end
83
104
  end
84
105
  end
@@ -6,14 +6,25 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Knockapi::ObjectListPreferencesParams,
13
+ Knockapi::Internal::AnyHash
14
+ )
15
+ end
16
+
9
17
  sig do
10
- params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
11
- .returns(T.attached_class)
18
+ params(request_options: Knockapi::RequestOptions::OrHash).returns(
19
+ T.attached_class
20
+ )
21
+ end
22
+ def self.new(request_options: {})
12
23
  end
13
- def self.new(request_options: {}); end
14
24
 
15
- sig { override.returns({request_options: Knockapi::RequestOptions}) }
16
- def to_hash; end
25
+ sig { override.returns({ request_options: Knockapi::RequestOptions }) }
26
+ def to_hash
27
+ end
17
28
  end
18
29
  end
19
30
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  ObjectListPreferencesResponse =
6
6
  T.let(
7
- Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::PreferenceSet],
7
+ Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PreferenceSet],
8
8
  Knockapi::Internal::Type::Converter
9
9
  )
10
10
  end
@@ -6,6 +6,14 @@ module Knockapi
6
6
  extend Knockapi::Internal::Type::RequestParameters::Converter
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Knockapi::ObjectListSchedulesParams,
13
+ Knockapi::Internal::AnyHash
14
+ )
15
+ end
16
+
9
17
  # The cursor to fetch entries after.
10
18
  sig { returns(T.nilable(String)) }
11
19
  attr_reader :after
@@ -48,9 +56,8 @@ module Knockapi
48
56
  page_size: Integer,
49
57
  tenant: String,
50
58
  workflow: String,
51
- request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
52
- )
53
- .returns(T.attached_class)
59
+ request_options: Knockapi::RequestOptions::OrHash
60
+ ).returns(T.attached_class)
54
61
  end
55
62
  def self.new(
56
63
  # The cursor to fetch entries after.
@@ -64,21 +71,23 @@ module Knockapi
64
71
  # Filter schedules by workflow id.
65
72
  workflow: nil,
66
73
  request_options: {}
67
- ); end
74
+ )
75
+ end
76
+
68
77
  sig do
69
- override
70
- .returns(
71
- {
72
- after: String,
73
- before: String,
74
- page_size: Integer,
75
- tenant: String,
76
- workflow: String,
77
- request_options: Knockapi::RequestOptions
78
- }
79
- )
78
+ override.returns(
79
+ {
80
+ after: String,
81
+ before: String,
82
+ page_size: Integer,
83
+ tenant: String,
84
+ workflow: String,
85
+ request_options: Knockapi::RequestOptions
86
+ }
87
+ )
88
+ end
89
+ def to_hash
80
90
  end
81
- def to_hash; end
82
91
  end
83
92
  end
84
93
  end