knockapi 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (549) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +41 -0
  3. data/README.md +101 -49
  4. data/lib/knockapi/client.rb +4 -4
  5. data/lib/knockapi/errors.rb +1 -1
  6. data/lib/knockapi/file_part.rb +2 -2
  7. data/lib/knockapi/internal/entries_cursor.rb +3 -3
  8. data/lib/knockapi/internal/items_cursor.rb +3 -3
  9. data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
  10. data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
  11. data/lib/knockapi/internal/transport/base_client.rb +79 -7
  12. data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
  13. data/lib/knockapi/internal/type/array_of.rb +1 -1
  14. data/lib/knockapi/internal/type/base_model.rb +71 -39
  15. data/lib/knockapi/internal/type/converter.rb +18 -0
  16. data/lib/knockapi/internal/type/enum.rb +1 -0
  17. data/lib/knockapi/internal/type/hash_of.rb +1 -1
  18. data/lib/knockapi/internal/type/request_parameters.rb +6 -12
  19. data/lib/knockapi/internal/type/union.rb +4 -3
  20. data/lib/knockapi/internal/util.rb +74 -2
  21. data/lib/knockapi/internal.rb +6 -0
  22. data/lib/knockapi/models/activity.rb +6 -6
  23. data/lib/knockapi/models/audience_add_members_params.rb +10 -8
  24. data/lib/knockapi/models/audience_add_members_response.rb +7 -0
  25. data/lib/knockapi/models/audience_list_members_response.rb +6 -6
  26. data/lib/knockapi/models/audience_member.rb +5 -6
  27. data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
  28. data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
  29. data/lib/knockapi/models/bulk_operation.rb +7 -8
  30. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
  31. data/lib/knockapi/models/condition.rb +4 -4
  32. data/lib/knockapi/models/identify_user_request.rb +16 -17
  33. data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
  34. data/lib/knockapi/models/inline_object_request.rb +8 -6
  35. data/lib/knockapi/models/inline_tenant_request.rb +6 -2
  36. data/lib/knockapi/models/message.rb +19 -23
  37. data/lib/knockapi/models/message_delivery_log.rb +26 -18
  38. data/lib/knockapi/models/message_event.rb +9 -10
  39. data/lib/knockapi/models/message_get_content_response.rb +21 -0
  40. data/lib/knockapi/models/message_list_params.rb +9 -13
  41. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  42. data/lib/knockapi/models/messages/batch_get_content_response.rb +21 -0
  43. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  44. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  45. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  46. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  47. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  48. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  49. data/lib/knockapi/models/object.rb +9 -1
  50. data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
  51. data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
  52. data/lib/knockapi/models/object_delete_response.rb +7 -0
  53. data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
  54. data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
  55. data/lib/knockapi/models/object_list_messages_params.rb +11 -12
  56. data/lib/knockapi/models/object_list_params.rb +3 -4
  57. data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
  58. data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
  59. data/lib/knockapi/models/object_set_params.rb +15 -13
  60. data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
  61. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
  62. data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
  63. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
  64. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
  65. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
  66. data/lib/knockapi/models/recipient.rb +7 -3
  67. data/lib/knockapi/models/recipient_reference.rb +6 -2
  68. data/lib/knockapi/models/recipient_request.rb +7 -3
  69. data/lib/knockapi/models/recipients/channel_data.rb +26 -14
  70. data/lib/knockapi/models/recipients/channel_data_request.rb +22 -10
  71. data/lib/knockapi/models/recipients/discord_channel_data.rb +25 -10
  72. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +36 -1
  73. data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
  74. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +25 -10
  75. data/lib/knockapi/models/recipients/preference_set.rb +52 -28
  76. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
  77. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +60 -36
  78. data/lib/knockapi/models/recipients/preference_set_request.rb +52 -28
  79. data/lib/knockapi/models/recipients/slack_channel_data.rb +21 -10
  80. data/lib/knockapi/models/recipients/subscription.rb +6 -6
  81. data/lib/knockapi/models/schedule.rb +11 -12
  82. data/lib/knockapi/models/schedule_create_params.rb +10 -15
  83. data/lib/knockapi/models/schedule_create_response.rb +1 -1
  84. data/lib/knockapi/models/schedule_delete_response.rb +1 -1
  85. data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
  86. data/lib/knockapi/models/schedule_update_params.rb +9 -10
  87. data/lib/knockapi/models/schedule_update_response.rb +1 -1
  88. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
  89. data/lib/knockapi/models/tenant.rb +13 -16
  90. data/lib/knockapi/models/tenant_delete_response.rb +7 -0
  91. data/lib/knockapi/models/tenant_request.rb +20 -20
  92. data/lib/knockapi/models/tenant_set_params.rb +19 -19
  93. data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
  94. data/lib/knockapi/models/user.rb +9 -11
  95. data/lib/knockapi/models/user_delete_response.rb +7 -0
  96. data/lib/knockapi/models/user_list_messages_params.rb +13 -12
  97. data/lib/knockapi/models/user_list_params.rb +3 -4
  98. data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
  99. data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
  100. data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
  101. data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
  102. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
  103. data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
  104. data/lib/knockapi/models/users/feed_list_items_response.rb +15 -6
  105. data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
  106. data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
  107. data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
  108. data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
  109. data/lib/knockapi/models.rb +202 -0
  110. data/lib/knockapi/request_options.rb +4 -0
  111. data/lib/knockapi/resources/audiences.rb +4 -4
  112. data/lib/knockapi/resources/bulk_operations.rb +2 -2
  113. data/lib/knockapi/resources/channels/bulk.rb +7 -8
  114. data/lib/knockapi/resources/integrations/census.rb +1 -1
  115. data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
  116. data/lib/knockapi/resources/messages/batch.rb +22 -22
  117. data/lib/knockapi/resources/messages.rb +32 -39
  118. data/lib/knockapi/resources/objects/bulk.rb +11 -11
  119. data/lib/knockapi/resources/objects.rb +52 -62
  120. data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
  121. data/lib/knockapi/resources/providers/slack.rb +4 -4
  122. data/lib/knockapi/resources/schedules/bulk.rb +4 -4
  123. data/lib/knockapi/resources/schedules.rb +18 -23
  124. data/lib/knockapi/resources/tenants/bulk.rb +7 -7
  125. data/lib/knockapi/resources/tenants.rb +11 -11
  126. data/lib/knockapi/resources/users/bulk.rb +11 -11
  127. data/lib/knockapi/resources/users/feeds.rb +3 -3
  128. data/lib/knockapi/resources/users/guides.rb +4 -4
  129. data/lib/knockapi/resources/users.rb +46 -54
  130. data/lib/knockapi/resources/workflows.rb +6 -11
  131. data/lib/knockapi/version.rb +1 -1
  132. data/lib/knockapi.rb +11 -2
  133. data/rbi/knockapi/client.rbi +5 -4
  134. data/rbi/knockapi/errors.rbi +35 -16
  135. data/rbi/knockapi/file_part.rbi +9 -6
  136. data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
  137. data/rbi/knockapi/internal/items_cursor.rbi +9 -4
  138. data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
  139. data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
  140. data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
  141. data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
  142. data/rbi/knockapi/internal/type/array_of.rbi +34 -24
  143. data/rbi/knockapi/internal/type/base_model.rbi +151 -73
  144. data/rbi/knockapi/internal/type/base_page.rbi +12 -8
  145. data/rbi/knockapi/internal/type/boolean.rbi +16 -14
  146. data/rbi/knockapi/internal/type/converter.rbi +70 -28
  147. data/rbi/knockapi/internal/type/enum.rbi +28 -15
  148. data/rbi/knockapi/internal/type/file_input.rbi +8 -4
  149. data/rbi/knockapi/internal/type/hash_of.rbi +34 -24
  150. data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
  151. data/rbi/knockapi/internal/type/union.rbi +55 -19
  152. data/rbi/knockapi/internal/type/unknown.rbi +16 -6
  153. data/rbi/knockapi/internal/util.rbi +239 -87
  154. data/rbi/knockapi/internal.rbi +2 -0
  155. data/rbi/knockapi/models/activity.rbi +28 -22
  156. data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
  157. data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
  158. data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
  159. data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
  160. data/rbi/knockapi/models/audience_member.rbi +23 -11
  161. data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
  162. data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
  163. data/rbi/knockapi/models/bulk_operation.rbi +70 -42
  164. data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
  165. data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
  166. data/rbi/knockapi/models/condition.rbi +78 -31
  167. data/rbi/knockapi/models/identify_user_request.rbi +90 -36
  168. data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
  169. data/rbi/knockapi/models/inline_object_request.rbi +76 -22
  170. data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
  171. data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
  172. data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
  173. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
  174. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
  175. data/rbi/knockapi/models/message.rbi +156 -72
  176. data/rbi/knockapi/models/message_archive_params.rbi +13 -5
  177. data/rbi/knockapi/models/message_delivery_log.rbi +153 -66
  178. data/rbi/knockapi/models/message_event.rbi +86 -37
  179. data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
  180. data/rbi/knockapi/models/message_get_content_response.rbi +364 -203
  181. data/rbi/knockapi/models/message_get_params.rbi +13 -5
  182. data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
  183. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
  184. data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
  185. data/rbi/knockapi/models/message_list_params.rbi +147 -58
  186. data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
  187. data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
  188. data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
  189. data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
  190. data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
  191. data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
  192. data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
  193. data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
  194. data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
  195. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +367 -206
  196. data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
  197. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
  198. data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
  199. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
  200. data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
  201. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
  202. data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
  203. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
  204. data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
  205. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
  206. data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
  207. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
  208. data/rbi/knockapi/models/object.rbi +31 -10
  209. data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
  210. data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
  211. data/rbi/knockapi/models/object_delete_params.rbi +13 -5
  212. data/rbi/knockapi/models/object_delete_response.rbi +7 -0
  213. data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
  214. data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
  215. data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
  216. data/rbi/knockapi/models/object_get_params.rbi +13 -5
  217. data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
  218. data/rbi/knockapi/models/object_list_messages_params.rbi +169 -60
  219. data/rbi/knockapi/models/object_list_params.rbi +43 -22
  220. data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
  221. data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
  222. data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
  223. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
  224. data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
  225. data/rbi/knockapi/models/object_set_params.rbi +89 -33
  226. data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
  227. data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
  228. data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
  229. data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
  230. data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
  231. data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
  232. data/rbi/knockapi/models/page_info.rbi +22 -11
  233. data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
  234. data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
  235. data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
  236. data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
  237. data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
  238. data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
  239. data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
  240. data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
  241. data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
  242. data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
  243. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
  244. data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
  245. data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
  246. data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
  247. data/rbi/knockapi/models/recipient.rbi +5 -2
  248. data/rbi/knockapi/models/recipient_reference.rbi +22 -5
  249. data/rbi/knockapi/models/recipient_request.rbi +11 -4
  250. data/rbi/knockapi/models/recipients/channel_data.rbi +123 -50
  251. data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
  252. data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
  253. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
  254. data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
  255. data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
  256. data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
  257. data/rbi/knockapi/models/recipients/preference_set.rbi +159 -88
  258. data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
  259. data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
  260. data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
  261. data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
  262. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
  263. data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
  264. data/rbi/knockapi/models/schedule.rbi +32 -27
  265. data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
  266. data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
  267. data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
  268. data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
  269. data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
  270. data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
  271. data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
  272. data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
  273. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
  274. data/rbi/knockapi/models/tenant.rbi +71 -45
  275. data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
  276. data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
  277. data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
  278. data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
  279. data/rbi/knockapi/models/tenant_request.rbi +132 -57
  280. data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
  281. data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
  282. data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
  283. data/rbi/knockapi/models/user.rbi +32 -28
  284. data/rbi/knockapi/models/user_delete_params.rbi +13 -5
  285. data/rbi/knockapi/models/user_delete_response.rbi +7 -0
  286. data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
  287. data/rbi/knockapi/models/user_get_params.rbi +13 -5
  288. data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
  289. data/rbi/knockapi/models/user_list_messages_params.rbi +168 -59
  290. data/rbi/knockapi/models/user_list_params.rbi +43 -22
  291. data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
  292. data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
  293. data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
  294. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
  295. data/rbi/knockapi/models/user_merge_params.rbi +17 -6
  296. data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
  297. data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
  298. data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
  299. data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
  300. data/rbi/knockapi/models/user_update_params.rbi +13 -5
  301. data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
  302. data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
  303. data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
  304. data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
  305. data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
  306. data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
  307. data/rbi/knockapi/models/users/feed_list_items_response.rbi +197 -100
  308. data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
  309. data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
  310. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
  311. data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
  312. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
  313. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
  314. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
  315. data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
  316. data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
  317. data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
  318. data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
  319. data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
  320. data/rbi/knockapi/models.rbi +179 -0
  321. data/rbi/knockapi/request_options.rbi +18 -7
  322. data/rbi/knockapi/resources/audiences.rbi +22 -14
  323. data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
  324. data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
  325. data/rbi/knockapi/resources/channels.rbi +2 -1
  326. data/rbi/knockapi/resources/integrations/census.rbi +8 -4
  327. data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
  328. data/rbi/knockapi/resources/integrations.rbi +2 -1
  329. data/rbi/knockapi/resources/messages/batch.rbi +58 -26
  330. data/rbi/knockapi/resources/messages.rbi +102 -43
  331. data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
  332. data/rbi/knockapi/resources/objects.rbi +177 -107
  333. data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
  334. data/rbi/knockapi/resources/providers/slack.rbi +28 -11
  335. data/rbi/knockapi/resources/providers.rbi +2 -1
  336. data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
  337. data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
  338. data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
  339. data/rbi/knockapi/resources/recipients.rbi +2 -1
  340. data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
  341. data/rbi/knockapi/resources/schedules.rbi +44 -33
  342. data/rbi/knockapi/resources/shared.rbi +2 -1
  343. data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
  344. data/rbi/knockapi/resources/tenants.rbi +51 -20
  345. data/rbi/knockapi/resources/users/bulk.rbi +21 -14
  346. data/rbi/knockapi/resources/users/feeds.rbi +20 -9
  347. data/rbi/knockapi/resources/users/guides.rbi +23 -16
  348. data/rbi/knockapi/resources/users.rbi +160 -91
  349. data/rbi/knockapi/resources/workflows.rbi +38 -29
  350. data/sig/knockapi/internal/entries_cursor.rbs +0 -2
  351. data/sig/knockapi/internal/items_cursor.rbs +0 -2
  352. data/sig/knockapi/internal/transport/base_client.rbs +16 -1
  353. data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
  354. data/sig/knockapi/internal/type/base_model.rbs +11 -5
  355. data/sig/knockapi/internal/type/base_page.rbs +1 -1
  356. data/sig/knockapi/internal/type/converter.rbs +2 -0
  357. data/sig/knockapi/internal/type/enum.rbs +1 -0
  358. data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
  359. data/sig/knockapi/internal/type/union.rbs +1 -0
  360. data/sig/knockapi/internal/util.rbs +15 -0
  361. data/sig/knockapi/internal.rbs +2 -0
  362. data/sig/knockapi/models/activity.rbs +0 -2
  363. data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
  364. data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
  365. data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
  366. data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
  367. data/sig/knockapi/models/audience_member.rbs +3 -5
  368. data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
  369. data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
  370. data/sig/knockapi/models/bulk_operation.rbs +9 -13
  371. data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
  372. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
  373. data/sig/knockapi/models/condition.rbs +4 -6
  374. data/sig/knockapi/models/identify_user_request.rbs +0 -2
  375. data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
  376. data/sig/knockapi/models/inline_object_request.rbs +0 -2
  377. data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
  378. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
  379. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
  380. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
  381. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
  382. data/sig/knockapi/models/message.rbs +15 -23
  383. data/sig/knockapi/models/message_archive_params.rbs +0 -2
  384. data/sig/knockapi/models/message_delivery_log.rbs +24 -30
  385. data/sig/knockapi/models/message_event.rbs +4 -6
  386. data/sig/knockapi/models/message_get_content_params.rbs +0 -2
  387. data/sig/knockapi/models/message_get_content_response.rbs +2 -24
  388. data/sig/knockapi/models/message_get_params.rbs +0 -2
  389. data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
  390. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
  391. data/sig/knockapi/models/message_list_events_params.rbs +0 -2
  392. data/sig/knockapi/models/message_list_params.rbs +17 -21
  393. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
  394. data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
  395. data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
  396. data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
  397. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
  398. data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
  399. data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
  400. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  401. data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
  402. data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
  403. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
  404. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
  405. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
  406. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  407. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
  408. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  409. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
  410. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  411. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
  412. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  413. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
  414. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  415. data/sig/knockapi/models/object.rbs +8 -4
  416. data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
  417. data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
  418. data/sig/knockapi/models/object_delete_params.rbs +0 -2
  419. data/sig/knockapi/models/object_delete_response.rbs +5 -0
  420. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
  421. data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
  422. data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
  423. data/sig/knockapi/models/object_get_params.rbs +0 -2
  424. data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
  425. data/sig/knockapi/models/object_list_messages_params.rbs +17 -21
  426. data/sig/knockapi/models/object_list_params.rbs +6 -8
  427. data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
  428. data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
  429. data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
  430. data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
  431. data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
  432. data/sig/knockapi/models/object_set_params.rbs +0 -2
  433. data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
  434. data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
  435. data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
  436. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
  437. data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
  438. data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
  439. data/sig/knockapi/models/page_info.rbs +0 -2
  440. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
  441. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
  442. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
  443. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
  444. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
  445. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
  446. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
  447. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
  448. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
  449. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
  450. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
  451. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
  452. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
  453. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
  454. data/sig/knockapi/models/recipient.rbs +2 -2
  455. data/sig/knockapi/models/recipient_reference.rbs +2 -4
  456. data/sig/knockapi/models/recipient_request.rbs +3 -3
  457. data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
  458. data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
  459. data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
  460. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
  461. data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
  462. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
  463. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
  464. data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
  465. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
  466. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
  467. data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
  468. data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
  469. data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
  470. data/sig/knockapi/models/recipients/subscription.rbs +3 -5
  471. data/sig/knockapi/models/schedule.rbs +3 -5
  472. data/sig/knockapi/models/schedule_create_params.rbs +3 -5
  473. data/sig/knockapi/models/schedule_create_response.rbs +1 -1
  474. data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
  475. data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
  476. data/sig/knockapi/models/schedule_list_params.rbs +0 -2
  477. data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
  478. data/sig/knockapi/models/schedule_update_params.rbs +5 -7
  479. data/sig/knockapi/models/schedule_update_response.rbs +1 -1
  480. data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
  481. data/sig/knockapi/models/tenant.rbs +9 -15
  482. data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
  483. data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
  484. data/sig/knockapi/models/tenant_get_params.rbs +0 -2
  485. data/sig/knockapi/models/tenant_list_params.rbs +0 -2
  486. data/sig/knockapi/models/tenant_request.rbs +13 -19
  487. data/sig/knockapi/models/tenant_set_params.rbs +13 -19
  488. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
  489. data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
  490. data/sig/knockapi/models/user.rbs +0 -2
  491. data/sig/knockapi/models/user_delete_params.rbs +0 -2
  492. data/sig/knockapi/models/user_delete_response.rbs +5 -0
  493. data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
  494. data/sig/knockapi/models/user_get_params.rbs +0 -2
  495. data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
  496. data/sig/knockapi/models/user_list_messages_params.rbs +17 -21
  497. data/sig/knockapi/models/user_list_params.rbs +6 -8
  498. data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
  499. data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
  500. data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
  501. data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
  502. data/sig/knockapi/models/user_merge_params.rbs +0 -2
  503. data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
  504. data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
  505. data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
  506. data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
  507. data/sig/knockapi/models/user_update_params.rbs +0 -2
  508. data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
  509. data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
  510. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
  511. data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
  512. data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
  513. data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
  514. data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
  515. data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
  516. data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
  517. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
  518. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
  519. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
  520. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
  521. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
  522. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
  523. data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
  524. data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
  525. data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
  526. data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
  527. data/sig/knockapi/models.rbs +173 -0
  528. data/sig/knockapi/request_options.rbs +1 -1
  529. data/sig/knockapi/resources/audiences.rbs +2 -2
  530. data/sig/knockapi/resources/bulk_operations.rbs +1 -1
  531. data/sig/knockapi/resources/channels/bulk.rbs +1 -1
  532. data/sig/knockapi/resources/messages.rbs +15 -17
  533. data/sig/knockapi/resources/objects/bulk.rbs +5 -5
  534. data/sig/knockapi/resources/objects.rbs +19 -19
  535. data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
  536. data/sig/knockapi/resources/providers/slack.rbs +1 -1
  537. data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
  538. data/sig/knockapi/resources/schedules.rbs +3 -3
  539. data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
  540. data/sig/knockapi/resources/tenants.rbs +4 -4
  541. data/sig/knockapi/resources/users/bulk.rbs +5 -5
  542. data/sig/knockapi/resources/users.rbs +19 -19
  543. metadata +29 -8
  544. data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
  545. data/lib/knockapi/resources/messages/activities.rb +0 -47
  546. data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
  547. data/rbi/knockapi/resources/messages/activities.rbi +0 -38
  548. data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
  549. data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -17,23 +17,23 @@ module Knockapi
17
17
  #
18
18
  # @param before [String] The cursor to fetch entries before.
19
19
  #
20
- # @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
20
+ # @param include [Array<Symbol, Knockapi::ObjectListParams::Include>] Includes preferences of the objects in the response.
21
21
  #
22
22
  # @param page_size [Integer] The number of items per page.
23
23
  #
24
24
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
25
25
  #
26
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Object>]
26
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Object>]
27
27
  #
28
28
  # @see Knockapi::Models::ObjectListParams
29
29
  def list(collection, params = {})
30
- parsed, options = Knockapi::Models::ObjectListParams.dump_request(params)
30
+ parsed, options = Knockapi::ObjectListParams.dump_request(params)
31
31
  @client.request(
32
32
  method: :get,
33
33
  path: ["v1/objects/%1$s", collection],
34
34
  query: parsed,
35
35
  page: Knockapi::Internal::EntriesCursor,
36
- model: Knockapi::Models::Object,
36
+ model: Knockapi::Object,
37
37
  options: options
38
38
  )
39
39
  end
@@ -75,23 +75,22 @@ module Knockapi
75
75
  #
76
76
  # @param object_id_ [String] Unique identifier for the object.
77
77
  #
78
- # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
79
- # ...
78
+ # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
80
79
  #
81
80
  # @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
82
81
  #
83
82
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
84
83
  #
85
- # @return [Array<Knockapi::Models::Recipients::Subscription>]
84
+ # @return [Array<Knockapi::Recipients::Subscription>]
86
85
  #
87
86
  # @see Knockapi::Models::ObjectAddSubscriptionsParams
88
87
  def add_subscriptions(collection, object_id_, params)
89
- parsed, options = Knockapi::Models::ObjectAddSubscriptionsParams.dump_request(params)
88
+ parsed, options = Knockapi::ObjectAddSubscriptionsParams.dump_request(params)
90
89
  @client.request(
91
90
  method: :post,
92
91
  path: ["v1/objects/%1$s/%2$s/subscriptions", collection, object_id_],
93
92
  body: parsed,
94
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::Subscription],
93
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::Subscription],
95
94
  options: options
96
95
  )
97
96
  end
@@ -108,21 +107,20 @@ module Knockapi
108
107
  #
109
108
  # @param object_id_ [String] Unique identifier for the object.
110
109
  #
111
- # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
112
- # ...
110
+ # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
113
111
  #
114
112
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
115
113
  #
116
- # @return [Array<Knockapi::Models::Recipients::Subscription>]
114
+ # @return [Array<Knockapi::Recipients::Subscription>]
117
115
  #
118
116
  # @see Knockapi::Models::ObjectDeleteSubscriptionsParams
119
117
  def delete_subscriptions(collection, object_id_, params)
120
- parsed, options = Knockapi::Models::ObjectDeleteSubscriptionsParams.dump_request(params)
118
+ parsed, options = Knockapi::ObjectDeleteSubscriptionsParams.dump_request(params)
121
119
  @client.request(
122
120
  method: :delete,
123
121
  path: ["v1/objects/%1$s/%2$s/subscriptions", collection, object_id_],
124
122
  body: parsed,
125
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::Subscription],
123
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::Subscription],
126
124
  options: options
127
125
  )
128
126
  end
@@ -138,14 +136,14 @@ module Knockapi
138
136
  #
139
137
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
140
138
  #
141
- # @return [Knockapi::Models::Object]
139
+ # @return [Knockapi::Object]
142
140
  #
143
141
  # @see Knockapi::Models::ObjectGetParams
144
142
  def get(collection, id, params = {})
145
143
  @client.request(
146
144
  method: :get,
147
145
  path: ["v1/objects/%1$s/%2$s", collection, id],
148
- model: Knockapi::Models::Object,
146
+ model: Knockapi::Object,
149
147
  options: params[:request_options]
150
148
  )
151
149
  end
@@ -162,14 +160,14 @@ module Knockapi
162
160
  #
163
161
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
164
162
  #
165
- # @return [Knockapi::Models::Recipients::RecipientsChannelData]
163
+ # @return [Knockapi::Recipients::RecipientsChannelData]
166
164
  #
167
165
  # @see Knockapi::Models::ObjectGetChannelDataParams
168
166
  def get_channel_data(collection, object_id_, channel_id, params = {})
169
167
  @client.request(
170
168
  method: :get,
171
169
  path: ["v1/objects/%1$s/%2$s/channel_data/%3$s", collection, object_id_, channel_id],
172
- model: Knockapi::Models::Recipients::RecipientsChannelData,
170
+ model: Knockapi::Recipients::RecipientsChannelData,
173
171
  options: params[:request_options]
174
172
  )
175
173
  end
@@ -186,14 +184,14 @@ module Knockapi
186
184
  #
187
185
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
188
186
  #
189
- # @return [Knockapi::Models::Recipients::PreferenceSet]
187
+ # @return [Knockapi::Recipients::PreferenceSet]
190
188
  #
191
189
  # @see Knockapi::Models::ObjectGetPreferencesParams
192
190
  def get_preferences(collection, object_id_, id, params = {})
193
191
  @client.request(
194
192
  method: :get,
195
193
  path: ["v1/objects/%1$s/%2$s/preferences/%3$s", collection, object_id_, id],
196
- model: Knockapi::Models::Recipients::PreferenceSet,
194
+ model: Knockapi::Recipients::PreferenceSet,
197
195
  options: params[:request_options]
198
196
  )
199
197
  end
@@ -217,44 +215,41 @@ module Knockapi
217
215
  #
218
216
  # @param channel_id [String] Limits the results to items with the corresponding channel ID.
219
217
  #
220
- # @param engagement_status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
218
+ # @param engagement_status [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
221
219
  #
222
- # @param inserted_at [Knockapi::Models::ObjectListMessagesParams::InsertedAt]
220
+ # @param inserted_at [Knockapi::ObjectListMessagesParams::InsertedAt]
223
221
  #
224
222
  # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
225
- # ...
226
223
  #
227
224
  # @param page_size [Integer] The number of items per page.
228
225
  #
229
226
  # @param source [String] Limits the results to messages triggered by the given workflow key.
230
227
  #
231
- # @param status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
228
+ # @param status [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
232
229
  #
233
230
  # @param tenant [String] Limits the results to items with the corresponding tenant.
234
231
  #
235
232
  # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
236
- # ...
237
233
  #
238
234
  # @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
239
235
  #
240
236
  # @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
241
237
  #
242
238
  # @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
243
- # ...
244
239
  #
245
240
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
246
241
  #
247
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Message>]
242
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Message>]
248
243
  #
249
244
  # @see Knockapi::Models::ObjectListMessagesParams
250
245
  def list_messages(collection, id, params = {})
251
- parsed, options = Knockapi::Models::ObjectListMessagesParams.dump_request(params)
246
+ parsed, options = Knockapi::ObjectListMessagesParams.dump_request(params)
252
247
  @client.request(
253
248
  method: :get,
254
249
  path: ["v1/objects/%1$s/%2$s/messages", collection, id],
255
250
  query: parsed,
256
251
  page: Knockapi::Internal::EntriesCursor,
257
- model: Knockapi::Models::Message,
252
+ model: Knockapi::Message,
258
253
  options: options
259
254
  )
260
255
  end
@@ -269,14 +264,14 @@ module Knockapi
269
264
  #
270
265
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
271
266
  #
272
- # @return [Array<Knockapi::Models::Recipients::PreferenceSet>]
267
+ # @return [Array<Knockapi::Recipients::PreferenceSet>]
273
268
  #
274
269
  # @see Knockapi::Models::ObjectListPreferencesParams
275
270
  def list_preferences(collection, object_id_, params = {})
276
271
  @client.request(
277
272
  method: :get,
278
273
  path: ["v1/objects/%1$s/%2$s/preferences", collection, object_id_],
279
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Recipients::PreferenceSet],
274
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PreferenceSet],
280
275
  options: params[:request_options]
281
276
  )
282
277
  end
@@ -301,17 +296,17 @@ module Knockapi
301
296
  #
302
297
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
303
298
  #
304
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
299
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
305
300
  #
306
301
  # @see Knockapi::Models::ObjectListSchedulesParams
307
302
  def list_schedules(collection, id, params = {})
308
- parsed, options = Knockapi::Models::ObjectListSchedulesParams.dump_request(params)
303
+ parsed, options = Knockapi::ObjectListSchedulesParams.dump_request(params)
309
304
  @client.request(
310
305
  method: :get,
311
306
  path: ["v1/objects/%1$s/%2$s/schedules", collection, id],
312
307
  query: parsed,
313
308
  page: Knockapi::Internal::EntriesCursor,
314
- model: Knockapi::Models::Schedule,
309
+ model: Knockapi::Schedule,
315
310
  options: options
316
311
  )
317
312
  end
@@ -333,30 +328,29 @@ module Knockapi
333
328
  #
334
329
  # @param before [String] The cursor to fetch entries before.
335
330
  #
336
- # @param include [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
331
+ # @param include [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
337
332
  #
338
- # @param mode [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
339
- # ...
333
+ # @param mode [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
340
334
  #
341
- # @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
335
+ # @param objects [Array<Knockapi::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
342
336
  #
343
337
  # @param page_size [Integer] The number of items per page.
344
338
  #
345
- # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
339
+ # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
346
340
  #
347
341
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
348
342
  #
349
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Recipients::Subscription>]
343
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Recipients::Subscription>]
350
344
  #
351
345
  # @see Knockapi::Models::ObjectListSubscriptionsParams
352
346
  def list_subscriptions(collection, object_id_, params = {})
353
- parsed, options = Knockapi::Models::ObjectListSubscriptionsParams.dump_request(params)
347
+ parsed, options = Knockapi::ObjectListSubscriptionsParams.dump_request(params)
354
348
  @client.request(
355
349
  method: :get,
356
350
  path: ["v1/objects/%1$s/%2$s/subscriptions", collection, object_id_],
357
351
  query: parsed,
358
352
  page: Knockapi::Internal::EntriesCursor,
359
- model: Knockapi::Models::Recipients::Subscription,
353
+ model: Knockapi::Recipients::Subscription,
360
354
  options: options
361
355
  )
362
356
  end
@@ -374,28 +368,26 @@ module Knockapi
374
368
  #
375
369
  # @param id [String] Unique identifier for the object.
376
370
  #
377
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}] A request to set channel data for a type of channel inline.
371
+ # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
378
372
  #
379
373
  # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
380
- # ...
381
374
  #
382
- # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
375
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
383
376
  #
384
- # @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
385
- # ...
377
+ # @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
386
378
  #
387
379
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
388
380
  #
389
- # @return [Knockapi::Models::Object]
381
+ # @return [Knockapi::Object]
390
382
  #
391
383
  # @see Knockapi::Models::ObjectSetParams
392
384
  def set(collection, id, params = {})
393
- parsed, options = Knockapi::Models::ObjectSetParams.dump_request(params)
385
+ parsed, options = Knockapi::ObjectSetParams.dump_request(params)
394
386
  @client.request(
395
387
  method: :put,
396
388
  path: ["v1/objects/%1$s/%2$s", collection, id],
397
389
  body: parsed,
398
- model: Knockapi::Models::Object,
390
+ model: Knockapi::Object,
399
391
  options: options
400
392
  )
401
393
  end
@@ -412,20 +404,20 @@ module Knockapi
412
404
  #
413
405
  # @param channel_id [String] The unique identifier for the channel.
414
406
  #
415
- # @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.
407
+ # @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
416
408
  #
417
409
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
418
410
  #
419
- # @return [Knockapi::Models::Recipients::RecipientsChannelData]
411
+ # @return [Knockapi::Recipients::RecipientsChannelData]
420
412
  #
421
413
  # @see Knockapi::Models::ObjectSetChannelDataParams
422
414
  def set_channel_data(collection, object_id_, channel_id, params)
423
- parsed, options = Knockapi::Models::ObjectSetChannelDataParams.dump_request(params)
415
+ parsed, options = Knockapi::ObjectSetChannelDataParams.dump_request(params)
424
416
  @client.request(
425
417
  method: :put,
426
418
  path: ["v1/objects/%1$s/%2$s/channel_data/%3$s", collection, object_id_, channel_id],
427
419
  body: parsed,
428
- model: Knockapi::Models::Recipients::RecipientsChannelData,
420
+ model: Knockapi::Recipients::RecipientsChannelData,
429
421
  options: options
430
422
  )
431
423
  end
@@ -448,26 +440,24 @@ module Knockapi
448
440
  #
449
441
  # @param id [String] Unique identifier for the preference set.
450
442
  #
451
- # @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
452
- # ...
443
+ # @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
453
444
  #
454
- # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
445
+ # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
455
446
  #
456
- # @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
457
- # ...
447
+ # @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
458
448
  #
459
449
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
460
450
  #
461
- # @return [Knockapi::Models::Recipients::PreferenceSet]
451
+ # @return [Knockapi::Recipients::PreferenceSet]
462
452
  #
463
453
  # @see Knockapi::Models::ObjectSetPreferencesParams
464
454
  def set_preferences(collection, object_id_, id, params = {})
465
- parsed, options = Knockapi::Models::ObjectSetPreferencesParams.dump_request(params)
455
+ parsed, options = Knockapi::ObjectSetPreferencesParams.dump_request(params)
466
456
  @client.request(
467
457
  method: :put,
468
458
  path: ["v1/objects/%1$s/%2$s/preferences/%3$s", collection, object_id_, id],
469
459
  body: parsed,
470
- model: Knockapi::Models::Recipients::PreferenceSet,
460
+ model: Knockapi::Recipients::PreferenceSet,
471
461
  options: options
472
462
  )
473
463
  end
@@ -19,7 +19,7 @@ module Knockapi
19
19
  #
20
20
  # @see Knockapi::Models::Providers::MsTeamCheckAuthParams
21
21
  def check_auth(channel_id, params)
22
- parsed, options = Knockapi::Models::Providers::MsTeamCheckAuthParams.dump_request(params)
22
+ parsed, options = Knockapi::Providers::MsTeamCheckAuthParams.dump_request(params)
23
23
  @client.request(
24
24
  method: :get,
25
25
  path: ["v1/providers/ms-teams/%1$s/auth_check", channel_id],
@@ -40,7 +40,7 @@ module Knockapi
40
40
  #
41
41
  # @param team_id [String] Microsoft Teams team ID.
42
42
  #
43
- # @param query_options [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions]
43
+ # @param query_options [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions]
44
44
  #
45
45
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
46
46
  #
@@ -48,7 +48,7 @@ module Knockapi
48
48
  #
49
49
  # @see Knockapi::Models::Providers::MsTeamListChannelsParams
50
50
  def list_channels(channel_id, params)
51
- parsed, options = Knockapi::Models::Providers::MsTeamListChannelsParams.dump_request(params)
51
+ parsed, options = Knockapi::Providers::MsTeamListChannelsParams.dump_request(params)
52
52
  @client.request(
53
53
  method: :get,
54
54
  path: ["v1/providers/ms-teams/%1$s/channels", channel_id],
@@ -67,7 +67,7 @@ module Knockapi
67
67
  #
68
68
  # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
69
69
  #
70
- # @param query_options [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions]
70
+ # @param query_options [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions]
71
71
  #
72
72
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
73
73
  #
@@ -75,7 +75,7 @@ module Knockapi
75
75
  #
76
76
  # @see Knockapi::Models::Providers::MsTeamListTeamsParams
77
77
  def list_teams(channel_id, params)
78
- parsed, options = Knockapi::Models::Providers::MsTeamListTeamsParams.dump_request(params)
78
+ parsed, options = Knockapi::Providers::MsTeamListTeamsParams.dump_request(params)
79
79
  @client.request(
80
80
  method: :get,
81
81
  path: ["v1/providers/ms-teams/%1$s/teams", channel_id],
@@ -100,7 +100,7 @@ module Knockapi
100
100
  #
101
101
  # @see Knockapi::Models::Providers::MsTeamRevokeAccessParams
102
102
  def revoke_access(channel_id, params)
103
- parsed, options = Knockapi::Models::Providers::MsTeamRevokeAccessParams.dump_request(params)
103
+ parsed, options = Knockapi::Providers::MsTeamRevokeAccessParams.dump_request(params)
104
104
  @client.request(
105
105
  method: :put,
106
106
  path: ["v1/providers/ms-teams/%1$s/revoke_access", channel_id],
@@ -18,7 +18,7 @@ module Knockapi
18
18
  #
19
19
  # @see Knockapi::Models::Providers::SlackCheckAuthParams
20
20
  def check_auth(channel_id, params)
21
- parsed, options = Knockapi::Models::Providers::SlackCheckAuthParams.dump_request(params)
21
+ parsed, options = Knockapi::Providers::SlackCheckAuthParams.dump_request(params)
22
22
  @client.request(
23
23
  method: :get,
24
24
  path: ["v1/providers/slack/%1$s/auth_check", channel_id],
@@ -36,7 +36,7 @@ module Knockapi
36
36
  #
37
37
  # @param access_token_object [String] A JSON encoded string containing the access token object reference.
38
38
  #
39
- # @param query_options [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions]
39
+ # @param query_options [Knockapi::Providers::SlackListChannelsParams::QueryOptions]
40
40
  #
41
41
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
42
42
  #
@@ -44,7 +44,7 @@ module Knockapi
44
44
  #
45
45
  # @see Knockapi::Models::Providers::SlackListChannelsParams
46
46
  def list_channels(channel_id, params)
47
- parsed, options = Knockapi::Models::Providers::SlackListChannelsParams.dump_request(params)
47
+ parsed, options = Knockapi::Providers::SlackListChannelsParams.dump_request(params)
48
48
  @client.request(
49
49
  method: :get,
50
50
  path: ["v1/providers/slack/%1$s/channels", channel_id],
@@ -69,7 +69,7 @@ module Knockapi
69
69
  #
70
70
  # @see Knockapi::Models::Providers::SlackRevokeAccessParams
71
71
  def revoke_access(channel_id, params)
72
- parsed, options = Knockapi::Models::Providers::SlackRevokeAccessParams.dump_request(params)
72
+ parsed, options = Knockapi::Providers::SlackRevokeAccessParams.dump_request(params)
73
73
  @client.request(
74
74
  method: :put,
75
75
  path: ["v1/providers/slack/%1$s/revoke_access", channel_id],
@@ -10,20 +10,20 @@ module Knockapi
10
10
  #
11
11
  # @overload create(schedules:, request_options: {})
12
12
  #
13
- # @param schedules [Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>] A list of schedules.
13
+ # @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
14
14
  #
15
15
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
16
16
  #
17
- # @return [Knockapi::Models::BulkOperation]
17
+ # @return [Knockapi::BulkOperation]
18
18
  #
19
19
  # @see Knockapi::Models::Schedules::BulkCreateParams
20
20
  def create(params)
21
- parsed, options = Knockapi::Models::Schedules::BulkCreateParams.dump_request(params)
21
+ parsed, options = Knockapi::Schedules::BulkCreateParams.dump_request(params)
22
22
  @client.request(
23
23
  method: :post,
24
24
  path: "v1/schedules/bulk/create",
25
25
  body: parsed,
26
- model: Knockapi::Models::BulkOperation,
26
+ model: Knockapi::BulkOperation,
27
27
  options: options
28
28
  )
29
29
  end
@@ -6,9 +6,6 @@ module Knockapi
6
6
  # @return [Knockapi::Resources::Schedules::Bulk]
7
7
  attr_reader :bulk
8
8
 
9
- # Some parameter documentations has been truncated, see
10
- # {Knockapi::Models::ScheduleCreateParams} for more details.
11
- #
12
9
  # Creates one or more schedules for a workflow with the specified recipients,
13
10
  # timing, and data. Schedules can be one-time or recurring. This endpoint also
14
11
  # handles
@@ -17,10 +14,9 @@ module Knockapi
17
14
  #
18
15
  # @overload create(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
19
16
  #
20
- # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
21
- # ...
17
+ # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
22
18
  #
23
- # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
19
+ # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
24
20
  #
25
21
  # @param workflow [String] The key of the workflow.
26
22
  #
@@ -30,20 +26,20 @@ module Knockapi
30
26
  #
31
27
  # @param scheduled_at [Time, nil] The starting date and time for the schedule.
32
28
  #
33
- # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
29
+ # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
34
30
  #
35
31
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
36
32
  #
37
- # @return [Array<Knockapi::Models::Schedule>]
33
+ # @return [Array<Knockapi::Schedule>]
38
34
  #
39
35
  # @see Knockapi::Models::ScheduleCreateParams
40
36
  def create(params)
41
- parsed, options = Knockapi::Models::ScheduleCreateParams.dump_request(params)
37
+ parsed, options = Knockapi::ScheduleCreateParams.dump_request(params)
42
38
  @client.request(
43
39
  method: :post,
44
40
  path: "v1/schedules",
45
41
  body: parsed,
46
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule],
42
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
47
43
  options: options
48
44
  )
49
45
  end
@@ -61,31 +57,30 @@ module Knockapi
61
57
  #
62
58
  # @param schedule_ids [Array<String>] A list of schedule IDs.
63
59
  #
64
- # @param actor [String, Knockapi::Models::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
65
- # ...
60
+ # @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
66
61
  #
67
62
  # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
68
63
  #
69
64
  # @param ending_at [Time, nil] The ending date and time for the schedule.
70
65
  #
71
- # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
66
+ # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
72
67
  #
73
68
  # @param scheduled_at [Time, nil] The starting date and time for the schedule.
74
69
  #
75
- # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
70
+ # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
76
71
  #
77
72
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
78
73
  #
79
- # @return [Array<Knockapi::Models::Schedule>]
74
+ # @return [Array<Knockapi::Schedule>]
80
75
  #
81
76
  # @see Knockapi::Models::ScheduleUpdateParams
82
77
  def update(params)
83
- parsed, options = Knockapi::Models::ScheduleUpdateParams.dump_request(params)
78
+ parsed, options = Knockapi::ScheduleUpdateParams.dump_request(params)
84
79
  @client.request(
85
80
  method: :put,
86
81
  path: "v1/schedules",
87
82
  body: parsed,
88
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule],
83
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
89
84
  options: options
90
85
  )
91
86
  end
@@ -109,17 +104,17 @@ module Knockapi
109
104
  #
110
105
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
111
106
  #
112
- # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
107
+ # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
113
108
  #
114
109
  # @see Knockapi::Models::ScheduleListParams
115
110
  def list(params)
116
- parsed, options = Knockapi::Models::ScheduleListParams.dump_request(params)
111
+ parsed, options = Knockapi::ScheduleListParams.dump_request(params)
117
112
  @client.request(
118
113
  method: :get,
119
114
  path: "v1/schedules",
120
115
  query: parsed,
121
116
  page: Knockapi::Internal::EntriesCursor,
122
- model: Knockapi::Models::Schedule,
117
+ model: Knockapi::Schedule,
123
118
  options: options
124
119
  )
125
120
  end
@@ -133,16 +128,16 @@ module Knockapi
133
128
  #
134
129
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
135
130
  #
136
- # @return [Array<Knockapi::Models::Schedule>]
131
+ # @return [Array<Knockapi::Schedule>]
137
132
  #
138
133
  # @see Knockapi::Models::ScheduleDeleteParams
139
134
  def delete(params)
140
- parsed, options = Knockapi::Models::ScheduleDeleteParams.dump_request(params)
135
+ parsed, options = Knockapi::ScheduleDeleteParams.dump_request(params)
141
136
  @client.request(
142
137
  method: :delete,
143
138
  path: "v1/schedules",
144
139
  body: parsed,
145
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Schedule],
140
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
146
141
  options: options
147
142
  )
148
143
  end
@@ -12,16 +12,16 @@ module Knockapi
12
12
  #
13
13
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
14
14
  #
15
- # @return [Knockapi::Models::BulkOperation]
15
+ # @return [Knockapi::BulkOperation]
16
16
  #
17
17
  # @see Knockapi::Models::Tenants::BulkDeleteParams
18
18
  def delete(params)
19
- parsed, options = Knockapi::Models::Tenants::BulkDeleteParams.dump_request(params)
19
+ parsed, options = Knockapi::Tenants::BulkDeleteParams.dump_request(params)
20
20
  @client.request(
21
21
  method: :post,
22
22
  path: "v1/tenants/bulk/delete",
23
23
  query: parsed,
24
- model: Knockapi::Models::BulkOperation,
24
+ model: Knockapi::BulkOperation,
25
25
  options: options
26
26
  )
27
27
  end
@@ -30,20 +30,20 @@ module Knockapi
30
30
  #
31
31
  # @overload set(tenants:, request_options: {})
32
32
  #
33
- # @param tenants [Array<String, Knockapi::Models::TenantRequest>] The tenants to be upserted.
33
+ # @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
34
34
  #
35
35
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
36
36
  #
37
- # @return [Knockapi::Models::BulkOperation]
37
+ # @return [Knockapi::BulkOperation]
38
38
  #
39
39
  # @see Knockapi::Models::Tenants::BulkSetParams
40
40
  def set(params)
41
- parsed, options = Knockapi::Models::Tenants::BulkSetParams.dump_request(params)
41
+ parsed, options = Knockapi::Tenants::BulkSetParams.dump_request(params)
42
42
  @client.request(
43
43
  method: :post,
44
44
  path: "v1/tenants/bulk/set",
45
45
  body: parsed,
46
- model: Knockapi::Models::BulkOperation,
46
+ model: Knockapi::BulkOperation,
47
47
  options: options
48
48
  )
49
49
  end