knockapi 1.1.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (307) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +42 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/knockapi/internal/items_cursor.rb +2 -2
  6. data/lib/knockapi/internal/type/array_of.rb +8 -0
  7. data/lib/knockapi/internal/type/base_model.rb +7 -0
  8. data/lib/knockapi/internal/type/boolean.rb +8 -0
  9. data/lib/knockapi/internal/type/enum.rb +12 -0
  10. data/lib/knockapi/internal/type/file_input.rb +7 -0
  11. data/lib/knockapi/internal/type/hash_of.rb +8 -0
  12. data/lib/knockapi/internal/type/union.rb +12 -0
  13. data/lib/knockapi/internal/type/unknown.rb +8 -0
  14. data/lib/knockapi/internal/util.rb +54 -1
  15. data/lib/knockapi/internal.rb +3 -0
  16. data/lib/knockapi/models/activity.rb +4 -4
  17. data/lib/knockapi/models/audience_add_members_params.rb +5 -5
  18. data/lib/knockapi/models/audience_list_members_response.rb +4 -4
  19. data/lib/knockapi/models/audience_member.rb +4 -4
  20. data/lib/knockapi/models/audience_remove_members_params.rb +5 -5
  21. data/lib/knockapi/models/bulk_operation.rb +5 -5
  22. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +6 -6
  23. data/lib/knockapi/models/condition.rb +3 -3
  24. data/lib/knockapi/models/identify_user_request.rb +5 -5
  25. data/lib/knockapi/models/inline_identify_user_request.rb +5 -5
  26. data/lib/knockapi/models/inline_object_request.rb +4 -4
  27. data/lib/knockapi/models/inline_tenant_request.rb +1 -5
  28. data/lib/knockapi/models/message.rb +14 -14
  29. data/lib/knockapi/models/message_delivery_log.rb +13 -21
  30. data/lib/knockapi/models/message_event.rb +7 -7
  31. data/lib/knockapi/models/message_get_content_response.rb +0 -21
  32. data/lib/knockapi/models/message_list_params.rb +11 -8
  33. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  34. data/lib/knockapi/models/messages/batch_get_content_response.rb +0 -21
  35. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  36. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  37. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  38. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  39. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  40. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  41. data/lib/knockapi/models/object_add_subscriptions_params.rb +2 -2
  42. data/lib/knockapi/models/object_delete_subscriptions_params.rb +2 -2
  43. data/lib/knockapi/models/object_list_messages_params.rb +11 -8
  44. data/lib/knockapi/models/object_list_params.rb +2 -2
  45. data/lib/knockapi/models/object_list_subscriptions_params.rb +8 -8
  46. data/lib/knockapi/models/object_set_params.rb +4 -4
  47. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +6 -5
  48. data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
  49. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -3
  50. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -3
  51. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -3
  52. data/lib/knockapi/models/recipient.rb +1 -5
  53. data/lib/knockapi/models/recipient_reference.rb +1 -5
  54. data/lib/knockapi/models/recipient_request.rb +1 -5
  55. data/lib/knockapi/models/recipients/channel_data.rb +7 -19
  56. data/lib/knockapi/models/recipients/channel_data_request.rb +4 -16
  57. data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -15
  58. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -13
  59. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -15
  60. data/lib/knockapi/models/recipients/preference_set.rb +17 -35
  61. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
  62. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -48
  63. data/lib/knockapi/models/recipients/preference_set_request.rb +17 -35
  64. data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -15
  65. data/lib/knockapi/models/recipients/subscription.rb +4 -4
  66. data/lib/knockapi/models/schedule.rb +13 -10
  67. data/lib/knockapi/models/schedule_create_params.rb +14 -8
  68. data/lib/knockapi/models/schedule_repeat_rule.rb +5 -5
  69. data/lib/knockapi/models/schedule_update_params.rb +11 -8
  70. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -13
  71. data/lib/knockapi/models/tenant.rb +10 -10
  72. data/lib/knockapi/models/tenant_request.rb +13 -13
  73. data/lib/knockapi/models/tenant_set_params.rb +12 -12
  74. data/lib/knockapi/models/tenants/bulk_set_params.rb +2 -2
  75. data/lib/knockapi/models/user.rb +2 -2
  76. data/lib/knockapi/models/user_list_messages_params.rb +11 -8
  77. data/lib/knockapi/models/user_list_params.rb +2 -2
  78. data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
  79. data/lib/knockapi/models/users/bulk_identify_params.rb +2 -2
  80. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +2 -2
  81. data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
  82. data/lib/knockapi/models/users/feed_list_items_response.rb +4 -13
  83. data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
  84. data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
  85. data/lib/knockapi/models.rb +30 -19
  86. data/lib/knockapi/resources/audiences.rb +2 -2
  87. data/lib/knockapi/resources/bulk_operations.rb +1 -1
  88. data/lib/knockapi/resources/channels/bulk.rb +5 -5
  89. data/lib/knockapi/resources/messages/batch.rb +14 -14
  90. data/lib/knockapi/resources/messages.rb +18 -18
  91. data/lib/knockapi/resources/objects/bulk.rb +5 -5
  92. data/lib/knockapi/resources/objects.rb +30 -30
  93. data/lib/knockapi/resources/providers/ms_teams.rb +2 -2
  94. data/lib/knockapi/resources/providers/slack.rb +1 -1
  95. data/lib/knockapi/resources/schedules/bulk.rb +2 -2
  96. data/lib/knockapi/resources/schedules.rb +15 -12
  97. data/lib/knockapi/resources/tenants/bulk.rb +3 -3
  98. data/lib/knockapi/resources/tenants.rb +6 -6
  99. data/lib/knockapi/resources/users/bulk.rb +5 -5
  100. data/lib/knockapi/resources/users/feeds.rb +2 -2
  101. data/lib/knockapi/resources/users.rb +24 -24
  102. data/lib/knockapi/resources/workflows.rb +5 -5
  103. data/lib/knockapi/version.rb +1 -1
  104. data/lib/knockapi.rb +3 -1
  105. data/rbi/knockapi/internal/type/array_of.rbi +6 -0
  106. data/rbi/knockapi/internal/type/base_model.rbi +5 -0
  107. data/rbi/knockapi/internal/type/boolean.rbi +6 -0
  108. data/rbi/knockapi/internal/type/enum.rbi +5 -0
  109. data/rbi/knockapi/internal/type/file_input.rbi +5 -0
  110. data/rbi/knockapi/internal/type/hash_of.rbi +6 -0
  111. data/rbi/knockapi/internal/type/union.rbi +5 -0
  112. data/rbi/knockapi/internal/type/unknown.rbi +6 -0
  113. data/rbi/knockapi/internal/util.rbi +34 -0
  114. data/rbi/knockapi/internal.rbi +3 -0
  115. data/rbi/knockapi/models/activity.rbi +4 -4
  116. data/rbi/knockapi/models/message.rbi +4 -20
  117. data/rbi/knockapi/models/message_delivery_log.rbi +24 -8
  118. data/rbi/knockapi/models/message_event.rbi +2 -5
  119. data/rbi/knockapi/models/message_get_content_response.rbi +4 -25
  120. data/rbi/knockapi/models/message_list_params.rbi +19 -4
  121. data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
  122. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +4 -22
  123. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +1 -1
  124. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +1 -1
  125. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +1 -1
  126. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +1 -1
  127. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +1 -1
  128. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +1 -1
  129. data/rbi/knockapi/models/object_list_messages_params.rbi +19 -4
  130. data/rbi/knockapi/models/recipients/channel_data.rbi +2 -17
  131. data/rbi/knockapi/models/recipients/preference_set.rbi +4 -16
  132. data/rbi/knockapi/models/recipients/subscription.rbi +2 -2
  133. data/rbi/knockapi/models/schedule.rbi +12 -6
  134. data/rbi/knockapi/models/schedule_create_params.rbi +8 -2
  135. data/rbi/knockapi/models/schedule_update_params.rbi +8 -2
  136. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -2
  137. data/rbi/knockapi/models/user_list_messages_params.rbi +19 -4
  138. data/rbi/knockapi/models/users/feed_list_items_response.rbi +4 -10
  139. data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -2
  140. data/rbi/knockapi/resources/messages/batch.rbi +7 -7
  141. data/rbi/knockapi/resources/messages.rbi +3 -5
  142. data/rbi/knockapi/resources/objects.rbi +1 -1
  143. data/rbi/knockapi/resources/schedules.rbi +8 -2
  144. data/rbi/knockapi/resources/users.rbi +1 -1
  145. data/rbi/knockapi/resources/workflows.rbi +4 -1
  146. data/sig/knockapi/internal/entries_cursor.rbs +2 -0
  147. data/sig/knockapi/internal/items_cursor.rbs +2 -0
  148. data/sig/knockapi/internal/type/array_of.rbs +3 -0
  149. data/sig/knockapi/internal/type/base_model.rbs +2 -0
  150. data/sig/knockapi/internal/type/boolean.rbs +3 -0
  151. data/sig/knockapi/internal/type/enum.rbs +2 -0
  152. data/sig/knockapi/internal/type/file_input.rbs +2 -0
  153. data/sig/knockapi/internal/type/hash_of.rbs +3 -0
  154. data/sig/knockapi/internal/type/union.rbs +2 -0
  155. data/sig/knockapi/internal/type/unknown.rbs +3 -0
  156. data/sig/knockapi/internal/util.rbs +12 -0
  157. data/sig/knockapi/internal.rbs +2 -0
  158. data/sig/knockapi/models/activity.rbs +10 -0
  159. data/sig/knockapi/models/audience_add_members_params.rbs +12 -0
  160. data/sig/knockapi/models/audience_list_members_params.rbs +2 -0
  161. data/sig/knockapi/models/audience_list_members_response.rbs +5 -0
  162. data/sig/knockapi/models/audience_member.rbs +8 -0
  163. data/sig/knockapi/models/audience_remove_members_params.rbs +12 -0
  164. data/sig/knockapi/models/bulk_operation.rbs +24 -4
  165. data/sig/knockapi/models/bulk_operation_get_params.rbs +2 -0
  166. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +14 -0
  167. data/sig/knockapi/models/condition.rbs +10 -4
  168. data/sig/knockapi/models/identify_user_request.rbs +12 -0
  169. data/sig/knockapi/models/inline_identify_user_request.rbs +13 -0
  170. data/sig/knockapi/models/inline_object_request.rbs +8 -0
  171. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +8 -0
  172. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +2 -0
  173. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +8 -0
  174. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +2 -0
  175. data/sig/knockapi/models/message.rbs +44 -11
  176. data/sig/knockapi/models/message_archive_params.rbs +2 -0
  177. data/sig/knockapi/models/message_delivery_log.rbs +43 -18
  178. data/sig/knockapi/models/message_event.rbs +13 -4
  179. data/sig/knockapi/models/message_get_content_params.rbs +2 -0
  180. data/sig/knockapi/models/message_get_content_response.rbs +68 -0
  181. data/sig/knockapi/models/message_get_params.rbs +2 -0
  182. data/sig/knockapi/models/message_list_activities_params.rbs +8 -0
  183. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +7 -0
  184. data/sig/knockapi/models/message_list_events_params.rbs +7 -0
  185. data/sig/knockapi/models/message_list_params.rbs +45 -15
  186. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -0
  187. data/sig/knockapi/models/message_mark_as_read_params.rbs +2 -0
  188. data/sig/knockapi/models/message_mark_as_seen_params.rbs +2 -0
  189. data/sig/knockapi/models/message_mark_as_unread_params.rbs +2 -0
  190. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +2 -0
  191. data/sig/knockapi/models/message_unarchive_params.rbs +2 -0
  192. data/sig/knockapi/models/messages/batch_archive_params.rbs +5 -0
  193. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  194. data/sig/knockapi/models/messages/batch_get_content_params.rbs +5 -0
  195. data/sig/knockapi/models/messages/batch_get_content_response.rbs +72 -0
  196. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +6 -0
  197. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +2 -1
  198. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +5 -0
  199. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  200. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +5 -0
  201. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  202. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +5 -0
  203. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  204. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +5 -0
  205. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  206. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +5 -0
  207. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  208. data/sig/knockapi/models/object.rbs +9 -0
  209. data/sig/knockapi/models/object_add_subscriptions_params.rbs +6 -0
  210. data/sig/knockapi/models/object_delete_params.rbs +2 -0
  211. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +5 -0
  212. data/sig/knockapi/models/object_get_channel_data_params.rbs +2 -0
  213. data/sig/knockapi/models/object_get_params.rbs +2 -0
  214. data/sig/knockapi/models/object_get_preferences_params.rbs +2 -0
  215. data/sig/knockapi/models/object_list_messages_params.rbs +45 -15
  216. data/sig/knockapi/models/object_list_params.rbs +14 -6
  217. data/sig/knockapi/models/object_list_preferences_params.rbs +2 -0
  218. data/sig/knockapi/models/object_list_schedules_params.rbs +9 -0
  219. data/sig/knockapi/models/object_list_subscriptions_params.rbs +19 -6
  220. data/sig/knockapi/models/object_set_channel_data_params.rbs +2 -0
  221. data/sig/knockapi/models/object_set_params.rbs +8 -0
  222. data/sig/knockapi/models/object_set_preferences_params.rbs +2 -0
  223. data/sig/knockapi/models/object_unset_channel_data_params.rbs +2 -0
  224. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +10 -0
  225. data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -0
  226. data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
  227. data/sig/knockapi/models/page_info.rbs +7 -0
  228. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -0
  229. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +6 -0
  230. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +9 -0
  231. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +13 -0
  232. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +13 -0
  233. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +6 -0
  234. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -0
  235. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +2 -0
  236. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -0
  237. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +6 -0
  238. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +14 -0
  239. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +8 -0
  240. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -0
  241. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +2 -0
  242. data/sig/knockapi/models/recipient_reference.rbs +2 -0
  243. data/sig/knockapi/models/recipients/channel_data.rbs +17 -10
  244. data/sig/knockapi/models/recipients/channel_data_request.rbs +8 -4
  245. data/sig/knockapi/models/recipients/discord_channel_data.rbs +16 -4
  246. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +2 -2
  247. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +22 -4
  248. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +2 -0
  249. data/sig/knockapi/models/recipients/preference_set.rbs +25 -8
  250. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +2 -0
  251. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +45 -36
  252. data/sig/knockapi/models/recipients/preference_set_request.rbs +24 -8
  253. data/sig/knockapi/models/recipients/push_channel_data.rbs +2 -0
  254. data/sig/knockapi/models/recipients/slack_channel_data.rbs +19 -4
  255. data/sig/knockapi/models/recipients/subscription.rbs +9 -0
  256. data/sig/knockapi/models/schedule.rbs +15 -0
  257. data/sig/knockapi/models/schedule_create_params.rbs +11 -0
  258. data/sig/knockapi/models/schedule_delete_params.rbs +5 -0
  259. data/sig/knockapi/models/schedule_list_params.rbs +10 -0
  260. data/sig/knockapi/models/schedule_repeat_rule.rbs +18 -8
  261. data/sig/knockapi/models/schedule_update_params.rbs +11 -0
  262. data/sig/knockapi/models/schedules/bulk_create_params.rbs +16 -0
  263. data/sig/knockapi/models/tenant.rbs +19 -0
  264. data/sig/knockapi/models/tenant_delete_params.rbs +2 -0
  265. data/sig/knockapi/models/tenant_get_params.rbs +2 -0
  266. data/sig/knockapi/models/tenant_list_params.rbs +9 -0
  267. data/sig/knockapi/models/tenant_request.rbs +19 -0
  268. data/sig/knockapi/models/tenant_set_params.rbs +19 -0
  269. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +5 -0
  270. data/sig/knockapi/models/tenants/bulk_set_params.rbs +5 -0
  271. data/sig/knockapi/models/user.rbs +12 -0
  272. data/sig/knockapi/models/user_delete_params.rbs +2 -0
  273. data/sig/knockapi/models/user_get_channel_data_params.rbs +2 -0
  274. data/sig/knockapi/models/user_get_params.rbs +2 -0
  275. data/sig/knockapi/models/user_get_preferences_params.rbs +5 -0
  276. data/sig/knockapi/models/user_list_messages_params.rbs +45 -15
  277. data/sig/knockapi/models/user_list_params.rbs +14 -6
  278. data/sig/knockapi/models/user_list_preferences_params.rbs +2 -0
  279. data/sig/knockapi/models/user_list_schedules_params.rbs +9 -0
  280. data/sig/knockapi/models/user_list_subscriptions_params.rbs +15 -6
  281. data/sig/knockapi/models/user_merge_params.rbs +5 -0
  282. data/sig/knockapi/models/user_set_channel_data_params.rbs +2 -0
  283. data/sig/knockapi/models/user_set_preferences_params.rbs +2 -0
  284. data/sig/knockapi/models/user_unset_channel_data_params.rbs +2 -0
  285. data/sig/knockapi/models/user_update_params.rbs +2 -0
  286. data/sig/knockapi/models/users/bulk_delete_params.rbs +5 -0
  287. data/sig/knockapi/models/users/bulk_identify_params.rbs +5 -0
  288. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +6 -0
  289. data/sig/knockapi/models/users/feed_get_settings_params.rbs +2 -0
  290. data/sig/knockapi/models/users/feed_get_settings_response.rbs +6 -0
  291. data/sig/knockapi/models/users/feed_list_items_params.rbs +14 -0
  292. data/sig/knockapi/models/users/feed_list_items_response.rbs +43 -0
  293. data/sig/knockapi/models/users/guide_get_channel_params.rbs +7 -0
  294. data/sig/knockapi/models/users/guide_get_channel_response.rbs +14 -0
  295. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +13 -0
  296. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +2 -0
  297. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +13 -0
  298. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +2 -0
  299. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +13 -0
  300. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +2 -0
  301. data/sig/knockapi/models/workflow_cancel_params.rbs +6 -0
  302. data/sig/knockapi/models/workflow_trigger_params.rbs +9 -0
  303. data/sig/knockapi/models/workflow_trigger_response.rbs +2 -0
  304. data/sig/knockapi/resources/messages.rbs +5 -5
  305. data/sig/knockapi/resources/objects.rbs +7 -7
  306. data/sig/knockapi/resources/users.rbs +7 -7
  307. metadata +2 -2
@@ -3,24 +3,30 @@ module Knockapi
3
3
  module Recipients
4
4
  type preference_set_request =
5
5
  {
6
- categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
6
+ categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
7
7
  channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
8
- workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?
8
+ workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
9
9
  }
10
10
 
11
11
  class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
12
- attr_accessor categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?
12
+ attr_accessor categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?
13
13
 
14
14
  attr_accessor channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?
15
15
 
16
- attr_accessor workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?
16
+ attr_accessor workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
17
17
 
18
18
  def initialize: (
19
- ?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
19
+ ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
20
20
  ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
21
- ?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?
21
+ ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
22
22
  ) -> void
23
23
 
24
+ def to_hash: -> {
25
+ categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
26
+ channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
27
+ workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
28
+ }
29
+
24
30
  type category =
25
31
  bool
26
32
  | Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
@@ -43,9 +49,14 @@ module Knockapi
43
49
  ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
44
50
  ?conditions: ::Array[Knockapi::Condition]?
45
51
  ) -> void
52
+
53
+ def to_hash: -> {
54
+ channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
55
+ conditions: ::Array[Knockapi::Condition]?
56
+ }
46
57
  end
47
58
 
48
- def self?.variants: -> ::Array[Knockapi::Recipients::PreferenceSetRequest::category]
59
+ def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::category]
49
60
  end
50
61
 
51
62
  type workflow =
@@ -70,9 +81,14 @@ module Knockapi
70
81
  ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
71
82
  ?conditions: ::Array[Knockapi::Condition]?
72
83
  ) -> void
84
+
85
+ def to_hash: -> {
86
+ channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
87
+ conditions: ::Array[Knockapi::Condition]?
88
+ }
73
89
  end
74
90
 
75
- def self?.variants: -> ::Array[Knockapi::Recipients::PreferenceSetRequest::workflow]
91
+ def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::workflow]
76
92
  end
77
93
  end
78
94
  end
@@ -7,6 +7,8 @@ module Knockapi
7
7
  attr_accessor tokens: ::Array[String]
8
8
 
9
9
  def initialize: (tokens: ::Array[String]) -> void
10
+
11
+ def to_hash: -> { tokens: ::Array[String] }
10
12
  end
11
13
  end
12
14
  end
@@ -3,20 +3,25 @@ module Knockapi
3
3
  module Recipients
4
4
  type slack_channel_data =
5
5
  {
6
- connections: ::Array[Knockapi::Recipients::SlackChannelData::connection],
6
+ connections: ::Array[Knockapi::Models::Recipients::SlackChannelData::connection],
7
7
  token: Knockapi::Recipients::SlackChannelData::Token?
8
8
  }
9
9
 
10
10
  class SlackChannelData < Knockapi::Internal::Type::BaseModel
11
- attr_accessor connections: ::Array[Knockapi::Recipients::SlackChannelData::connection]
11
+ attr_accessor connections: ::Array[Knockapi::Models::Recipients::SlackChannelData::connection]
12
12
 
13
13
  attr_accessor token: Knockapi::Recipients::SlackChannelData::Token?
14
14
 
15
15
  def initialize: (
16
- connections: ::Array[Knockapi::Recipients::SlackChannelData::connection],
16
+ connections: ::Array[Knockapi::Models::Recipients::SlackChannelData::connection],
17
17
  ?token: Knockapi::Recipients::SlackChannelData::Token?
18
18
  ) -> void
19
19
 
20
+ def to_hash: -> {
21
+ connections: ::Array[Knockapi::Models::Recipients::SlackChannelData::connection],
22
+ token: Knockapi::Recipients::SlackChannelData::Token?
23
+ }
24
+
20
25
  type connection =
21
26
  Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection
22
27
  | Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
@@ -39,6 +44,12 @@ module Knockapi
39
44
  ?channel_id: String?,
40
45
  ?user_id: String?
41
46
  ) -> void
47
+
48
+ def to_hash: -> {
49
+ access_token: String?,
50
+ channel_id: String?,
51
+ user_id: String?
52
+ }
42
53
  end
43
54
 
44
55
  type slack_incoming_webhook_connection = { url: String }
@@ -47,9 +58,11 @@ module Knockapi
47
58
  attr_accessor url: String
48
59
 
49
60
  def initialize: (url: String) -> void
61
+
62
+ def to_hash: -> { url: String }
50
63
  end
51
64
 
52
- def self?.variants: -> ::Array[Knockapi::Recipients::SlackChannelData::connection]
65
+ def self?.variants: -> ::Array[Knockapi::Models::Recipients::SlackChannelData::connection]
53
66
  end
54
67
 
55
68
  type token = { access_token: String? }
@@ -58,6 +71,8 @@ module Knockapi
58
71
  attr_accessor access_token: String?
59
72
 
60
73
  def initialize: (access_token: String?) -> void
74
+
75
+ def to_hash: -> { access_token: String? }
61
76
  end
62
77
  end
63
78
  end
@@ -32,6 +32,15 @@ module Knockapi
32
32
  updated_at: Time,
33
33
  ?properties: ::Hash[Symbol, top]?
34
34
  ) -> void
35
+
36
+ def to_hash: -> {
37
+ _typename: String,
38
+ inserted_at: Time,
39
+ object: Knockapi::Object,
40
+ recipient: Knockapi::Models::recipient,
41
+ updated_at: Time,
42
+ properties: ::Hash[Symbol, top]?
43
+ }
35
44
  end
36
45
  end
37
46
  end
@@ -57,6 +57,21 @@ module Knockapi
57
57
  ?next_occurrence_at: Time?,
58
58
  ?tenant: String?
59
59
  ) -> void
60
+
61
+ def to_hash: -> {
62
+ id: String,
63
+ inserted_at: Time,
64
+ recipient: Knockapi::Models::recipient,
65
+ repeats: ::Array[Knockapi::ScheduleRepeatRule],
66
+ updated_at: Time,
67
+ workflow: String,
68
+ _typename: String,
69
+ actor: Knockapi::Models::recipient?,
70
+ data: ::Hash[Symbol, top]?,
71
+ last_occurrence_at: Time?,
72
+ next_occurrence_at: Time?,
73
+ tenant: String?
74
+ }
60
75
  end
61
76
  end
62
77
  end
@@ -40,6 +40,17 @@ module Knockapi
40
40
  ?tenant: Knockapi::Models::inline_tenant_request?,
41
41
  ?request_options: Knockapi::request_opts
42
42
  ) -> void
43
+
44
+ def to_hash: -> {
45
+ recipients: ::Array[Knockapi::Models::recipient_request],
46
+ repeats: ::Array[Knockapi::ScheduleRepeatRule],
47
+ workflow: String,
48
+ data: ::Hash[Symbol, top]?,
49
+ ending_at: Time?,
50
+ scheduled_at: Time?,
51
+ tenant: Knockapi::Models::inline_tenant_request?,
52
+ request_options: Knockapi::RequestOptions
53
+ }
43
54
  end
44
55
  end
45
56
  end
@@ -14,6 +14,11 @@ module Knockapi
14
14
  schedule_ids: ::Array[String],
15
15
  ?request_options: Knockapi::request_opts
16
16
  ) -> void
17
+
18
+ def to_hash: -> {
19
+ schedule_ids: ::Array[String],
20
+ request_options: Knockapi::RequestOptions
21
+ }
17
22
  end
18
23
  end
19
24
  end
@@ -46,6 +46,16 @@ module Knockapi
46
46
  ?tenant: String,
47
47
  ?request_options: Knockapi::request_opts
48
48
  ) -> void
49
+
50
+ def to_hash: -> {
51
+ workflow: String,
52
+ after: String,
53
+ before: String,
54
+ page_size: Integer,
55
+ recipients: ::Array[String],
56
+ tenant: String,
57
+ request_options: Knockapi::RequestOptions
58
+ }
49
59
  end
50
60
  end
51
61
  end
@@ -3,9 +3,9 @@ module Knockapi
3
3
  type schedule_repeat_rule =
4
4
  {
5
5
  _typename: String,
6
- frequency: Knockapi::ScheduleRepeatRule::frequency,
6
+ frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
7
7
  day_of_month: Integer?,
8
- days: ::Array[Knockapi::ScheduleRepeatRule::day]?,
8
+ days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
9
9
  hours: Integer?,
10
10
  interval: Integer,
11
11
  minutes: Integer?
@@ -14,11 +14,11 @@ module Knockapi
14
14
  class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
15
15
  attr_accessor _typename: String
16
16
 
17
- attr_accessor frequency: Knockapi::ScheduleRepeatRule::frequency
17
+ attr_accessor frequency: Knockapi::Models::ScheduleRepeatRule::frequency
18
18
 
19
19
  attr_accessor day_of_month: Integer?
20
20
 
21
- attr_accessor days: ::Array[Knockapi::ScheduleRepeatRule::day]?
21
+ attr_accessor days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?
22
22
 
23
23
  attr_accessor hours: Integer?
24
24
 
@@ -30,14 +30,24 @@ module Knockapi
30
30
 
31
31
  def initialize: (
32
32
  _typename: String,
33
- frequency: Knockapi::ScheduleRepeatRule::frequency,
33
+ frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
34
34
  ?day_of_month: Integer?,
35
- ?days: ::Array[Knockapi::ScheduleRepeatRule::day]?,
35
+ ?days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
36
36
  ?hours: Integer?,
37
37
  ?interval: Integer,
38
38
  ?minutes: Integer?
39
39
  ) -> void
40
40
 
41
+ def to_hash: -> {
42
+ _typename: String,
43
+ frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
44
+ day_of_month: Integer?,
45
+ days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
46
+ hours: Integer?,
47
+ interval: Integer,
48
+ minutes: Integer?
49
+ }
50
+
41
51
  type frequency = :daily | :weekly | :monthly | :hourly
42
52
 
43
53
  module Frequency
@@ -48,7 +58,7 @@ module Knockapi
48
58
  MONTHLY: :monthly
49
59
  HOURLY: :hourly
50
60
 
51
- def self?.values: -> ::Array[Knockapi::ScheduleRepeatRule::frequency]
61
+ def self?.values: -> ::Array[Knockapi::Models::ScheduleRepeatRule::frequency]
52
62
  end
53
63
 
54
64
  type day = :mon | :tue | :wed | :thu | :fri | :sat | :sun
@@ -64,7 +74,7 @@ module Knockapi
64
74
  SAT: :sat
65
75
  SUN: :sun
66
76
 
67
- def self?.values: -> ::Array[Knockapi::ScheduleRepeatRule::day]
77
+ def self?.values: -> ::Array[Knockapi::Models::ScheduleRepeatRule::day]
68
78
  end
69
79
  end
70
80
  end
@@ -44,6 +44,17 @@ module Knockapi
44
44
  ?tenant: Knockapi::Models::inline_tenant_request?,
45
45
  ?request_options: Knockapi::request_opts
46
46
  ) -> void
47
+
48
+ def to_hash: -> {
49
+ schedule_ids: ::Array[String],
50
+ actor: Knockapi::Models::recipient_reference?,
51
+ data: ::Hash[Symbol, top]?,
52
+ ending_at: Time?,
53
+ repeats: ::Array[Knockapi::ScheduleRepeatRule],
54
+ scheduled_at: Time?,
55
+ tenant: Knockapi::Models::inline_tenant_request?,
56
+ request_options: Knockapi::RequestOptions
57
+ }
47
58
  end
48
59
  end
49
60
  end
@@ -16,6 +16,11 @@ module Knockapi
16
16
  ?request_options: Knockapi::request_opts
17
17
  ) -> void
18
18
 
19
+ def to_hash: -> {
20
+ schedules: ::Array[Knockapi::Schedules::BulkCreateParams::Schedule],
21
+ request_options: Knockapi::RequestOptions
22
+ }
23
+
19
24
  type schedule =
20
25
  {
21
26
  workflow: String,
@@ -63,6 +68,17 @@ module Knockapi
63
68
  ?scheduled_at: Time?,
64
69
  ?tenant: Knockapi::Models::inline_tenant_request?
65
70
  ) -> void
71
+
72
+ def to_hash: -> {
73
+ workflow: String,
74
+ actor: Knockapi::Models::recipient_request?,
75
+ data: ::Hash[Symbol, top]?,
76
+ ending_at: Time?,
77
+ recipient: Knockapi::Models::recipient_request,
78
+ repeats: ::Array[Knockapi::ScheduleRepeatRule],
79
+ scheduled_at: Time?,
80
+ tenant: Knockapi::Models::inline_tenant_request?
81
+ }
66
82
  end
67
83
  end
68
84
  end
@@ -24,6 +24,13 @@ module Knockapi
24
24
  ?settings: Knockapi::Tenant::Settings?
25
25
  ) -> void
26
26
 
27
+ def to_hash: -> {
28
+ id: String,
29
+ _typename: String,
30
+ name: String?,
31
+ settings: Knockapi::Tenant::Settings?
32
+ }
33
+
27
34
  type settings =
28
35
  {
29
36
  branding: Knockapi::Tenant::Settings::Branding?,
@@ -40,6 +47,11 @@ module Knockapi
40
47
  ?preference_set: Knockapi::Recipients::PreferenceSet?
41
48
  ) -> void
42
49
 
50
+ def to_hash: -> {
51
+ branding: Knockapi::Tenant::Settings::Branding?,
52
+ preference_set: Knockapi::Recipients::PreferenceSet?
53
+ }
54
+
43
55
  type branding =
44
56
  {
45
57
  icon_url: String?,
@@ -63,6 +75,13 @@ module Knockapi
63
75
  ?primary_color: String?,
64
76
  ?primary_color_contrast: String?
65
77
  ) -> void
78
+
79
+ def to_hash: -> {
80
+ icon_url: String?,
81
+ logo_url: String?,
82
+ primary_color: String?,
83
+ primary_color_contrast: String?
84
+ }
66
85
  end
67
86
  end
68
87
  end
@@ -8,6 +8,8 @@ module Knockapi
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
10
  def initialize: (?request_options: Knockapi::request_opts) -> void
11
+
12
+ def to_hash: -> { request_options: Knockapi::RequestOptions }
11
13
  end
12
14
  end
13
15
  end
@@ -7,6 +7,8 @@ module Knockapi
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
9
  def initialize: (?request_options: Knockapi::request_opts) -> void
10
+
11
+ def to_hash: -> { request_options: Knockapi::RequestOptions }
10
12
  end
11
13
  end
12
14
  end
@@ -42,6 +42,15 @@ module Knockapi
42
42
  ?tenant_id: String,
43
43
  ?request_options: Knockapi::request_opts
44
44
  ) -> void
45
+
46
+ def to_hash: -> {
47
+ after: String,
48
+ before: String,
49
+ name: String,
50
+ page_size: Integer,
51
+ tenant_id: String,
52
+ request_options: Knockapi::RequestOptions
53
+ }
45
54
  end
46
55
  end
47
56
  end
@@ -28,6 +28,13 @@ module Knockapi
28
28
  ?settings: Knockapi::TenantRequest::Settings
29
29
  ) -> void
30
30
 
31
+ def to_hash: -> {
32
+ id: String,
33
+ channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
34
+ preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
35
+ settings: Knockapi::TenantRequest::Settings
36
+ }
37
+
31
38
  type settings =
32
39
  {
33
40
  branding: Knockapi::TenantRequest::Settings::Branding,
@@ -48,6 +55,11 @@ module Knockapi
48
55
  ?preference_set: Knockapi::Recipients::PreferenceSetRequest?
49
56
  ) -> void
50
57
 
58
+ def to_hash: -> {
59
+ branding: Knockapi::TenantRequest::Settings::Branding,
60
+ preference_set: Knockapi::Recipients::PreferenceSetRequest?
61
+ }
62
+
51
63
  type branding =
52
64
  {
53
65
  icon_url: String?,
@@ -71,6 +83,13 @@ module Knockapi
71
83
  ?primary_color: String?,
72
84
  ?primary_color_contrast: String?
73
85
  ) -> void
86
+
87
+ def to_hash: -> {
88
+ icon_url: String?,
89
+ logo_url: String?,
90
+ primary_color: String?,
91
+ primary_color_contrast: String?
92
+ }
74
93
  end
75
94
  end
76
95
  end
@@ -29,6 +29,13 @@ module Knockapi
29
29
  ?request_options: Knockapi::request_opts
30
30
  ) -> void
31
31
 
32
+ def to_hash: -> {
33
+ channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
34
+ preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
35
+ settings: Knockapi::TenantSetParams::Settings,
36
+ request_options: Knockapi::RequestOptions
37
+ }
38
+
32
39
  type settings =
33
40
  {
34
41
  branding: Knockapi::TenantSetParams::Settings::Branding,
@@ -49,6 +56,11 @@ module Knockapi
49
56
  ?preference_set: Knockapi::Recipients::PreferenceSetRequest?
50
57
  ) -> void
51
58
 
59
+ def to_hash: -> {
60
+ branding: Knockapi::TenantSetParams::Settings::Branding,
61
+ preference_set: Knockapi::Recipients::PreferenceSetRequest?
62
+ }
63
+
52
64
  type branding =
53
65
  {
54
66
  icon_url: String?,
@@ -72,6 +84,13 @@ module Knockapi
72
84
  ?primary_color: String?,
73
85
  ?primary_color_contrast: String?
74
86
  ) -> void
87
+
88
+ def to_hash: -> {
89
+ icon_url: String?,
90
+ logo_url: String?,
91
+ primary_color: String?,
92
+ primary_color_contrast: String?
93
+ }
75
94
  end
76
95
  end
77
96
  end
@@ -15,6 +15,11 @@ module Knockapi
15
15
  tenant_ids: ::Array[String],
16
16
  ?request_options: Knockapi::request_opts
17
17
  ) -> void
18
+
19
+ def to_hash: -> {
20
+ tenant_ids: ::Array[String],
21
+ request_options: Knockapi::RequestOptions
22
+ }
18
23
  end
19
24
  end
20
25
  end
@@ -15,6 +15,11 @@ module Knockapi
15
15
  tenants: ::Array[Knockapi::Models::inline_tenant_request],
16
16
  ?request_options: Knockapi::request_opts
17
17
  ) -> void
18
+
19
+ def to_hash: -> {
20
+ tenants: ::Array[Knockapi::Models::inline_tenant_request],
21
+ request_options: Knockapi::RequestOptions
22
+ }
18
23
  end
19
24
  end
20
25
  end
@@ -43,6 +43,18 @@ module Knockapi
43
43
  ?phone_number: String?,
44
44
  ?timezone: String?
45
45
  ) -> void
46
+
47
+ def to_hash: -> {
48
+ id: String,
49
+ _typename: String,
50
+ updated_at: Time,
51
+ avatar: String?,
52
+ created_at: Time?,
53
+ email: String?,
54
+ name: String?,
55
+ phone_number: String?,
56
+ timezone: String?
57
+ }
46
58
  end
47
59
  end
48
60
  end
@@ -8,6 +8,8 @@ module Knockapi
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
10
  def initialize: (?request_options: Knockapi::request_opts) -> void
11
+
12
+ def to_hash: -> { request_options: Knockapi::RequestOptions }
11
13
  end
12
14
  end
13
15
  end
@@ -8,6 +8,8 @@ module Knockapi
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
10
  def initialize: (?request_options: Knockapi::request_opts) -> void
11
+
12
+ def to_hash: -> { request_options: Knockapi::RequestOptions }
11
13
  end
12
14
  end
13
15
  end
@@ -7,6 +7,8 @@ module Knockapi
7
7
  include Knockapi::Internal::Type::RequestParameters
8
8
 
9
9
  def initialize: (?request_options: Knockapi::request_opts) -> void
10
+
11
+ def to_hash: -> { request_options: Knockapi::RequestOptions }
10
12
  end
11
13
  end
12
14
  end
@@ -15,6 +15,11 @@ module Knockapi
15
15
  ?tenant: String,
16
16
  ?request_options: Knockapi::request_opts
17
17
  ) -> void
18
+
19
+ def to_hash: -> {
20
+ tenant: String,
21
+ request_options: Knockapi::RequestOptions
22
+ }
18
23
  end
19
24
  end
20
25
  end