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
@@ -22,17 +22,17 @@ module Knockapi
22
22
  #
23
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
24
24
  #
25
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Tenant>]
25
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Tenant>]
26
26
  #
27
27
  # @see Knockapi::Models::TenantListParams
28
28
  def list(params = {})
29
- parsed, options = Knockapi::Models::TenantListParams.dump_request(params)
29
+ parsed, options = Knockapi::TenantListParams.dump_request(params)
30
30
  @client.request(
31
31
  method: :get,
32
32
  path: "v1/tenants",
33
33
  query: parsed,
34
34
  page: Knockapi::Internal::EntriesCursor,
35
- model: Knockapi::Models::Tenant,
35
+ model: Knockapi::Tenant,
36
36
  options: options
37
37
  )
38
38
  end
@@ -65,14 +65,14 @@ module Knockapi
65
65
  #
66
66
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
67
67
  #
68
- # @return [Knockapi::Models::Tenant]
68
+ # @return [Knockapi::Tenant]
69
69
  #
70
70
  # @see Knockapi::Models::TenantGetParams
71
71
  def get(id, params = {})
72
72
  @client.request(
73
73
  method: :get,
74
74
  path: ["v1/tenants/%1$s", id],
75
- model: Knockapi::Models::Tenant,
75
+ model: Knockapi::Tenant,
76
76
  options: params[:request_options]
77
77
  )
78
78
  end
@@ -84,24 +84,24 @@ module Knockapi
84
84
  #
85
85
  # @param id [String] The unique identifier for the tenant.
86
86
  #
87
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
87
+ # @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.
88
88
  #
89
- # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
89
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
90
90
  #
91
- # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
91
+ # @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
92
92
  #
93
93
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
94
94
  #
95
- # @return [Knockapi::Models::Tenant]
95
+ # @return [Knockapi::Tenant]
96
96
  #
97
97
  # @see Knockapi::Models::TenantSetParams
98
98
  def set(id, params = {})
99
- parsed, options = Knockapi::Models::TenantSetParams.dump_request(params)
99
+ parsed, options = Knockapi::TenantSetParams.dump_request(params)
100
100
  @client.request(
101
101
  method: :put,
102
102
  path: ["v1/tenants/%1$s", id],
103
103
  body: parsed,
104
- model: Knockapi::Models::Tenant,
104
+ model: Knockapi::Tenant,
105
105
  options: options
106
106
  )
107
107
  end
@@ -13,16 +13,16 @@ module Knockapi
13
13
  #
14
14
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
15
15
  #
16
- # @return [Knockapi::Models::BulkOperation]
16
+ # @return [Knockapi::BulkOperation]
17
17
  #
18
18
  # @see Knockapi::Models::Users::BulkDeleteParams
19
19
  def delete(params)
20
- parsed, options = Knockapi::Models::Users::BulkDeleteParams.dump_request(params)
20
+ parsed, options = Knockapi::Users::BulkDeleteParams.dump_request(params)
21
21
  @client.request(
22
22
  method: :post,
23
23
  path: "v1/users/bulk/delete",
24
24
  body: parsed,
25
- model: Knockapi::Models::BulkOperation,
25
+ model: Knockapi::BulkOperation,
26
26
  options: options
27
27
  )
28
28
  end
@@ -33,20 +33,20 @@ module Knockapi
33
33
  #
34
34
  # @overload identify(users:, request_options: {})
35
35
  #
36
- # @param users [Array<Knockapi::Models::InlineIdentifyUserRequest>] A list of users.
36
+ # @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
37
37
  #
38
38
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
39
39
  #
40
- # @return [Knockapi::Models::BulkOperation]
40
+ # @return [Knockapi::BulkOperation]
41
41
  #
42
42
  # @see Knockapi::Models::Users::BulkIdentifyParams
43
43
  def identify(params)
44
- parsed, options = Knockapi::Models::Users::BulkIdentifyParams.dump_request(params)
44
+ parsed, options = Knockapi::Users::BulkIdentifyParams.dump_request(params)
45
45
  @client.request(
46
46
  method: :post,
47
47
  path: "v1/users/bulk/identify",
48
48
  body: parsed,
49
- model: Knockapi::Models::BulkOperation,
49
+ model: Knockapi::BulkOperation,
50
50
  options: options
51
51
  )
52
52
  end
@@ -57,22 +57,22 @@ module Knockapi
57
57
  #
58
58
  # @overload set_preferences(preferences:, user_ids:, request_options: {})
59
59
  #
60
- # @param preferences [Knockapi::Models::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
60
+ # @param preferences [Knockapi::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
61
61
  #
62
62
  # @param user_ids [Array<String>] A list of user IDs.
63
63
  #
64
64
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
65
65
  #
66
- # @return [Knockapi::Models::BulkOperation]
66
+ # @return [Knockapi::BulkOperation]
67
67
  #
68
68
  # @see Knockapi::Models::Users::BulkSetPreferencesParams
69
69
  def set_preferences(params)
70
- parsed, options = Knockapi::Models::Users::BulkSetPreferencesParams.dump_request(params)
70
+ parsed, options = Knockapi::Users::BulkSetPreferencesParams.dump_request(params)
71
71
  @client.request(
72
72
  method: :post,
73
73
  path: "v1/users/bulk/preferences",
74
74
  body: parsed,
75
- model: Knockapi::Models::BulkOperation,
75
+ model: Knockapi::BulkOperation,
76
76
  options: options
77
77
  )
78
78
  end
@@ -37,7 +37,7 @@ module Knockapi
37
37
  #
38
38
  # @param after [String] The cursor to fetch entries after.
39
39
  #
40
- # @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
40
+ # @param archived [Symbol, Knockapi::Users::FeedListItemsParams::Archived] The archived status of the feed items.
41
41
  #
42
42
  # @param before [String] The cursor to fetch entries before.
43
43
  #
@@ -47,7 +47,7 @@ module Knockapi
47
47
  #
48
48
  # @param source [String] The source of the feed items.
49
49
  #
50
- # @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
50
+ # @param status [Symbol, Knockapi::Users::FeedListItemsParams::Status] The status of the feed items.
51
51
  #
52
52
  # @param tenant [String] The tenant associated with the feed items.
53
53
  #
@@ -61,7 +61,7 @@ module Knockapi
61
61
  #
62
62
  # @see Knockapi::Models::Users::FeedListItemsParams
63
63
  def list_items(user_id, id, params = {})
64
- parsed, options = Knockapi::Models::Users::FeedListItemsParams.dump_request(params)
64
+ parsed, options = Knockapi::Users::FeedListItemsParams.dump_request(params)
65
65
  @client.request(
66
66
  method: :get,
67
67
  path: ["v1/users/%1$s/feeds/%2$s", user_id, id],
@@ -24,7 +24,7 @@ module Knockapi
24
24
  #
25
25
  # @see Knockapi::Models::Users::GuideGetChannelParams
26
26
  def get_channel(user_id, channel_id, params = {})
27
- parsed, options = Knockapi::Models::Users::GuideGetChannelParams.dump_request(params)
27
+ parsed, options = Knockapi::Users::GuideGetChannelParams.dump_request(params)
28
28
  @client.request(
29
29
  method: :get,
30
30
  path: ["v1/users/%1$s/guides/%2$s", user_id, channel_id],
@@ -67,7 +67,7 @@ module Knockapi
67
67
  #
68
68
  # @see Knockapi::Models::Users::GuideMarkMessageAsArchivedParams
69
69
  def mark_message_as_archived(user_id, message_id, params)
70
- parsed, options = Knockapi::Models::Users::GuideMarkMessageAsArchivedParams.dump_request(params)
70
+ parsed, options = Knockapi::Users::GuideMarkMessageAsArchivedParams.dump_request(params)
71
71
  @client.request(
72
72
  method: :put,
73
73
  path: ["v1/users/%1$s/guides/messages/%2$s/archived", user_id, message_id],
@@ -110,7 +110,7 @@ module Knockapi
110
110
  #
111
111
  # @see Knockapi::Models::Users::GuideMarkMessageAsInteractedParams
112
112
  def mark_message_as_interacted(user_id, message_id, params)
113
- parsed, options = Knockapi::Models::Users::GuideMarkMessageAsInteractedParams.dump_request(params)
113
+ parsed, options = Knockapi::Users::GuideMarkMessageAsInteractedParams.dump_request(params)
114
114
  @client.request(
115
115
  method: :put,
116
116
  path: ["v1/users/%1$s/guides/messages/%2$s/interacted", user_id, message_id],
@@ -153,7 +153,7 @@ module Knockapi
153
153
  #
154
154
  # @see Knockapi::Models::Users::GuideMarkMessageAsSeenParams
155
155
  def mark_message_as_seen(user_id, message_id, params)
156
- parsed, options = Knockapi::Models::Users::GuideMarkMessageAsSeenParams.dump_request(params)
156
+ parsed, options = Knockapi::Users::GuideMarkMessageAsSeenParams.dump_request(params)
157
157
  @client.request(
158
158
  method: :put,
159
159
  path: ["v1/users/%1$s/guides/messages/%2$s/seen", user_id, message_id],
@@ -25,37 +25,34 @@ module Knockapi
25
25
  #
26
26
  # @param avatar [String, nil] URL to the user's avatar image.
27
27
  #
28
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
28
+ # @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.
29
29
  #
30
30
  # @param created_at [Time, nil] The creation date of the user from your system.
31
31
  #
32
32
  # @param email [String, nil] The primary email address for the user.
33
33
  #
34
34
  # @param locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
35
- # ...
36
35
  #
37
36
  # @param name [String, nil] Display name of the user.
38
37
  #
39
- # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
40
- # ...
38
+ # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
41
39
  #
42
- # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
40
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
43
41
  #
44
- # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
45
- # ...
42
+ # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
46
43
  #
47
44
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
48
45
  #
49
- # @return [Knockapi::Models::User]
46
+ # @return [Knockapi::User]
50
47
  #
51
48
  # @see Knockapi::Models::UserUpdateParams
52
49
  def update(user_id, params = {})
53
- parsed, options = Knockapi::Models::UserUpdateParams.dump_request(params)
50
+ parsed, options = Knockapi::UserUpdateParams.dump_request(params)
54
51
  @client.request(
55
52
  method: :put,
56
53
  path: ["v1/users/%1$s", user_id],
57
54
  body: parsed,
58
- model: Knockapi::Models::User,
55
+ model: Knockapi::User,
59
56
  options: options
60
57
  )
61
58
  end
@@ -69,23 +66,23 @@ module Knockapi
69
66
  #
70
67
  # @param before [String] The cursor to fetch entries before.
71
68
  #
72
- # @param include [Array<Symbol, Knockapi::Models::UserListParams::Include>] Associated resources to include in the response.
69
+ # @param include [Array<Symbol, Knockapi::UserListParams::Include>] Associated resources to include in the response.
73
70
  #
74
71
  # @param page_size [Integer] The number of items per page.
75
72
  #
76
73
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
77
74
  #
78
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::User>]
75
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::User>]
79
76
  #
80
77
  # @see Knockapi::Models::UserListParams
81
78
  def list(params = {})
82
- parsed, options = Knockapi::Models::UserListParams.dump_request(params)
79
+ parsed, options = Knockapi::UserListParams.dump_request(params)
83
80
  @client.request(
84
81
  method: :get,
85
82
  path: "v1/users",
86
83
  query: parsed,
87
84
  page: Knockapi::Internal::EntriesCursor,
88
- model: Knockapi::Models::User,
85
+ model: Knockapi::User,
89
86
  options: options
90
87
  )
91
88
  end
@@ -118,14 +115,14 @@ module Knockapi
118
115
  #
119
116
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
120
117
  #
121
- # @return [Knockapi::Models::User]
118
+ # @return [Knockapi::User]
122
119
  #
123
120
  # @see Knockapi::Models::UserGetParams
124
121
  def get(user_id, params = {})
125
122
  @client.request(
126
123
  method: :get,
127
124
  path: ["v1/users/%1$s", user_id],
128
- model: Knockapi::Models::User,
125
+ model: Knockapi::User,
129
126
  options: params[:request_options]
130
127
  )
131
128
  end
@@ -140,14 +137,14 @@ module Knockapi
140
137
  #
141
138
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
142
139
  #
143
- # @return [Knockapi::Models::Recipients::RecipientsChannelData]
140
+ # @return [Knockapi::Recipients::RecipientsChannelData]
144
141
  #
145
142
  # @see Knockapi::Models::UserGetChannelDataParams
146
143
  def get_channel_data(user_id, channel_id, params = {})
147
144
  @client.request(
148
145
  method: :get,
149
146
  path: ["v1/users/%1$s/channel_data/%2$s", user_id, channel_id],
150
- model: Knockapi::Models::Recipients::RecipientsChannelData,
147
+ model: Knockapi::Recipients::RecipientsChannelData,
151
148
  options: params[:request_options]
152
149
  )
153
150
  end
@@ -165,16 +162,16 @@ module Knockapi
165
162
  #
166
163
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
167
164
  #
168
- # @return [Knockapi::Models::Recipients::PreferenceSet]
165
+ # @return [Knockapi::Recipients::PreferenceSet]
169
166
  #
170
167
  # @see Knockapi::Models::UserGetPreferencesParams
171
168
  def get_preferences(user_id, id, params = {})
172
- parsed, options = Knockapi::Models::UserGetPreferencesParams.dump_request(params)
169
+ parsed, options = Knockapi::UserGetPreferencesParams.dump_request(params)
173
170
  @client.request(
174
171
  method: :get,
175
172
  path: ["v1/users/%1$s/preferences/%2$s", user_id, id],
176
173
  query: parsed,
177
- model: Knockapi::Models::Recipients::PreferenceSet,
174
+ model: Knockapi::Recipients::PreferenceSet,
178
175
  options: options
179
176
  )
180
177
  end
@@ -196,44 +193,41 @@ module Knockapi
196
193
  #
197
194
  # @param channel_id [String] Limits the results to items with the corresponding channel ID.
198
195
  #
199
- # @param engagement_status [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
196
+ # @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
200
197
  #
201
- # @param inserted_at [Knockapi::Models::UserListMessagesParams::InsertedAt]
198
+ # @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
202
199
  #
203
200
  # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
204
- # ...
205
201
  #
206
202
  # @param page_size [Integer] The number of items per page.
207
203
  #
208
204
  # @param source [String] Limits the results to messages triggered by the given workflow key.
209
205
  #
210
- # @param status [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
206
+ # @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
211
207
  #
212
208
  # @param tenant [String] Limits the results to items with the corresponding tenant.
213
209
  #
214
210
  # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
215
- # ...
216
211
  #
217
212
  # @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
218
213
  #
219
214
  # @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
220
215
  #
221
216
  # @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
222
- # ...
223
217
  #
224
218
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
225
219
  #
226
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Message>]
220
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Message>]
227
221
  #
228
222
  # @see Knockapi::Models::UserListMessagesParams
229
223
  def list_messages(user_id, params = {})
230
- parsed, options = Knockapi::Models::UserListMessagesParams.dump_request(params)
224
+ parsed, options = Knockapi::UserListMessagesParams.dump_request(params)
231
225
  @client.request(
232
226
  method: :get,
233
227
  path: ["v1/users/%1$s/messages", user_id],
234
228
  query: parsed,
235
229
  page: Knockapi::Internal::EntriesCursor,
236
- model: Knockapi::Models::Message,
230
+ model: Knockapi::Message,
237
231
  options: options
238
232
  )
239
233
  end
@@ -246,14 +240,14 @@ module Knockapi
246
240
  #
247
241
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
248
242
  #
249
- # @return [Array<Knockapi::Models::Recipients::PreferenceSet>]
243
+ # @return [Array<Knockapi::Recipients::PreferenceSet>]
250
244
  #
251
245
  # @see Knockapi::Models::UserListPreferencesParams
252
246
  def list_preferences(user_id, params = {})
253
247
  @client.request(
254
248
  method: :get,
255
249
  path: ["v1/users/%1$s/preferences", user_id],
256
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::PreferenceSet],
250
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PreferenceSet],
257
251
  options: params[:request_options]
258
252
  )
259
253
  end
@@ -276,17 +270,17 @@ module Knockapi
276
270
  #
277
271
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
278
272
  #
279
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
273
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
280
274
  #
281
275
  # @see Knockapi::Models::UserListSchedulesParams
282
276
  def list_schedules(user_id, params = {})
283
- parsed, options = Knockapi::Models::UserListSchedulesParams.dump_request(params)
277
+ parsed, options = Knockapi::UserListSchedulesParams.dump_request(params)
284
278
  @client.request(
285
279
  method: :get,
286
280
  path: ["v1/users/%1$s/schedules", user_id],
287
281
  query: parsed,
288
282
  page: Knockapi::Internal::EntriesCursor,
289
- model: Knockapi::Models::Schedule,
283
+ model: Knockapi::Schedule,
290
284
  options: options
291
285
  )
292
286
  end
@@ -302,7 +296,7 @@ module Knockapi
302
296
  #
303
297
  # @param before [String] The cursor to fetch entries before.
304
298
  #
305
- # @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
299
+ # @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
306
300
  #
307
301
  # @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
308
302
  #
@@ -310,17 +304,17 @@ module Knockapi
310
304
  #
311
305
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
312
306
  #
313
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Recipients::Subscription>]
307
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Recipients::Subscription>]
314
308
  #
315
309
  # @see Knockapi::Models::UserListSubscriptionsParams
316
310
  def list_subscriptions(user_id, params = {})
317
- parsed, options = Knockapi::Models::UserListSubscriptionsParams.dump_request(params)
311
+ parsed, options = Knockapi::UserListSubscriptionsParams.dump_request(params)
318
312
  @client.request(
319
313
  method: :get,
320
314
  path: ["v1/users/%1$s/subscriptions", user_id],
321
315
  query: parsed,
322
316
  page: Knockapi::Internal::EntriesCursor,
323
- model: Knockapi::Models::Recipients::Subscription,
317
+ model: Knockapi::Recipients::Subscription,
324
318
  options: options
325
319
  )
326
320
  end
@@ -336,16 +330,16 @@ module Knockapi
336
330
  #
337
331
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
338
332
  #
339
- # @return [Knockapi::Models::User]
333
+ # @return [Knockapi::User]
340
334
  #
341
335
  # @see Knockapi::Models::UserMergeParams
342
336
  def merge(user_id, params)
343
- parsed, options = Knockapi::Models::UserMergeParams.dump_request(params)
337
+ parsed, options = Knockapi::UserMergeParams.dump_request(params)
344
338
  @client.request(
345
339
  method: :post,
346
340
  path: ["v1/users/%1$s/merge", user_id],
347
341
  body: parsed,
348
- model: Knockapi::Models::User,
342
+ model: Knockapi::User,
349
343
  options: options
350
344
  )
351
345
  end
@@ -358,20 +352,20 @@ module Knockapi
358
352
  #
359
353
  # @param channel_id [String] The unique identifier for the channel.
360
354
  #
361
- # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
355
+ # @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
362
356
  #
363
357
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
364
358
  #
365
- # @return [Knockapi::Models::Recipients::RecipientsChannelData]
359
+ # @return [Knockapi::Recipients::RecipientsChannelData]
366
360
  #
367
361
  # @see Knockapi::Models::UserSetChannelDataParams
368
362
  def set_channel_data(user_id, channel_id, params)
369
- parsed, options = Knockapi::Models::UserSetChannelDataParams.dump_request(params)
363
+ parsed, options = Knockapi::UserSetChannelDataParams.dump_request(params)
370
364
  @client.request(
371
365
  method: :put,
372
366
  path: ["v1/users/%1$s/channel_data/%2$s", user_id, channel_id],
373
367
  body: parsed,
374
- model: Knockapi::Models::Recipients::RecipientsChannelData,
368
+ model: Knockapi::Recipients::RecipientsChannelData,
375
369
  options: options
376
370
  )
377
371
  end
@@ -388,26 +382,24 @@ module Knockapi
388
382
  #
389
383
  # @param id [String] Unique identifier for the preference set.
390
384
  #
391
- # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
392
- # ...
385
+ # @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
393
386
  #
394
- # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
387
+ # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
395
388
  #
396
- # @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
397
- # ...
389
+ # @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
398
390
  #
399
391
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
400
392
  #
401
- # @return [Knockapi::Models::Recipients::PreferenceSet]
393
+ # @return [Knockapi::Recipients::PreferenceSet]
402
394
  #
403
395
  # @see Knockapi::Models::UserSetPreferencesParams
404
396
  def set_preferences(user_id, id, params = {})
405
- parsed, options = Knockapi::Models::UserSetPreferencesParams.dump_request(params)
397
+ parsed, options = Knockapi::UserSetPreferencesParams.dump_request(params)
406
398
  @client.request(
407
399
  method: :put,
408
400
  path: ["v1/users/%1$s/preferences/%2$s", user_id, id],
409
401
  body: parsed,
410
- model: Knockapi::Models::Recipients::PreferenceSet,
402
+ model: Knockapi::Recipients::PreferenceSet,
411
403
  options: options
412
404
  )
413
405
  end
@@ -15,10 +15,8 @@ module Knockapi
15
15
  # @param key [String] The key of the workflow to cancel.
16
16
  #
17
17
  # @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
18
- # ...
19
18
  #
20
- # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
21
- # ...
19
+ # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
22
20
  #
23
21
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
24
22
  #
@@ -26,7 +24,7 @@ module Knockapi
26
24
  #
27
25
  # @see Knockapi::Models::WorkflowCancelParams
28
26
  def cancel(key, params)
29
- parsed, options = Knockapi::Models::WorkflowCancelParams.dump_request(params)
27
+ parsed, options = Knockapi::WorkflowCancelParams.dump_request(params)
30
28
  @client.request(
31
29
  method: :post,
32
30
  path: ["v1/workflows/%1$s/cancel", key],
@@ -49,18 +47,15 @@ module Knockapi
49
47
  #
50
48
  # @param key [String] Key of the workflow to trigger.
51
49
  #
52
- # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
53
- # ...
50
+ # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
54
51
  #
55
- # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
56
- # ...
52
+ # @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
57
53
  #
58
54
  # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
59
- # ...
60
55
  #
61
56
  # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
62
57
  #
63
- # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
58
+ # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
64
59
  #
65
60
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
66
61
  #
@@ -68,7 +63,7 @@ module Knockapi
68
63
  #
69
64
  # @see Knockapi::Models::WorkflowTriggerParams
70
65
  def trigger(key, params)
71
- parsed, options = Knockapi::Models::WorkflowTriggerParams.dump_request(params)
66
+ parsed, options = Knockapi::WorkflowTriggerParams.dump_request(params)
72
67
  @client.request(
73
68
  method: :post,
74
69
  path: ["v1/workflows/%1$s/trigger", key],
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Knockapi
4
- VERSION = "1.0.0"
4
+ VERSION = "1.2.0"
5
5
  end