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
@@ -14,7 +14,7 @@ module Knockapi
14
14
  # An object where the key is the category and the values are the preference
15
15
  # settings for that category.
16
16
  #
17
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
17
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
18
18
  optional :categories,
19
19
  -> {
20
20
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Category]
@@ -24,14 +24,14 @@ module Knockapi
24
24
  # @!attribute channel_types
25
25
  # Channel type preferences.
26
26
  #
27
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
27
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
28
28
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
29
29
 
30
30
  # @!attribute workflows
31
31
  # An object where the key is the workflow key and the values are the preference
32
32
  # settings for that workflow.
33
33
  #
34
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
34
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
35
35
  optional :workflows,
36
36
  -> {
37
37
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Workflow]
@@ -40,18 +40,18 @@ module Knockapi
40
40
 
41
41
  # @!method initialize(id:, categories: nil, channel_types: nil, workflows: nil)
42
42
  # Some parameter documentations has been truncated, see
43
- # {Knockapi::Recipients::PreferenceSet} for more details.
43
+ # {Knockapi::Models::Recipients::PreferenceSet} for more details.
44
44
  #
45
45
  # A preference set represents a specific set of notification preferences for a
46
46
  # recipient. A recipient can have multiple preference sets.
47
47
  #
48
48
  # @param id [String] Unique identifier for the preference set.
49
49
  #
50
- # @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
50
+ # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
51
51
  #
52
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
52
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
53
53
  #
54
- # @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
54
+ # @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
55
55
 
56
56
  # Workflow or category preferences within a preference set
57
57
  module Category
@@ -68,35 +68,26 @@ module Knockapi
68
68
  # @!attribute channel_types
69
69
  # Channel type preferences.
70
70
  #
71
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
71
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
72
72
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
73
73
 
74
74
  # @!attribute conditions
75
75
  # A list of conditions to apply to a channel type.
76
76
  #
77
- # @return [Array<Knockapi::Condition>, nil]
77
+ # @return [Array<Knockapi::Models::Condition>, nil]
78
78
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
79
79
 
80
80
  # @!method initialize(channel_types: nil, conditions: nil)
81
81
  # The settings object for a workflow or category, where you can specify channel
82
82
  # types or conditions.
83
83
  #
84
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
84
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
85
85
  #
86
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
86
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
87
87
  end
88
88
 
89
89
  # @!method self.variants
90
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
91
-
92
- define_sorbet_constant!(:Variants) do
93
- T.type_alias do
94
- T.any(
95
- T::Boolean,
96
- Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
97
- )
98
- end
99
- end
90
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
100
91
  end
101
92
 
102
93
  # Workflow or category preferences within a preference set
@@ -114,35 +105,26 @@ module Knockapi
114
105
  # @!attribute channel_types
115
106
  # Channel type preferences.
116
107
  #
117
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
108
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
118
109
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
119
110
 
120
111
  # @!attribute conditions
121
112
  # A list of conditions to apply to a channel type.
122
113
  #
123
- # @return [Array<Knockapi::Condition>, nil]
114
+ # @return [Array<Knockapi::Models::Condition>, nil]
124
115
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
125
116
 
126
117
  # @!method initialize(channel_types: nil, conditions: nil)
127
118
  # The settings object for a workflow or category, where you can specify channel
128
119
  # types or conditions.
129
120
  #
130
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
121
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
131
122
  #
132
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
123
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
133
124
  end
134
125
 
135
126
  # @!method self.variants
136
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
137
-
138
- define_sorbet_constant!(:Variants) do
139
- T.type_alias do
140
- T.any(
141
- T::Boolean,
142
- Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
143
- )
144
- end
145
- end
127
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
146
128
  end
147
129
  end
148
130
  end
@@ -7,14 +7,14 @@ module Knockapi
7
7
  # @!attribute conditions
8
8
  # A list of conditions to apply to a channel type.
9
9
  #
10
- # @return [Array<Knockapi::Condition>]
10
+ # @return [Array<Knockapi::Models::Condition>]
11
11
  required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
12
12
 
13
13
  # @!method initialize(conditions:)
14
14
  # A set of settings for a channel type. Currently, this can only be a list of
15
15
  # conditions to apply.
16
16
  #
17
- # @param conditions [Array<Knockapi::Condition>] A list of conditions to apply to a channel type.
17
+ # @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a channel type.
18
18
  end
19
19
  end
20
20
  end
@@ -7,57 +7,57 @@ module Knockapi
7
7
  # @!attribute chat
8
8
  # Whether the channel type is enabled for the preference set.
9
9
  #
10
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
10
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
11
11
  optional :chat, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Chat }
12
12
 
13
13
  # @!attribute email
14
14
  # Whether the channel type is enabled for the preference set.
15
15
  #
16
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
16
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
17
17
  optional :email, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Email }
18
18
 
19
19
  # @!attribute http
20
20
  # Whether the channel type is enabled for the preference set.
21
21
  #
22
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
22
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
23
23
  optional :http, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::HTTP }
24
24
 
25
25
  # @!attribute in_app_feed
26
26
  # Whether the channel type is enabled for the preference set.
27
27
  #
28
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
28
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
29
29
  optional :in_app_feed, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::InAppFeed }
30
30
 
31
31
  # @!attribute push
32
32
  # Whether the channel type is enabled for the preference set.
33
33
  #
34
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
34
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
35
35
  optional :push, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Push }
36
36
 
37
37
  # @!attribute sms
38
38
  # Whether the channel type is enabled for the preference set.
39
39
  #
40
- # @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
40
+ # @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
41
41
  optional :sms, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::SMS }
42
42
 
43
43
  # @!method initialize(chat: nil, email: nil, http: nil, in_app_feed: nil, push: nil, sms: nil)
44
44
  # Channel type preferences.
45
45
  #
46
- # @param chat [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
46
+ # @param chat [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
47
47
  #
48
- # @param email [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
48
+ # @param email [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
49
49
  #
50
- # @param http [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
50
+ # @param http [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
51
51
  #
52
- # @param in_app_feed [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
52
+ # @param in_app_feed [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
53
53
  #
54
- # @param push [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
54
+ # @param push [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
55
55
  #
56
- # @param sms [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
56
+ # @param sms [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
57
57
 
58
58
  # Whether the channel type is enabled for the preference set.
59
59
  #
60
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#chat
60
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#chat
61
61
  module Chat
62
62
  extend Knockapi::Internal::Type::Union
63
63
 
@@ -67,16 +67,12 @@ module Knockapi
67
67
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
68
68
 
69
69
  # @!method self.variants
70
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
71
-
72
- define_sorbet_constant!(:Variants) do
73
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
74
- end
70
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
75
71
  end
76
72
 
77
73
  # Whether the channel type is enabled for the preference set.
78
74
  #
79
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#email
75
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#email
80
76
  module Email
81
77
  extend Knockapi::Internal::Type::Union
82
78
 
@@ -86,16 +82,12 @@ module Knockapi
86
82
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
87
83
 
88
84
  # @!method self.variants
89
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
90
-
91
- define_sorbet_constant!(:Variants) do
92
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
93
- end
85
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
94
86
  end
95
87
 
96
88
  # Whether the channel type is enabled for the preference set.
97
89
  #
98
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#http
90
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#http
99
91
  module HTTP
100
92
  extend Knockapi::Internal::Type::Union
101
93
 
@@ -105,16 +97,12 @@ module Knockapi
105
97
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
106
98
 
107
99
  # @!method self.variants
108
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
109
-
110
- define_sorbet_constant!(:Variants) do
111
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
112
- end
100
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
113
101
  end
114
102
 
115
103
  # Whether the channel type is enabled for the preference set.
116
104
  #
117
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#in_app_feed
105
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#in_app_feed
118
106
  module InAppFeed
119
107
  extend Knockapi::Internal::Type::Union
120
108
 
@@ -124,16 +112,12 @@ module Knockapi
124
112
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
125
113
 
126
114
  # @!method self.variants
127
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
128
-
129
- define_sorbet_constant!(:Variants) do
130
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
131
- end
115
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
132
116
  end
133
117
 
134
118
  # Whether the channel type is enabled for the preference set.
135
119
  #
136
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#push
120
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#push
137
121
  module Push
138
122
  extend Knockapi::Internal::Type::Union
139
123
 
@@ -143,16 +127,12 @@ module Knockapi
143
127
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
144
128
 
145
129
  # @!method self.variants
146
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
147
-
148
- define_sorbet_constant!(:Variants) do
149
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
150
- end
130
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
151
131
  end
152
132
 
153
133
  # Whether the channel type is enabled for the preference set.
154
134
  #
155
- # @see Knockapi::Recipients::PreferenceSetChannelTypes#sms
135
+ # @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#sms
156
136
  module SMS
157
137
  extend Knockapi::Internal::Type::Union
158
138
 
@@ -162,11 +142,7 @@ module Knockapi
162
142
  variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
163
143
 
164
144
  # @!method self.variants
165
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
166
-
167
- define_sorbet_constant!(:Variants) do
168
- T.type_alias { T.any(T::Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting) }
169
- end
145
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
170
146
  end
171
147
  end
172
148
  end
@@ -8,7 +8,7 @@ module Knockapi
8
8
  # An object where the key is the category and the values are the preference
9
9
  # settings for that category.
10
10
  #
11
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
11
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
12
12
  optional :categories,
13
13
  -> {
14
14
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Category]
@@ -18,14 +18,14 @@ module Knockapi
18
18
  # @!attribute channel_types
19
19
  # Channel type preferences.
20
20
  #
21
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
21
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
22
22
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
23
23
 
24
24
  # @!attribute workflows
25
25
  # An object where the key is the workflow key and the values are the preference
26
26
  # settings for that workflow.
27
27
  #
28
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
28
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
29
29
  optional :workflows,
30
30
  -> {
31
31
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Workflow]
@@ -34,15 +34,15 @@ module Knockapi
34
34
 
35
35
  # @!method initialize(categories: nil, channel_types: nil, workflows: nil)
36
36
  # Some parameter documentations has been truncated, see
37
- # {Knockapi::Recipients::PreferenceSetRequest} for more details.
37
+ # {Knockapi::Models::Recipients::PreferenceSetRequest} for more details.
38
38
  #
39
39
  # A request to set a preference set for a recipient.
40
40
  #
41
- # @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
41
+ # @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
42
42
  #
43
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
43
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
44
44
  #
45
- # @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
45
+ # @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
46
46
 
47
47
  # Workflow or category preferences within a preference set
48
48
  module Category
@@ -59,35 +59,26 @@ module Knockapi
59
59
  # @!attribute channel_types
60
60
  # Channel type preferences.
61
61
  #
62
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
62
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
63
63
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
64
64
 
65
65
  # @!attribute conditions
66
66
  # A list of conditions to apply to a channel type.
67
67
  #
68
- # @return [Array<Knockapi::Condition>, nil]
68
+ # @return [Array<Knockapi::Models::Condition>, nil]
69
69
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
70
70
 
71
71
  # @!method initialize(channel_types: nil, conditions: nil)
72
72
  # The settings object for a workflow or category, where you can specify channel
73
73
  # types or conditions.
74
74
  #
75
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
75
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
76
76
  #
77
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
77
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
78
78
  end
79
79
 
80
80
  # @!method self.variants
81
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
82
-
83
- define_sorbet_constant!(:Variants) do
84
- T.type_alias do
85
- T.any(
86
- T::Boolean,
87
- Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
88
- )
89
- end
90
- end
81
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
91
82
  end
92
83
 
93
84
  # Workflow or category preferences within a preference set
@@ -105,35 +96,26 @@ module Knockapi
105
96
  # @!attribute channel_types
106
97
  # Channel type preferences.
107
98
  #
108
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
99
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
109
100
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
110
101
 
111
102
  # @!attribute conditions
112
103
  # A list of conditions to apply to a channel type.
113
104
  #
114
- # @return [Array<Knockapi::Condition>, nil]
105
+ # @return [Array<Knockapi::Models::Condition>, nil]
115
106
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
116
107
 
117
108
  # @!method initialize(channel_types: nil, conditions: nil)
118
109
  # The settings object for a workflow or category, where you can specify channel
119
110
  # types or conditions.
120
111
  #
121
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
112
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
122
113
  #
123
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
114
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
124
115
  end
125
116
 
126
117
  # @!method self.variants
127
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
128
-
129
- define_sorbet_constant!(:Variants) do
130
- T.type_alias do
131
- T.any(
132
- T::Boolean,
133
- Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
134
- )
135
- end
136
- end
118
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
137
119
  end
138
120
  end
139
121
  end
@@ -7,7 +7,7 @@ module Knockapi
7
7
  # @!attribute connections
8
8
  # List of Slack channel connections.
9
9
  #
10
- # @return [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
10
+ # @return [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
11
11
  required :connections,
12
12
  -> {
13
13
  Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::SlackChannelData::Connection]
@@ -16,15 +16,15 @@ module Knockapi
16
16
  # @!attribute token
17
17
  # A Slack connection token.
18
18
  #
19
- # @return [Knockapi::Recipients::SlackChannelData::Token, nil]
19
+ # @return [Knockapi::Models::Recipients::SlackChannelData::Token, nil]
20
20
  optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
21
21
 
22
22
  # @!method initialize(connections:, token: nil)
23
23
  # Slack channel data
24
24
  #
25
- # @param connections [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
25
+ # @param connections [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
26
26
  #
27
- # @param token [Knockapi::Recipients::SlackChannelData::Token, nil] A Slack connection token.
27
+ # @param token [Knockapi::Models::Recipients::SlackChannelData::Token, nil] A Slack connection token.
28
28
 
29
29
  # A Slack connection, either an access token or an incoming webhook
30
30
  module Connection
@@ -79,19 +79,10 @@ module Knockapi
79
79
  end
80
80
 
81
81
  # @!method self.variants
82
- # @return [Array(Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
83
-
84
- define_sorbet_constant!(:Variants) do
85
- T.type_alias do
86
- T.any(
87
- Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
88
- Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
89
- )
90
- end
91
- end
82
+ # @return [Array(Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
92
83
  end
93
84
 
94
- # @see Knockapi::Recipients::SlackChannelData#token
85
+ # @see Knockapi::Models::Recipients::SlackChannelData#token
95
86
  class Token < Knockapi::Internal::Type::BaseModel
96
87
  # @!attribute access_token
97
88
  # A Slack access token.
@@ -19,13 +19,13 @@ module Knockapi
19
19
  # @!attribute object
20
20
  # A custom [Object](/concepts/objects) entity which belongs to a collection.
21
21
  #
22
- # @return [Knockapi::Object]
22
+ # @return [Knockapi::Models::Object]
23
23
  required :object, -> { Knockapi::Object }
24
24
 
25
25
  # @!attribute recipient
26
26
  # A recipient of a notification, which is either a user or an object.
27
27
  #
28
- # @return [Knockapi::User, Knockapi::Object]
28
+ # @return [Knockapi::Models::User, Knockapi::Models::Object]
29
29
  required :recipient, union: -> { Knockapi::Recipient }
30
30
 
31
31
  # @!attribute updated_at
@@ -47,9 +47,9 @@ module Knockapi
47
47
  #
48
48
  # @param inserted_at [Time] Timestamp when the resource was created.
49
49
  #
50
- # @param object [Knockapi::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
50
+ # @param object [Knockapi::Models::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
51
51
  #
52
- # @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
52
+ # @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
53
53
  #
54
54
  # @param updated_at [Time] The timestamp when the resource was last updated.
55
55
  #
@@ -19,13 +19,13 @@ module Knockapi
19
19
  # @!attribute recipient
20
20
  # A recipient of a notification, which is either a user or an object.
21
21
  #
22
- # @return [Knockapi::User, Knockapi::Object]
22
+ # @return [Knockapi::Models::User, Knockapi::Models::Object]
23
23
  required :recipient, union: -> { Knockapi::Recipient }
24
24
 
25
25
  # @!attribute repeats
26
26
  # The repeat rule for the schedule.
27
27
  #
28
- # @return [Array<Knockapi::ScheduleRepeatRule>]
28
+ # @return [Array<Knockapi::Models::ScheduleRepeatRule>]
29
29
  required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
30
30
 
31
31
  # @!attribute updated_at
@@ -49,11 +49,14 @@ module Knockapi
49
49
  # @!attribute actor
50
50
  # A recipient of a notification, which is either a user or an object.
51
51
  #
52
- # @return [Knockapi::User, Knockapi::Object, nil]
52
+ # @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
53
53
  optional :actor, union: -> { Knockapi::Recipient }, nil?: true
54
54
 
55
55
  # @!attribute data
56
- # An optional map of data to pass into the workflow execution.
56
+ # An optional map of data to pass into the workflow execution. There is a 1024
57
+ # byte limit on the size of any single string value (with the exception of
58
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
59
+ # size of the full `data` payload.
57
60
  #
58
61
  # @return [Hash{Symbol=>Object}, nil]
59
62
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -79,8 +82,8 @@ module Knockapi
79
82
  optional :tenant, String, nil?: true
80
83
 
81
84
  # @!method initialize(id:, inserted_at:, recipient:, repeats:, updated_at:, workflow:, _typename: nil, actor: nil, data: nil, last_occurrence_at: nil, next_occurrence_at: nil, tenant: nil)
82
- # Some parameter documentations has been truncated, see {Knockapi::Schedule} for
83
- # more details.
85
+ # Some parameter documentations has been truncated, see
86
+ # {Knockapi::Models::Schedule} for more details.
84
87
  #
85
88
  # A schedule represents a recurring workflow execution.
86
89
  #
@@ -88,9 +91,9 @@ module Knockapi
88
91
  #
89
92
  # @param inserted_at [Time] Timestamp when the resource was created.
90
93
  #
91
- # @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
94
+ # @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
92
95
  #
93
- # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
96
+ # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
94
97
  #
95
98
  # @param updated_at [Time] The timestamp when the resource was last updated.
96
99
  #
@@ -98,9 +101,9 @@ module Knockapi
98
101
  #
99
102
  # @param _typename [String] The typename of the schema.
100
103
  #
101
- # @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
104
+ # @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
102
105
  #
103
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
106
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
104
107
  #
105
108
  # @param last_occurrence_at [Time, nil] The last occurrence of the schedule.
106
109
  #