knockapi 0.6.1 → 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 (689) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +61 -0
  4. data/README.md +204 -89
  5. data/SECURITY.md +27 -0
  6. data/lib/knockapi/client.rb +122 -0
  7. data/lib/knockapi/errors.rb +192 -0
  8. data/lib/knockapi/file_part.rb +55 -0
  9. data/lib/knockapi/internal/entries_cursor.rb +101 -0
  10. data/lib/knockapi/internal/items_cursor.rb +101 -0
  11. data/lib/knockapi/internal/ms_teams_pagination.rb +86 -0
  12. data/lib/knockapi/internal/slack_channels_cursor.rb +86 -0
  13. data/lib/knockapi/internal/transport/base_client.rb +555 -0
  14. data/lib/knockapi/internal/transport/pooled_net_requester.rb +209 -0
  15. data/lib/knockapi/internal/type/array_of.rb +154 -0
  16. data/lib/knockapi/internal/type/base_model.rb +477 -0
  17. data/lib/knockapi/internal/type/base_page.rb +55 -0
  18. data/lib/knockapi/internal/type/boolean.rb +63 -0
  19. data/lib/knockapi/internal/type/converter.rb +292 -0
  20. data/lib/knockapi/internal/type/enum.rb +108 -0
  21. data/lib/knockapi/internal/type/file_input.rb +96 -0
  22. data/lib/knockapi/internal/type/hash_of.rb +174 -0
  23. data/lib/knockapi/internal/type/request_parameters.rb +42 -0
  24. data/lib/knockapi/internal/type/union.rb +226 -0
  25. data/lib/knockapi/internal/type/unknown.rb +67 -0
  26. data/lib/knockapi/internal/util.rb +862 -0
  27. data/lib/knockapi/internal.rb +17 -0
  28. data/lib/knockapi/models/activity.rb +70 -0
  29. data/lib/knockapi/models/audience_add_members_params.rb +57 -0
  30. data/lib/knockapi/models/audience_add_members_response.rb +7 -0
  31. data/lib/knockapi/models/audience_list_members_params.rb +14 -0
  32. data/lib/knockapi/models/audience_list_members_response.rb +27 -0
  33. data/lib/knockapi/models/audience_member.rb +55 -0
  34. data/lib/knockapi/models/audience_remove_members_params.rb +60 -0
  35. data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
  36. data/lib/knockapi/models/bulk_operation.rb +165 -0
  37. data/lib/knockapi/models/bulk_operation_get_params.rb +14 -0
  38. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +168 -0
  39. data/lib/knockapi/models/condition.rb +63 -0
  40. data/lib/knockapi/models/identify_user_request.rb +97 -0
  41. data/lib/knockapi/models/inline_identify_user_request.rb +106 -0
  42. data/lib/knockapi/models/inline_object_request.rb +56 -0
  43. data/lib/knockapi/models/inline_tenant_request.rb +23 -0
  44. data/lib/knockapi/models/integrations/census_custom_destination_params.rb +48 -0
  45. data/lib/knockapi/models/integrations/census_custom_destination_response.rb +27 -0
  46. data/lib/knockapi/models/integrations/hightouch_embedded_destination_params.rb +48 -0
  47. data/lib/knockapi/models/integrations/hightouch_embedded_destination_response.rb +27 -0
  48. data/lib/knockapi/models/message.rb +264 -0
  49. data/lib/knockapi/models/message_archive_params.rb +14 -0
  50. data/lib/knockapi/models/message_delivery_log.rb +210 -0
  51. data/lib/knockapi/models/message_event.rb +90 -0
  52. data/lib/knockapi/models/message_get_content_params.rb +14 -0
  53. data/lib/knockapi/models/message_get_content_response.rb +517 -0
  54. data/lib/knockapi/models/message_get_params.rb +14 -0
  55. data/lib/knockapi/models/message_list_activities_params.rb +46 -0
  56. data/lib/knockapi/models/message_list_delivery_logs_params.rb +38 -0
  57. data/lib/knockapi/models/message_list_events_params.rb +38 -0
  58. data/lib/knockapi/models/message_list_params.rb +196 -0
  59. data/lib/knockapi/models/message_mark_as_interacted_params.rb +22 -0
  60. data/lib/knockapi/models/message_mark_as_read_params.rb +14 -0
  61. data/lib/knockapi/models/message_mark_as_seen_params.rb +14 -0
  62. data/lib/knockapi/models/message_mark_as_unread_params.rb +14 -0
  63. data/lib/knockapi/models/message_mark_as_unseen_params.rb +14 -0
  64. data/lib/knockapi/models/message_unarchive_params.rb +14 -0
  65. data/lib/knockapi/models/messages/batch_archive_params.rb +24 -0
  66. data/lib/knockapi/models/messages/batch_archive_response.rb +10 -0
  67. data/lib/knockapi/models/messages/batch_get_content_params.rb +24 -0
  68. data/lib/knockapi/models/messages/batch_get_content_response.rb +525 -0
  69. data/lib/knockapi/models/messages/batch_mark_as_interacted_params.rb +32 -0
  70. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +10 -0
  71. data/lib/knockapi/models/messages/batch_mark_as_read_params.rb +24 -0
  72. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +10 -0
  73. data/lib/knockapi/models/messages/batch_mark_as_seen_params.rb +24 -0
  74. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +10 -0
  75. data/lib/knockapi/models/messages/batch_mark_as_unread_params.rb +24 -0
  76. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +10 -0
  77. data/lib/knockapi/models/messages/batch_mark_as_unseen_params.rb +24 -0
  78. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +10 -0
  79. data/lib/knockapi/models/messages/batch_unarchive_params.rb +24 -0
  80. data/lib/knockapi/models/messages/batch_unarchive_response.rb +10 -0
  81. data/lib/knockapi/models/object.rb +59 -0
  82. data/lib/knockapi/models/object_add_subscriptions_params.rb +34 -0
  83. data/lib/knockapi/models/object_add_subscriptions_response.rb +9 -0
  84. data/lib/knockapi/models/object_delete_params.rb +14 -0
  85. data/lib/knockapi/models/object_delete_response.rb +7 -0
  86. data/lib/knockapi/models/object_delete_subscriptions_params.rb +26 -0
  87. data/lib/knockapi/models/object_delete_subscriptions_response.rb +9 -0
  88. data/lib/knockapi/models/object_get_channel_data_params.rb +14 -0
  89. data/lib/knockapi/models/object_get_params.rb +14 -0
  90. data/lib/knockapi/models/object_get_preferences_params.rb +14 -0
  91. data/lib/knockapi/models/object_list_messages_params.rb +199 -0
  92. data/lib/knockapi/models/object_list_params.rb +55 -0
  93. data/lib/knockapi/models/object_list_preferences_params.rb +14 -0
  94. data/lib/knockapi/models/object_list_preferences_response.rb +9 -0
  95. data/lib/knockapi/models/object_list_schedules_params.rb +54 -0
  96. data/lib/knockapi/models/object_list_subscriptions_params.rb +122 -0
  97. data/lib/knockapi/models/object_set_channel_data_params.rb +14 -0
  98. data/lib/knockapi/models/object_set_params.rb +59 -0
  99. data/lib/knockapi/models/object_set_preferences_params.rb +14 -0
  100. data/lib/knockapi/models/object_unset_channel_data_params.rb +14 -0
  101. data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
  102. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +52 -0
  103. data/lib/knockapi/models/objects/bulk_delete_params.rb +24 -0
  104. data/lib/knockapi/models/objects/bulk_set_params.rb +24 -0
  105. data/lib/knockapi/models/page_info.rb +42 -0
  106. data/lib/knockapi/models/providers/ms_team_check_auth_params.rb +24 -0
  107. data/lib/knockapi/models/providers/ms_team_check_auth_response.rb +43 -0
  108. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +63 -0
  109. data/lib/knockapi/models/providers/ms_team_list_channels_response.rb +74 -0
  110. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +73 -0
  111. data/lib/knockapi/models/providers/ms_team_list_teams_response.rb +35 -0
  112. data/lib/knockapi/models/providers/ms_team_revoke_access_params.rb +24 -0
  113. data/lib/knockapi/models/providers/ms_team_revoke_access_response.rb +21 -0
  114. data/lib/knockapi/models/providers/slack_check_auth_params.rb +24 -0
  115. data/lib/knockapi/models/providers/slack_check_auth_response.rb +43 -0
  116. data/lib/knockapi/models/providers/slack_list_channels_params.rb +80 -0
  117. data/lib/knockapi/models/providers/slack_list_channels_response.rb +53 -0
  118. data/lib/knockapi/models/providers/slack_revoke_access_params.rb +24 -0
  119. data/lib/knockapi/models/providers/slack_revoke_access_response.rb +21 -0
  120. data/lib/knockapi/models/recipient.rb +23 -0
  121. data/lib/knockapi/models/recipient_reference.rb +45 -0
  122. data/lib/knockapi/models/recipient_request.rb +28 -0
  123. data/lib/knockapi/models/recipients/channel_data.rb +100 -0
  124. data/lib/knockapi/models/recipients/channel_data_request.rb +57 -0
  125. data/lib/knockapi/models/recipients/discord_channel_data.rb +92 -0
  126. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +46 -0
  127. data/lib/knockapi/models/recipients/inline_preference_set_request.rb +11 -0
  128. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +123 -0
  129. data/lib/knockapi/models/recipients/one_signal_channel_data.rb +20 -0
  130. data/lib/knockapi/models/recipients/preference_set.rb +150 -0
  131. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +21 -0
  132. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +174 -0
  133. data/lib/knockapi/models/recipients/preference_set_request.rb +141 -0
  134. data/lib/knockapi/models/recipients/push_channel_data.rb +20 -0
  135. data/lib/knockapi/models/recipients/slack_channel_data.rb +110 -0
  136. data/lib/knockapi/models/recipients/subscription.rb +60 -0
  137. data/lib/knockapi/models/schedule.rb +112 -0
  138. data/lib/knockapi/models/schedule_create_params.rb +70 -0
  139. data/lib/knockapi/models/schedule_create_response.rb +8 -0
  140. data/lib/knockapi/models/schedule_delete_params.rb +22 -0
  141. data/lib/knockapi/models/schedule_delete_response.rb +8 -0
  142. data/lib/knockapi/models/schedule_list_params.rb +62 -0
  143. data/lib/knockapi/models/schedule_repeat_rule.rb +99 -0
  144. data/lib/knockapi/models/schedule_update_params.rb +74 -0
  145. data/lib/knockapi/models/schedule_update_response.rb +8 -0
  146. data/lib/knockapi/models/schedules/bulk_create_params.rb +101 -0
  147. data/lib/knockapi/models/tenant.rb +112 -0
  148. data/lib/knockapi/models/tenant_delete_params.rb +14 -0
  149. data/lib/knockapi/models/tenant_delete_response.rb +7 -0
  150. data/lib/knockapi/models/tenant_get_params.rb +14 -0
  151. data/lib/knockapi/models/tenant_list_params.rb +54 -0
  152. data/lib/knockapi/models/tenant_request.rb +114 -0
  153. data/lib/knockapi/models/tenant_set_params.rb +108 -0
  154. data/lib/knockapi/models/tenants/bulk_delete_params.rb +24 -0
  155. data/lib/knockapi/models/tenants/bulk_set_params.rb +24 -0
  156. data/lib/knockapi/models/user.rb +92 -0
  157. data/lib/knockapi/models/user_delete_params.rb +14 -0
  158. data/lib/knockapi/models/user_delete_response.rb +7 -0
  159. data/lib/knockapi/models/user_get_channel_data_params.rb +14 -0
  160. data/lib/knockapi/models/user_get_params.rb +14 -0
  161. data/lib/knockapi/models/user_get_preferences_params.rb +22 -0
  162. data/lib/knockapi/models/user_list_messages_params.rb +201 -0
  163. data/lib/knockapi/models/user_list_params.rb +55 -0
  164. data/lib/knockapi/models/user_list_preferences_params.rb +14 -0
  165. data/lib/knockapi/models/user_list_preferences_response.rb +9 -0
  166. data/lib/knockapi/models/user_list_schedules_params.rb +54 -0
  167. data/lib/knockapi/models/user_list_subscriptions_params.rb +64 -0
  168. data/lib/knockapi/models/user_merge_params.rb +22 -0
  169. data/lib/knockapi/models/user_set_channel_data_params.rb +14 -0
  170. data/lib/knockapi/models/user_set_preferences_params.rb +14 -0
  171. data/lib/knockapi/models/user_unset_channel_data_params.rb +14 -0
  172. data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
  173. data/lib/knockapi/models/user_update_params.rb +14 -0
  174. data/lib/knockapi/models/users/bulk_delete_params.rb +24 -0
  175. data/lib/knockapi/models/users/bulk_identify_params.rb +24 -0
  176. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +32 -0
  177. data/lib/knockapi/models/users/feed_get_settings_params.rb +16 -0
  178. data/lib/knockapi/models/users/feed_get_settings_response.rb +35 -0
  179. data/lib/knockapi/models/users/feed_list_items_params.rb +122 -0
  180. data/lib/knockapi/models/users/feed_list_items_response.rb +342 -0
  181. data/lib/knockapi/models/users/guide_get_channel_params.rb +40 -0
  182. data/lib/knockapi/models/users/guide_get_channel_response.rb +79 -0
  183. data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +88 -0
  184. data/lib/knockapi/models/users/guide_mark_message_as_archived_response.rb +21 -0
  185. data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +88 -0
  186. data/lib/knockapi/models/users/guide_mark_message_as_interacted_response.rb +21 -0
  187. data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +88 -0
  188. data/lib/knockapi/models/users/guide_mark_message_as_seen_response.rb +21 -0
  189. data/lib/knockapi/models/workflow_cancel_params.rb +40 -0
  190. data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
  191. data/lib/knockapi/models/workflow_trigger_params.rb +64 -0
  192. data/lib/knockapi/models/workflow_trigger_response.rb +23 -0
  193. data/lib/knockapi/models.rb +202 -0
  194. data/lib/knockapi/request_options.rb +77 -0
  195. data/lib/knockapi/resources/audiences.rb +82 -0
  196. data/lib/knockapi/resources/bulk_operations.rb +34 -0
  197. data/lib/knockapi/resources/channels/bulk.rb +66 -0
  198. data/lib/knockapi/resources/channels.rb +18 -0
  199. data/lib/knockapi/resources/integrations/census.rb +44 -0
  200. data/lib/knockapi/resources/integrations/hightouch.rb +44 -0
  201. data/lib/knockapi/resources/integrations.rb +22 -0
  202. data/lib/knockapi/resources/messages/batch.rb +208 -0
  203. data/lib/knockapi/resources/messages.rb +358 -0
  204. data/lib/knockapi/resources/objects/bulk.rb +92 -0
  205. data/lib/knockapi/resources/objects.rb +498 -0
  206. data/lib/knockapi/resources/providers/ms_teams.rb +122 -0
  207. data/lib/knockapi/resources/providers/slack.rb +91 -0
  208. data/lib/knockapi/resources/providers.rb +22 -0
  209. data/lib/knockapi/resources/recipients/channel_data.rb +16 -0
  210. data/lib/knockapi/resources/recipients/preferences.rb +16 -0
  211. data/lib/knockapi/resources/recipients/subscriptions.rb +16 -0
  212. data/lib/knockapi/resources/recipients.rb +26 -0
  213. data/lib/knockapi/resources/schedules/bulk.rb +40 -0
  214. data/lib/knockapi/resources/schedules.rb +154 -0
  215. data/lib/knockapi/resources/shared.rb +14 -0
  216. data/lib/knockapi/resources/tenants/bulk.rb +60 -0
  217. data/lib/knockapi/resources/tenants.rb +118 -0
  218. data/lib/knockapi/resources/users/bulk.rb +89 -0
  219. data/lib/knockapi/resources/users/feeds.rb +84 -0
  220. data/lib/knockapi/resources/users/guides.rb +175 -0
  221. data/lib/knockapi/resources/users.rb +440 -0
  222. data/lib/knockapi/resources/workflows.rb +84 -0
  223. data/lib/knockapi/version.rb +5 -0
  224. data/lib/knockapi.rb +248 -0
  225. data/manifest.yaml +15 -0
  226. data/rbi/knockapi/client.rbi +85 -0
  227. data/rbi/knockapi/errors.rbi +162 -0
  228. data/rbi/knockapi/file_part.rbi +37 -0
  229. data/rbi/knockapi/internal/entries_cursor.rbi +40 -0
  230. data/rbi/knockapi/internal/items_cursor.rbi +40 -0
  231. data/rbi/knockapi/internal/ms_teams_pagination.rbi +22 -0
  232. data/rbi/knockapi/internal/slack_channels_cursor.rbi +22 -0
  233. data/rbi/knockapi/internal/transport/base_client.rbi +293 -0
  234. data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +79 -0
  235. data/rbi/knockapi/internal/type/array_of.rbi +98 -0
  236. data/rbi/knockapi/internal/type/base_model.rbi +297 -0
  237. data/rbi/knockapi/internal/type/base_page.rbi +42 -0
  238. data/rbi/knockapi/internal/type/boolean.rbi +50 -0
  239. data/rbi/knockapi/internal/type/converter.rbi +162 -0
  240. data/rbi/knockapi/internal/type/enum.rbi +77 -0
  241. data/rbi/knockapi/internal/type/file_input.rbi +54 -0
  242. data/rbi/knockapi/internal/type/hash_of.rbi +98 -0
  243. data/rbi/knockapi/internal/type/request_parameters.rbi +29 -0
  244. data/rbi/knockapi/internal/type/union.rbi +111 -0
  245. data/rbi/knockapi/internal/type/unknown.rbi +50 -0
  246. data/rbi/knockapi/internal/util.rbi +451 -0
  247. data/rbi/knockapi/internal.rbi +13 -0
  248. data/rbi/knockapi/models/activity.rbi +107 -0
  249. data/rbi/knockapi/models/audience_add_members_params.rbi +123 -0
  250. data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
  251. data/rbi/knockapi/models/audience_list_members_params.rbi +30 -0
  252. data/rbi/knockapi/models/audience_list_members_response.rbi +52 -0
  253. data/rbi/knockapi/models/audience_member.rbi +77 -0
  254. data/rbi/knockapi/models/audience_remove_members_params.rbi +127 -0
  255. data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
  256. data/rbi/knockapi/models/bulk_operation.rbi +222 -0
  257. data/rbi/knockapi/models/bulk_operation_get_params.rbi +27 -0
  258. data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +432 -0
  259. data/rbi/knockapi/models/condition.rbi +124 -0
  260. data/rbi/knockapi/models/identify_user_request.rbi +164 -0
  261. data/rbi/knockapi/models/inline_identify_user_request.rbi +176 -0
  262. data/rbi/knockapi/models/inline_object_request.rbi +122 -0
  263. data/rbi/knockapi/models/inline_tenant_request.rbi +18 -0
  264. data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +75 -0
  265. data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +50 -0
  266. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +75 -0
  267. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +50 -0
  268. data/rbi/knockapi/models/message.rbi +406 -0
  269. data/rbi/knockapi/models/message_archive_params.rbi +27 -0
  270. data/rbi/knockapi/models/message_delivery_log.rbi +347 -0
  271. data/rbi/knockapi/models/message_event.rbi +152 -0
  272. data/rbi/knockapi/models/message_get_content_params.rbi +27 -0
  273. data/rbi/knockapi/models/message_get_content_response.rbi +899 -0
  274. data/rbi/knockapi/models/message_get_params.rbi +27 -0
  275. data/rbi/knockapi/models/message_list_activities_params.rbi +82 -0
  276. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +71 -0
  277. data/rbi/knockapi/models/message_list_events_params.rbi +68 -0
  278. data/rbi/knockapi/models/message_list_params.rbi +360 -0
  279. data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +49 -0
  280. data/rbi/knockapi/models/message_mark_as_read_params.rbi +27 -0
  281. data/rbi/knockapi/models/message_mark_as_seen_params.rbi +27 -0
  282. data/rbi/knockapi/models/message_mark_as_unread_params.rbi +30 -0
  283. data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +30 -0
  284. data/rbi/knockapi/models/message_unarchive_params.rbi +27 -0
  285. data/rbi/knockapi/models/messages/batch_archive_params.rbi +48 -0
  286. data/rbi/knockapi/models/messages/batch_archive_response.rbi +13 -0
  287. data/rbi/knockapi/models/messages/batch_get_content_params.rbi +48 -0
  288. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +909 -0
  289. data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +56 -0
  290. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +13 -0
  291. data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +48 -0
  292. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +13 -0
  293. data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +48 -0
  294. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +13 -0
  295. data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +48 -0
  296. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +13 -0
  297. data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +48 -0
  298. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +13 -0
  299. data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +48 -0
  300. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +13 -0
  301. data/rbi/knockapi/models/object.rbi +79 -0
  302. data/rbi/knockapi/models/object_add_subscriptions_params.rbi +80 -0
  303. data/rbi/knockapi/models/object_add_subscriptions_response.rbi +11 -0
  304. data/rbi/knockapi/models/object_delete_params.rbi +27 -0
  305. data/rbi/knockapi/models/object_delete_response.rbi +7 -0
  306. data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +61 -0
  307. data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +11 -0
  308. data/rbi/knockapi/models/object_get_channel_data_params.rbi +30 -0
  309. data/rbi/knockapi/models/object_get_params.rbi +27 -0
  310. data/rbi/knockapi/models/object_get_preferences_params.rbi +30 -0
  311. data/rbi/knockapi/models/object_list_messages_params.rbi +390 -0
  312. data/rbi/knockapi/models/object_list_params.rbi +106 -0
  313. data/rbi/knockapi/models/object_list_preferences_params.rbi +30 -0
  314. data/rbi/knockapi/models/object_list_preferences_response.rbi +11 -0
  315. data/rbi/knockapi/models/object_list_schedules_params.rbi +93 -0
  316. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +279 -0
  317. data/rbi/knockapi/models/object_set_channel_data_params.rbi +30 -0
  318. data/rbi/knockapi/models/object_set_params.rbi +141 -0
  319. data/rbi/knockapi/models/object_set_preferences_params.rbi +30 -0
  320. data/rbi/knockapi/models/object_unset_channel_data_params.rbi +30 -0
  321. data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
  322. data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +129 -0
  323. data/rbi/knockapi/models/objects/bulk_delete_params.rbi +48 -0
  324. data/rbi/knockapi/models/objects/bulk_set_params.rbi +45 -0
  325. data/rbi/knockapi/models/page_info.rbi +60 -0
  326. data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +48 -0
  327. data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +95 -0
  328. data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +121 -0
  329. data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +140 -0
  330. data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +147 -0
  331. data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +54 -0
  332. data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +48 -0
  333. data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +36 -0
  334. data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +48 -0
  335. data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +95 -0
  336. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +158 -0
  337. data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +75 -0
  338. data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +48 -0
  339. data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +36 -0
  340. data/rbi/knockapi/models/recipient.rbi +16 -0
  341. data/rbi/knockapi/models/recipient_reference.rbi +58 -0
  342. data/rbi/knockapi/models/recipient_request.rbi +25 -0
  343. data/rbi/knockapi/models/recipients/channel_data.rbi +198 -0
  344. data/rbi/knockapi/models/recipients/channel_data_request.rbi +91 -0
  345. data/rbi/knockapi/models/recipients/discord_channel_data.rbi +190 -0
  346. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +41 -0
  347. data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +15 -0
  348. data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +231 -0
  349. data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +33 -0
  350. data/rbi/knockapi/models/recipients/preference_set.rbi +314 -0
  351. data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +38 -0
  352. data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +389 -0
  353. data/rbi/knockapi/models/recipients/preference_set_request.rbi +309 -0
  354. data/rbi/knockapi/models/recipients/push_channel_data.rbi +33 -0
  355. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +212 -0
  356. data/rbi/knockapi/models/recipients/subscription.rbi +86 -0
  357. data/rbi/knockapi/models/schedule.rbi +132 -0
  358. data/rbi/knockapi/models/schedule_create_params.rbi +115 -0
  359. data/rbi/knockapi/models/schedule_create_response.rbi +11 -0
  360. data/rbi/knockapi/models/schedule_delete_params.rbi +43 -0
  361. data/rbi/knockapi/models/schedule_delete_response.rbi +11 -0
  362. data/rbi/knockapi/models/schedule_list_params.rbi +98 -0
  363. data/rbi/knockapi/models/schedule_repeat_rule.rbi +148 -0
  364. data/rbi/knockapi/models/schedule_update_params.rbi +113 -0
  365. data/rbi/knockapi/models/schedule_update_response.rbi +11 -0
  366. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +213 -0
  367. data/rbi/knockapi/models/tenant.rbi +188 -0
  368. data/rbi/knockapi/models/tenant_delete_params.rbi +27 -0
  369. data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
  370. data/rbi/knockapi/models/tenant_get_params.rbi +27 -0
  371. data/rbi/knockapi/models/tenant_list_params.rbi +90 -0
  372. data/rbi/knockapi/models/tenant_request.rbi +243 -0
  373. data/rbi/knockapi/models/tenant_set_params.rbi +241 -0
  374. data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +48 -0
  375. data/rbi/knockapi/models/tenants/bulk_set_params.rbi +45 -0
  376. data/rbi/knockapi/models/user.rbi +110 -0
  377. data/rbi/knockapi/models/user_delete_params.rbi +27 -0
  378. data/rbi/knockapi/models/user_delete_response.rbi +7 -0
  379. data/rbi/knockapi/models/user_get_channel_data_params.rbi +27 -0
  380. data/rbi/knockapi/models/user_get_params.rbi +27 -0
  381. data/rbi/knockapi/models/user_get_preferences_params.rbi +43 -0
  382. data/rbi/knockapi/models/user_list_messages_params.rbi +386 -0
  383. data/rbi/knockapi/models/user_list_params.rbi +106 -0
  384. data/rbi/knockapi/models/user_list_preferences_params.rbi +30 -0
  385. data/rbi/knockapi/models/user_list_preferences_response.rbi +11 -0
  386. data/rbi/knockapi/models/user_list_schedules_params.rbi +90 -0
  387. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +134 -0
  388. data/rbi/knockapi/models/user_merge_params.rbi +40 -0
  389. data/rbi/knockapi/models/user_set_channel_data_params.rbi +27 -0
  390. data/rbi/knockapi/models/user_set_preferences_params.rbi +27 -0
  391. data/rbi/knockapi/models/user_unset_channel_data_params.rbi +30 -0
  392. data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
  393. data/rbi/knockapi/models/user_update_params.rbi +27 -0
  394. data/rbi/knockapi/models/users/bulk_delete_params.rbi +48 -0
  395. data/rbi/knockapi/models/users/bulk_identify_params.rbi +48 -0
  396. data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +63 -0
  397. data/rbi/knockapi/models/users/feed_get_settings_params.rbi +32 -0
  398. data/rbi/knockapi/models/users/feed_get_settings_response.rbi +83 -0
  399. data/rbi/knockapi/models/users/feed_list_items_params.rbi +251 -0
  400. data/rbi/knockapi/models/users/feed_list_items_response.rbi +540 -0
  401. data/rbi/knockapi/models/users/guide_get_channel_params.rbi +73 -0
  402. data/rbi/knockapi/models/users/guide_get_channel_response.rbi +183 -0
  403. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +124 -0
  404. data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +33 -0
  405. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +124 -0
  406. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +33 -0
  407. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +124 -0
  408. data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +33 -0
  409. data/rbi/knockapi/models/workflow_cancel_params.rbi +82 -0
  410. data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
  411. data/rbi/knockapi/models/workflow_trigger_params.rbi +137 -0
  412. data/rbi/knockapi/models/workflow_trigger_response.rbi +33 -0
  413. data/rbi/knockapi/models.rbi +179 -0
  414. data/rbi/knockapi/request_options.rbi +59 -0
  415. data/rbi/knockapi/resources/audiences.rbi +61 -0
  416. data/rbi/knockapi/resources/bulk_operations.rbi +26 -0
  417. data/rbi/knockapi/resources/channels/bulk.rbi +70 -0
  418. data/rbi/knockapi/resources/channels.rbi +15 -0
  419. data/rbi/knockapi/resources/integrations/census.rbi +39 -0
  420. data/rbi/knockapi/resources/integrations/hightouch.rbi +39 -0
  421. data/rbi/knockapi/resources/integrations.rbi +18 -0
  422. data/rbi/knockapi/resources/messages/batch.rbi +145 -0
  423. data/rbi/knockapi/resources/messages.rbi +290 -0
  424. data/rbi/knockapi/resources/objects/bulk.rbi +72 -0
  425. data/rbi/knockapi/resources/objects.rbi +504 -0
  426. data/rbi/knockapi/resources/providers/ms_teams.rbi +98 -0
  427. data/rbi/knockapi/resources/providers/slack.rbi +72 -0
  428. data/rbi/knockapi/resources/providers.rbi +18 -0
  429. data/rbi/knockapi/resources/recipients/channel_data.rbi +14 -0
  430. data/rbi/knockapi/resources/recipients/preferences.rbi +14 -0
  431. data/rbi/knockapi/resources/recipients/subscriptions.rbi +14 -0
  432. data/rbi/knockapi/resources/recipients.rbi +21 -0
  433. data/rbi/knockapi/resources/schedules/bulk.rbi +31 -0
  434. data/rbi/knockapi/resources/schedules.rbi +146 -0
  435. data/rbi/knockapi/resources/shared.rbi +12 -0
  436. data/rbi/knockapi/resources/tenants/bulk.rbi +42 -0
  437. data/rbi/knockapi/resources/tenants.rbi +111 -0
  438. data/rbi/knockapi/resources/users/bulk.rbi +64 -0
  439. data/rbi/knockapi/resources/users/feeds.rbi +83 -0
  440. data/rbi/knockapi/resources/users/guides.rbi +177 -0
  441. data/rbi/knockapi/resources/users.rbi +426 -0
  442. data/rbi/knockapi/resources/workflows.rbi +101 -0
  443. data/rbi/knockapi/version.rbi +5 -0
  444. data/sig/knockapi/client.rbs +50 -0
  445. data/sig/knockapi/errors.rbs +101 -0
  446. data/sig/knockapi/file_part.rbs +21 -0
  447. data/sig/knockapi/internal/entries_cursor.rbs +22 -0
  448. data/sig/knockapi/internal/items_cursor.rbs +22 -0
  449. data/sig/knockapi/internal/ms_teams_pagination.rbs +13 -0
  450. data/sig/knockapi/internal/slack_channels_cursor.rbs +13 -0
  451. data/sig/knockapi/internal/transport/base_client.rbs +131 -0
  452. data/sig/knockapi/internal/transport/pooled_net_requester.rbs +45 -0
  453. data/sig/knockapi/internal/type/array_of.rbs +45 -0
  454. data/sig/knockapi/internal/type/base_model.rbs +100 -0
  455. data/sig/knockapi/internal/type/base_page.rbs +24 -0
  456. data/sig/knockapi/internal/type/boolean.rbs +23 -0
  457. data/sig/knockapi/internal/type/converter.rbs +56 -0
  458. data/sig/knockapi/internal/type/enum.rbs +30 -0
  459. data/sig/knockapi/internal/type/file_input.rbs +23 -0
  460. data/sig/knockapi/internal/type/hash_of.rbs +45 -0
  461. data/sig/knockapi/internal/type/request_parameters.rbs +17 -0
  462. data/sig/knockapi/internal/type/union.rbs +50 -0
  463. data/sig/knockapi/internal/type/unknown.rbs +23 -0
  464. data/sig/knockapi/internal/util.rbs +173 -0
  465. data/sig/knockapi/internal.rbs +7 -0
  466. data/sig/knockapi/models/activity.rbs +52 -0
  467. data/sig/knockapi/models/audience_add_members_params.rbs +46 -0
  468. data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
  469. data/sig/knockapi/models/audience_list_members_params.rbs +13 -0
  470. data/sig/knockapi/models/audience_list_members_response.rbs +20 -0
  471. data/sig/knockapi/models/audience_member.rbs +32 -0
  472. data/sig/knockapi/models/audience_remove_members_params.rbs +46 -0
  473. data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
  474. data/sig/knockapi/models/bulk_operation.rbs +103 -0
  475. data/sig/knockapi/models/bulk_operation_get_params.rbs +13 -0
  476. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +174 -0
  477. data/sig/knockapi/models/condition.rbs +69 -0
  478. data/sig/knockapi/models/identify_user_request.rbs +48 -0
  479. data/sig/knockapi/models/inline_identify_user_request.rbs +52 -0
  480. data/sig/knockapi/models/inline_object_request.rbs +32 -0
  481. data/sig/knockapi/models/inline_tenant_request.rbs +11 -0
  482. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +37 -0
  483. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +20 -0
  484. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +37 -0
  485. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +20 -0
  486. data/sig/knockapi/models/message.rbs +185 -0
  487. data/sig/knockapi/models/message_archive_params.rbs +13 -0
  488. data/sig/knockapi/models/message_delivery_log.rbs +146 -0
  489. data/sig/knockapi/models/message_event.rbs +75 -0
  490. data/sig/knockapi/models/message_get_content_params.rbs +13 -0
  491. data/sig/knockapi/models/message_get_content_response.rbs +316 -0
  492. data/sig/knockapi/models/message_get_params.rbs +13 -0
  493. data/sig/knockapi/models/message_list_activities_params.rbs +41 -0
  494. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +31 -0
  495. data/sig/knockapi/models/message_list_events_params.rbs +31 -0
  496. data/sig/knockapi/models/message_list_params.rbs +172 -0
  497. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +21 -0
  498. data/sig/knockapi/models/message_mark_as_read_params.rbs +13 -0
  499. data/sig/knockapi/models/message_mark_as_seen_params.rbs +13 -0
  500. data/sig/knockapi/models/message_mark_as_unread_params.rbs +13 -0
  501. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +13 -0
  502. data/sig/knockapi/models/message_unarchive_params.rbs +13 -0
  503. data/sig/knockapi/models/messages/batch_archive_params.rbs +21 -0
  504. data/sig/knockapi/models/messages/batch_archive_response.rbs +9 -0
  505. data/sig/knockapi/models/messages/batch_get_content_params.rbs +21 -0
  506. data/sig/knockapi/models/messages/batch_get_content_response.rbs +327 -0
  507. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +24 -0
  508. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +9 -0
  509. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +21 -0
  510. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +9 -0
  511. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +21 -0
  512. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +9 -0
  513. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +21 -0
  514. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +9 -0
  515. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +21 -0
  516. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +9 -0
  517. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +21 -0
  518. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +9 -0
  519. data/sig/knockapi/models/object.rbs +38 -0
  520. data/sig/knockapi/models/object_add_subscriptions_params.rbs +25 -0
  521. data/sig/knockapi/models/object_add_subscriptions_response.rbs +8 -0
  522. data/sig/knockapi/models/object_delete_params.rbs +13 -0
  523. data/sig/knockapi/models/object_delete_response.rbs +5 -0
  524. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +19 -0
  525. data/sig/knockapi/models/object_delete_subscriptions_response.rbs +8 -0
  526. data/sig/knockapi/models/object_get_channel_data_params.rbs +13 -0
  527. data/sig/knockapi/models/object_get_params.rbs +12 -0
  528. data/sig/knockapi/models/object_get_preferences_params.rbs +13 -0
  529. data/sig/knockapi/models/object_list_messages_params.rbs +172 -0
  530. data/sig/knockapi/models/object_list_params.rbs +53 -0
  531. data/sig/knockapi/models/object_list_preferences_params.rbs +13 -0
  532. data/sig/knockapi/models/object_list_preferences_response.rbs +8 -0
  533. data/sig/knockapi/models/object_list_schedules_params.rbs +47 -0
  534. data/sig/knockapi/models/object_list_subscriptions_params.rbs +102 -0
  535. data/sig/knockapi/models/object_set_channel_data_params.rbs +13 -0
  536. data/sig/knockapi/models/object_set_params.rbs +41 -0
  537. data/sig/knockapi/models/object_set_preferences_params.rbs +13 -0
  538. data/sig/knockapi/models/object_unset_channel_data_params.rbs +13 -0
  539. data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
  540. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +40 -0
  541. data/sig/knockapi/models/objects/bulk_delete_params.rbs +21 -0
  542. data/sig/knockapi/models/objects/bulk_set_params.rbs +21 -0
  543. data/sig/knockapi/models/page_info.rbs +23 -0
  544. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +21 -0
  545. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +28 -0
  546. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +49 -0
  547. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +57 -0
  548. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +59 -0
  549. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +22 -0
  550. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +21 -0
  551. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +15 -0
  552. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +21 -0
  553. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +28 -0
  554. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +70 -0
  555. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +34 -0
  556. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +21 -0
  557. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +15 -0
  558. data/sig/knockapi/models/recipient.rbs +11 -0
  559. data/sig/knockapi/models/recipient_reference.rbs +26 -0
  560. data/sig/knockapi/models/recipient_request.rbs +14 -0
  561. data/sig/knockapi/models/recipients/channel_data.rbs +72 -0
  562. data/sig/knockapi/models/recipients/channel_data_request.rbs +29 -0
  563. data/sig/knockapi/models/recipients/discord_channel_data.rbs +57 -0
  564. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +23 -0
  565. data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +10 -0
  566. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +78 -0
  567. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +13 -0
  568. data/sig/knockapi/models/recipients/preference_set.rbs +84 -0
  569. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +14 -0
  570. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +112 -0
  571. data/sig/knockapi/models/recipients/preference_set_request.rbs +80 -0
  572. data/sig/knockapi/models/recipients/push_channel_data.rbs +13 -0
  573. data/sig/knockapi/models/recipients/slack_channel_data.rbs +65 -0
  574. data/sig/knockapi/models/recipients/subscription.rbs +38 -0
  575. data/sig/knockapi/models/schedule.rbs +62 -0
  576. data/sig/knockapi/models/schedule_create_params.rbs +45 -0
  577. data/sig/knockapi/models/schedule_create_response.rbs +7 -0
  578. data/sig/knockapi/models/schedule_delete_params.rbs +19 -0
  579. data/sig/knockapi/models/schedule_delete_response.rbs +7 -0
  580. data/sig/knockapi/models/schedule_list_params.rbs +51 -0
  581. data/sig/knockapi/models/schedule_repeat_rule.rbs +71 -0
  582. data/sig/knockapi/models/schedule_update_params.rbs +49 -0
  583. data/sig/knockapi/models/schedule_update_response.rbs +7 -0
  584. data/sig/knockapi/models/schedules/bulk_create_params.rbs +70 -0
  585. data/sig/knockapi/models/tenant.rbs +70 -0
  586. data/sig/knockapi/models/tenant_delete_params.rbs +13 -0
  587. data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
  588. data/sig/knockapi/models/tenant_get_params.rbs +12 -0
  589. data/sig/knockapi/models/tenant_list_params.rbs +47 -0
  590. data/sig/knockapi/models/tenant_request.rbs +78 -0
  591. data/sig/knockapi/models/tenant_set_params.rbs +79 -0
  592. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +21 -0
  593. data/sig/knockapi/models/tenants/bulk_set_params.rbs +21 -0
  594. data/sig/knockapi/models/user.rbs +48 -0
  595. data/sig/knockapi/models/user_delete_params.rbs +13 -0
  596. data/sig/knockapi/models/user_delete_response.rbs +5 -0
  597. data/sig/knockapi/models/user_get_channel_data_params.rbs +13 -0
  598. data/sig/knockapi/models/user_get_params.rbs +12 -0
  599. data/sig/knockapi/models/user_get_preferences_params.rbs +20 -0
  600. data/sig/knockapi/models/user_list_messages_params.rbs +172 -0
  601. data/sig/knockapi/models/user_list_params.rbs +53 -0
  602. data/sig/knockapi/models/user_list_preferences_params.rbs +13 -0
  603. data/sig/knockapi/models/user_list_preferences_response.rbs +8 -0
  604. data/sig/knockapi/models/user_list_schedules_params.rbs +47 -0
  605. data/sig/knockapi/models/user_list_subscriptions_params.rbs +59 -0
  606. data/sig/knockapi/models/user_merge_params.rbs +18 -0
  607. data/sig/knockapi/models/user_set_channel_data_params.rbs +13 -0
  608. data/sig/knockapi/models/user_set_preferences_params.rbs +13 -0
  609. data/sig/knockapi/models/user_unset_channel_data_params.rbs +13 -0
  610. data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
  611. data/sig/knockapi/models/user_update_params.rbs +13 -0
  612. data/sig/knockapi/models/users/bulk_delete_params.rbs +21 -0
  613. data/sig/knockapi/models/users/bulk_identify_params.rbs +21 -0
  614. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +27 -0
  615. data/sig/knockapi/models/users/feed_get_settings_params.rbs +15 -0
  616. data/sig/knockapi/models/users/feed_get_settings_response.rbs +24 -0
  617. data/sig/knockapi/models/users/feed_list_items_params.rbs +109 -0
  618. data/sig/knockapi/models/users/feed_list_items_response.rbs +204 -0
  619. data/sig/knockapi/models/users/guide_get_channel_params.rbs +33 -0
  620. data/sig/knockapi/models/users/guide_get_channel_response.rbs +65 -0
  621. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +63 -0
  622. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +13 -0
  623. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +63 -0
  624. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +13 -0
  625. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +63 -0
  626. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +13 -0
  627. data/sig/knockapi/models/workflow_cancel_params.rbs +25 -0
  628. data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
  629. data/sig/knockapi/models/workflow_trigger_params.rbs +37 -0
  630. data/sig/knockapi/models/workflow_trigger_response.rbs +11 -0
  631. data/sig/knockapi/models.rbs +173 -0
  632. data/sig/knockapi/request_options.rbs +34 -0
  633. data/sig/knockapi/resources/audiences.rbs +24 -0
  634. data/sig/knockapi/resources/bulk_operations.rbs +12 -0
  635. data/sig/knockapi/resources/channels/bulk.rbs +25 -0
  636. data/sig/knockapi/resources/channels.rbs +9 -0
  637. data/sig/knockapi/resources/integrations/census.rbs +17 -0
  638. data/sig/knockapi/resources/integrations/hightouch.rbs +17 -0
  639. data/sig/knockapi/resources/integrations.rbs +11 -0
  640. data/sig/knockapi/resources/messages/batch.rbs +50 -0
  641. data/sig/knockapi/resources/messages.rbs +98 -0
  642. data/sig/knockapi/resources/objects/bulk.rbs +27 -0
  643. data/sig/knockapi/resources/objects.rbs +144 -0
  644. data/sig/knockapi/resources/providers/ms_teams.rbs +36 -0
  645. data/sig/knockapi/resources/providers/slack.rbs +28 -0
  646. data/sig/knockapi/resources/providers.rbs +11 -0
  647. data/sig/knockapi/resources/recipients/channel_data.rbs +9 -0
  648. data/sig/knockapi/resources/recipients/preferences.rbs +9 -0
  649. data/sig/knockapi/resources/recipients/subscriptions.rbs +9 -0
  650. data/sig/knockapi/resources/recipients.rbs +13 -0
  651. data/sig/knockapi/resources/schedules/bulk.rbs +14 -0
  652. data/sig/knockapi/resources/schedules.rbs +46 -0
  653. data/sig/knockapi/resources/shared.rbs +7 -0
  654. data/sig/knockapi/resources/tenants/bulk.rbs +19 -0
  655. data/sig/knockapi/resources/tenants.rbs +36 -0
  656. data/sig/knockapi/resources/users/bulk.rbs +25 -0
  657. data/sig/knockapi/resources/users/feeds.rbs +31 -0
  658. data/sig/knockapi/resources/users/guides.rbs +63 -0
  659. data/sig/knockapi/resources/users.rbs +130 -0
  660. data/sig/knockapi/resources/workflows.rbs +24 -0
  661. data/sig/knockapi/version.rbs +3 -0
  662. metadata +678 -77
  663. data/.github/workflows/publish.yml +0 -17
  664. data/.github/workflows/ruby.yml +0 -47
  665. data/.gitignore +0 -49
  666. data/.rubocop.yml +0 -8
  667. data/.ruby-version +0 -1
  668. data/.tool-versions +0 -1
  669. data/CONTRIBUTING.md +0 -31
  670. data/Gemfile +0 -9
  671. data/Gemfile.lock +0 -63
  672. data/LICENSE +0 -21
  673. data/bin/console +0 -8
  674. data/bin/publish +0 -5
  675. data/knockapi.gemspec +0 -30
  676. data/lib/knock/bulk_operations.rb +0 -27
  677. data/lib/knock/client.rb +0 -149
  678. data/lib/knock/configuration.rb +0 -18
  679. data/lib/knock/errors.rb +0 -57
  680. data/lib/knock/messages.rb +0 -93
  681. data/lib/knock/objects.rb +0 -442
  682. data/lib/knock/preferences.rb +0 -114
  683. data/lib/knock/tenants.rb +0 -72
  684. data/lib/knock/users.rb +0 -420
  685. data/lib/knock/version.rb +0 -5
  686. data/lib/knock/workflows.rb +0 -152
  687. data/lib/knock.rb +0 -71
  688. data/spec/configuration_spec.rb +0 -63
  689. data/spec/tenants_spec.rb +0 -66
@@ -0,0 +1,899 @@
1
+ # typed: strong
2
+
3
+ module Knockapi
4
+ module Models
5
+ class MessageGetContentResponse < Knockapi::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ Knockapi::Models::MessageGetContentResponse,
10
+ Knockapi::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # The typename of the schema.
15
+ sig { returns(String) }
16
+ attr_accessor :_typename
17
+
18
+ # Content data specific to the channel type.
19
+ sig do
20
+ returns(
21
+ T.any(
22
+ Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
23
+ Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
24
+ Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
25
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
26
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
27
+ )
28
+ )
29
+ end
30
+ attr_accessor :data
31
+
32
+ # Timestamp when the message content was created.
33
+ sig { returns(Time) }
34
+ attr_accessor :inserted_at
35
+
36
+ # The unique identifier for the message content.
37
+ sig { returns(String) }
38
+ attr_accessor :message_id
39
+
40
+ # The content of a message.
41
+ sig do
42
+ params(
43
+ _typename: String,
44
+ data:
45
+ T.any(
46
+ Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent::OrHash,
47
+ Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent::OrHash,
48
+ Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent::OrHash,
49
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::OrHash,
50
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::OrHash
51
+ ),
52
+ inserted_at: Time,
53
+ message_id: String
54
+ ).returns(T.attached_class)
55
+ end
56
+ def self.new(
57
+ # The typename of the schema.
58
+ _typename:,
59
+ # Content data specific to the channel type.
60
+ data:,
61
+ # Timestamp when the message content was created.
62
+ inserted_at:,
63
+ # The unique identifier for the message content.
64
+ message_id:
65
+ )
66
+ end
67
+
68
+ sig do
69
+ override.returns(
70
+ {
71
+ _typename: String,
72
+ data:
73
+ T.any(
74
+ Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
75
+ Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
76
+ Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
77
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
78
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
79
+ ),
80
+ inserted_at: Time,
81
+ message_id: String
82
+ }
83
+ )
84
+ end
85
+ def to_hash
86
+ end
87
+
88
+ # Content data specific to the channel type.
89
+ module Data
90
+ extend Knockapi::Internal::Type::Union
91
+
92
+ Variants =
93
+ T.type_alias do
94
+ T.any(
95
+ Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
96
+ Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
97
+ Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
98
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
99
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
100
+ )
101
+ end
102
+
103
+ class MessageEmailContent < Knockapi::Internal::Type::BaseModel
104
+ OrHash =
105
+ T.type_alias do
106
+ T.any(
107
+ Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
108
+ Knockapi::Internal::AnyHash
109
+ )
110
+ end
111
+
112
+ # The typename of the schema.
113
+ sig { returns(String) }
114
+ attr_accessor :_typename
115
+
116
+ # The sender's email address.
117
+ sig { returns(String) }
118
+ attr_accessor :from
119
+
120
+ # The HTML body of the email message.
121
+ sig { returns(String) }
122
+ attr_accessor :html_body
123
+
124
+ # The subject line of the email message.
125
+ sig { returns(String) }
126
+ attr_accessor :subject_line
127
+
128
+ # The text body of the email message.
129
+ sig { returns(String) }
130
+ attr_accessor :text_body
131
+
132
+ # The recipient's email address.
133
+ sig { returns(String) }
134
+ attr_accessor :to
135
+
136
+ # The BCC email addresses.
137
+ sig { returns(T.nilable(String)) }
138
+ attr_accessor :bcc
139
+
140
+ # The CC email addresses.
141
+ sig { returns(T.nilable(String)) }
142
+ attr_accessor :cc
143
+
144
+ # The reply-to email address.
145
+ sig { returns(T.nilable(String)) }
146
+ attr_accessor :reply_to
147
+
148
+ # The content of an email message.
149
+ sig do
150
+ params(
151
+ _typename: String,
152
+ from: String,
153
+ html_body: String,
154
+ subject_line: String,
155
+ text_body: String,
156
+ to: String,
157
+ bcc: T.nilable(String),
158
+ cc: T.nilable(String),
159
+ reply_to: T.nilable(String)
160
+ ).returns(T.attached_class)
161
+ end
162
+ def self.new(
163
+ # The typename of the schema.
164
+ _typename:,
165
+ # The sender's email address.
166
+ from:,
167
+ # The HTML body of the email message.
168
+ html_body:,
169
+ # The subject line of the email message.
170
+ subject_line:,
171
+ # The text body of the email message.
172
+ text_body:,
173
+ # The recipient's email address.
174
+ to:,
175
+ # The BCC email addresses.
176
+ bcc: nil,
177
+ # The CC email addresses.
178
+ cc: nil,
179
+ # The reply-to email address.
180
+ reply_to: nil
181
+ )
182
+ end
183
+
184
+ sig do
185
+ override.returns(
186
+ {
187
+ _typename: String,
188
+ from: String,
189
+ html_body: String,
190
+ subject_line: String,
191
+ text_body: String,
192
+ to: String,
193
+ bcc: T.nilable(String),
194
+ cc: T.nilable(String),
195
+ reply_to: T.nilable(String)
196
+ }
197
+ )
198
+ end
199
+ def to_hash
200
+ end
201
+ end
202
+
203
+ class MessageSMSContent < Knockapi::Internal::Type::BaseModel
204
+ OrHash =
205
+ T.type_alias do
206
+ T.any(
207
+ Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
208
+ Knockapi::Internal::AnyHash
209
+ )
210
+ end
211
+
212
+ # The typename of the schema.
213
+ sig { returns(String) }
214
+ attr_accessor :_typename
215
+
216
+ # The content body of the SMS message.
217
+ sig { returns(String) }
218
+ attr_accessor :body
219
+
220
+ # The phone number the SMS was sent to.
221
+ sig { returns(String) }
222
+ attr_accessor :to
223
+
224
+ # The content of an SMS message.
225
+ sig do
226
+ params(_typename: String, body: String, to: String).returns(
227
+ T.attached_class
228
+ )
229
+ end
230
+ def self.new(
231
+ # The typename of the schema.
232
+ _typename:,
233
+ # The content body of the SMS message.
234
+ body:,
235
+ # The phone number the SMS was sent to.
236
+ to:
237
+ )
238
+ end
239
+
240
+ sig do
241
+ override.returns({ _typename: String, body: String, to: String })
242
+ end
243
+ def to_hash
244
+ end
245
+ end
246
+
247
+ class MessagePushContent < Knockapi::Internal::Type::BaseModel
248
+ OrHash =
249
+ T.type_alias do
250
+ T.any(
251
+ Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
252
+ Knockapi::Internal::AnyHash
253
+ )
254
+ end
255
+
256
+ # The device token to send the push notification to.
257
+ sig { returns(String) }
258
+ attr_accessor :token
259
+
260
+ # The typename of the schema.
261
+ sig { returns(String) }
262
+ attr_accessor :_typename
263
+
264
+ # The content body of the push notification.
265
+ sig { returns(String) }
266
+ attr_accessor :body
267
+
268
+ # The title of the push notification.
269
+ sig { returns(String) }
270
+ attr_accessor :title
271
+
272
+ # Additional data payload for the push notification.
273
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
274
+ attr_accessor :data
275
+
276
+ # The content of a push notification.
277
+ sig do
278
+ params(
279
+ token: String,
280
+ _typename: String,
281
+ body: String,
282
+ title: String,
283
+ data: T.nilable(T::Hash[Symbol, T.anything])
284
+ ).returns(T.attached_class)
285
+ end
286
+ def self.new(
287
+ # The device token to send the push notification to.
288
+ token:,
289
+ # The typename of the schema.
290
+ _typename:,
291
+ # The content body of the push notification.
292
+ body:,
293
+ # The title of the push notification.
294
+ title:,
295
+ # Additional data payload for the push notification.
296
+ data: nil
297
+ )
298
+ end
299
+
300
+ sig do
301
+ override.returns(
302
+ {
303
+ token: String,
304
+ _typename: String,
305
+ body: String,
306
+ title: String,
307
+ data: T.nilable(T::Hash[Symbol, T.anything])
308
+ }
309
+ )
310
+ end
311
+ def to_hash
312
+ end
313
+ end
314
+
315
+ class MessageChatContent < Knockapi::Internal::Type::BaseModel
316
+ OrHash =
317
+ T.type_alias do
318
+ T.any(
319
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
320
+ Knockapi::Internal::AnyHash
321
+ )
322
+ end
323
+
324
+ # The typename of the schema.
325
+ sig { returns(String) }
326
+ attr_accessor :_typename
327
+
328
+ # The channel data connection from the recipient to the underlying provider.
329
+ sig { returns(T::Hash[Symbol, T.anything]) }
330
+ attr_accessor :connection
331
+
332
+ # The template structure for the chat message.
333
+ sig do
334
+ returns(
335
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template
336
+ )
337
+ end
338
+ attr_reader :template
339
+
340
+ sig do
341
+ params(
342
+ template:
343
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::OrHash
344
+ ).void
345
+ end
346
+ attr_writer :template
347
+
348
+ # Additional metadata associated with the chat message.
349
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
350
+ attr_accessor :metadata
351
+
352
+ # The content of a chat message.
353
+ sig do
354
+ params(
355
+ _typename: String,
356
+ connection: T::Hash[Symbol, T.anything],
357
+ template:
358
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::OrHash,
359
+ metadata: T.nilable(T::Hash[Symbol, T.anything])
360
+ ).returns(T.attached_class)
361
+ end
362
+ def self.new(
363
+ # The typename of the schema.
364
+ _typename:,
365
+ # The channel data connection from the recipient to the underlying provider.
366
+ connection:,
367
+ # The template structure for the chat message.
368
+ template:,
369
+ # Additional metadata associated with the chat message.
370
+ metadata: nil
371
+ )
372
+ end
373
+
374
+ sig do
375
+ override.returns(
376
+ {
377
+ _typename: String,
378
+ connection: T::Hash[Symbol, T.anything],
379
+ template:
380
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template,
381
+ metadata: T.nilable(T::Hash[Symbol, T.anything])
382
+ }
383
+ )
384
+ end
385
+ def to_hash
386
+ end
387
+
388
+ class Template < Knockapi::Internal::Type::BaseModel
389
+ OrHash =
390
+ T.type_alias do
391
+ T.any(
392
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template,
393
+ Knockapi::Internal::AnyHash
394
+ )
395
+ end
396
+
397
+ # The blocks of the message in a chat.
398
+ sig do
399
+ returns(
400
+ T.nilable(
401
+ T::Array[
402
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block
403
+ ]
404
+ )
405
+ )
406
+ end
407
+ attr_accessor :blocks
408
+
409
+ # The JSON content of the message.
410
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
411
+ attr_accessor :json_content
412
+
413
+ # The summary of the chat message.
414
+ sig { returns(T.nilable(String)) }
415
+ attr_accessor :summary
416
+
417
+ # The template structure for the chat message.
418
+ sig do
419
+ params(
420
+ blocks:
421
+ T.nilable(
422
+ T::Array[
423
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::OrHash
424
+ ]
425
+ ),
426
+ json_content: T.nilable(T::Hash[Symbol, T.anything]),
427
+ summary: T.nilable(String)
428
+ ).returns(T.attached_class)
429
+ end
430
+ def self.new(
431
+ # The blocks of the message in a chat.
432
+ blocks: nil,
433
+ # The JSON content of the message.
434
+ json_content: nil,
435
+ # The summary of the chat message.
436
+ summary: nil
437
+ )
438
+ end
439
+
440
+ sig do
441
+ override.returns(
442
+ {
443
+ blocks:
444
+ T.nilable(
445
+ T::Array[
446
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block
447
+ ]
448
+ ),
449
+ json_content: T.nilable(T::Hash[Symbol, T.anything]),
450
+ summary: T.nilable(String)
451
+ }
452
+ )
453
+ end
454
+ def to_hash
455
+ end
456
+
457
+ class Block < Knockapi::Internal::Type::BaseModel
458
+ OrHash =
459
+ T.type_alias do
460
+ T.any(
461
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block,
462
+ Knockapi::Internal::AnyHash
463
+ )
464
+ end
465
+
466
+ # The actual content of the block.
467
+ sig { returns(String) }
468
+ attr_accessor :content
469
+
470
+ # The name of the block for identification.
471
+ sig { returns(String) }
472
+ attr_accessor :name
473
+
474
+ # The type of block in a message in a chat (text or markdown).
475
+ sig do
476
+ returns(
477
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
478
+ )
479
+ end
480
+ attr_accessor :type
481
+
482
+ # A block in a message in a chat.
483
+ sig do
484
+ params(
485
+ content: String,
486
+ name: String,
487
+ type:
488
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::OrSymbol
489
+ ).returns(T.attached_class)
490
+ end
491
+ def self.new(
492
+ # The actual content of the block.
493
+ content:,
494
+ # The name of the block for identification.
495
+ name:,
496
+ # The type of block in a message in a chat (text or markdown).
497
+ type:
498
+ )
499
+ end
500
+
501
+ sig do
502
+ override.returns(
503
+ {
504
+ content: String,
505
+ name: String,
506
+ type:
507
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
508
+ }
509
+ )
510
+ end
511
+ def to_hash
512
+ end
513
+
514
+ # The type of block in a message in a chat (text or markdown).
515
+ module Type
516
+ extend Knockapi::Internal::Type::Enum
517
+
518
+ TaggedSymbol =
519
+ T.type_alias do
520
+ T.all(
521
+ Symbol,
522
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type
523
+ )
524
+ end
525
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
526
+
527
+ TEXT =
528
+ T.let(
529
+ :text,
530
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
531
+ )
532
+ MARKDOWN =
533
+ T.let(
534
+ :markdown,
535
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
536
+ )
537
+
538
+ sig do
539
+ override.returns(
540
+ T::Array[
541
+ Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
542
+ ]
543
+ )
544
+ end
545
+ def self.values
546
+ end
547
+ end
548
+ end
549
+ end
550
+ end
551
+
552
+ class MessageInAppFeedContent < Knockapi::Internal::Type::BaseModel
553
+ OrHash =
554
+ T.type_alias do
555
+ T.any(
556
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent,
557
+ Knockapi::Internal::AnyHash
558
+ )
559
+ end
560
+
561
+ # The typename of the schema.
562
+ sig { returns(String) }
563
+ attr_accessor :_typename
564
+
565
+ # The blocks of the message in an app feed.
566
+ sig do
567
+ returns(
568
+ T::Array[
569
+ T.any(
570
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
571
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
572
+ )
573
+ ]
574
+ )
575
+ end
576
+ attr_accessor :blocks
577
+
578
+ # The content of an in-app feed message.
579
+ sig do
580
+ params(
581
+ _typename: String,
582
+ blocks:
583
+ T::Array[
584
+ T.any(
585
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::OrHash,
586
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::OrHash
587
+ )
588
+ ]
589
+ ).returns(T.attached_class)
590
+ end
591
+ def self.new(
592
+ # The typename of the schema.
593
+ _typename:,
594
+ # The blocks of the message in an app feed.
595
+ blocks:
596
+ )
597
+ end
598
+
599
+ sig do
600
+ override.returns(
601
+ {
602
+ _typename: String,
603
+ blocks:
604
+ T::Array[
605
+ T.any(
606
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
607
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
608
+ )
609
+ ]
610
+ }
611
+ )
612
+ end
613
+ def to_hash
614
+ end
615
+
616
+ # A block in a message in an app feed.
617
+ module Block
618
+ extend Knockapi::Internal::Type::Union
619
+
620
+ Variants =
621
+ T.type_alias do
622
+ T.any(
623
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
624
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
625
+ )
626
+ end
627
+
628
+ class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
629
+ OrHash =
630
+ T.type_alias do
631
+ T.any(
632
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
633
+ Knockapi::Internal::AnyHash
634
+ )
635
+ end
636
+
637
+ # The content of the block in a message in an app feed.
638
+ sig { returns(String) }
639
+ attr_accessor :content
640
+
641
+ # The name of the block in a message in an app feed.
642
+ sig { returns(String) }
643
+ attr_accessor :name
644
+
645
+ # The rendered HTML version of the content.
646
+ sig { returns(String) }
647
+ attr_accessor :rendered
648
+
649
+ # The type of block in a message in an app feed.
650
+ sig do
651
+ returns(
652
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
653
+ )
654
+ end
655
+ attr_accessor :type
656
+
657
+ # A block in a message in an app feed.
658
+ sig do
659
+ params(
660
+ content: String,
661
+ name: String,
662
+ rendered: String,
663
+ type:
664
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::OrSymbol
665
+ ).returns(T.attached_class)
666
+ end
667
+ def self.new(
668
+ # The content of the block in a message in an app feed.
669
+ content:,
670
+ # The name of the block in a message in an app feed.
671
+ name:,
672
+ # The rendered HTML version of the content.
673
+ rendered:,
674
+ # The type of block in a message in an app feed.
675
+ type:
676
+ )
677
+ end
678
+
679
+ sig do
680
+ override.returns(
681
+ {
682
+ content: String,
683
+ name: String,
684
+ rendered: String,
685
+ type:
686
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
687
+ }
688
+ )
689
+ end
690
+ def to_hash
691
+ end
692
+
693
+ # The type of block in a message in an app feed.
694
+ module Type
695
+ extend Knockapi::Internal::Type::Enum
696
+
697
+ TaggedSymbol =
698
+ T.type_alias do
699
+ T.all(
700
+ Symbol,
701
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type
702
+ )
703
+ end
704
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
705
+
706
+ MARKDOWN =
707
+ T.let(
708
+ :markdown,
709
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
710
+ )
711
+ TEXT =
712
+ T.let(
713
+ :text,
714
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
715
+ )
716
+
717
+ sig do
718
+ override.returns(
719
+ T::Array[
720
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
721
+ ]
722
+ )
723
+ end
724
+ def self.values
725
+ end
726
+ end
727
+ end
728
+
729
+ class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
730
+ OrHash =
731
+ T.type_alias do
732
+ T.any(
733
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock,
734
+ Knockapi::Internal::AnyHash
735
+ )
736
+ end
737
+
738
+ # A list of buttons in an in app feed message.
739
+ sig do
740
+ returns(
741
+ T::Array[
742
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button
743
+ ]
744
+ )
745
+ end
746
+ attr_accessor :buttons
747
+
748
+ # The name of the button set in a message in an app feed.
749
+ sig { returns(String) }
750
+ attr_accessor :name
751
+
752
+ # The type of block in a message in an app feed.
753
+ sig do
754
+ returns(
755
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
756
+ )
757
+ end
758
+ attr_accessor :type
759
+
760
+ # A button set block in a message in an app feed.
761
+ sig do
762
+ params(
763
+ buttons:
764
+ T::Array[
765
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button::OrHash
766
+ ],
767
+ name: String,
768
+ type:
769
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::OrSymbol
770
+ ).returns(T.attached_class)
771
+ end
772
+ def self.new(
773
+ # A list of buttons in an in app feed message.
774
+ buttons:,
775
+ # The name of the button set in a message in an app feed.
776
+ name:,
777
+ # The type of block in a message in an app feed.
778
+ type:
779
+ )
780
+ end
781
+
782
+ sig do
783
+ override.returns(
784
+ {
785
+ buttons:
786
+ T::Array[
787
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button
788
+ ],
789
+ name: String,
790
+ type:
791
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
792
+ }
793
+ )
794
+ end
795
+ def to_hash
796
+ end
797
+
798
+ class Button < Knockapi::Internal::Type::BaseModel
799
+ OrHash =
800
+ T.type_alias do
801
+ T.any(
802
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button,
803
+ Knockapi::Internal::AnyHash
804
+ )
805
+ end
806
+
807
+ # The action to take when the button is clicked.
808
+ sig { returns(String) }
809
+ attr_accessor :action
810
+
811
+ # The label of the button.
812
+ sig { returns(String) }
813
+ attr_accessor :label
814
+
815
+ # The name of the button.
816
+ sig { returns(String) }
817
+ attr_accessor :name
818
+
819
+ # A button in an in app feed message.
820
+ sig do
821
+ params(action: String, label: String, name: String).returns(
822
+ T.attached_class
823
+ )
824
+ end
825
+ def self.new(
826
+ # The action to take when the button is clicked.
827
+ action:,
828
+ # The label of the button.
829
+ label:,
830
+ # The name of the button.
831
+ name:
832
+ )
833
+ end
834
+
835
+ sig do
836
+ override.returns(
837
+ { action: String, label: String, name: String }
838
+ )
839
+ end
840
+ def to_hash
841
+ end
842
+ end
843
+
844
+ # The type of block in a message in an app feed.
845
+ module Type
846
+ extend Knockapi::Internal::Type::Enum
847
+
848
+ TaggedSymbol =
849
+ T.type_alias do
850
+ T.all(
851
+ Symbol,
852
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type
853
+ )
854
+ end
855
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
856
+
857
+ BUTTON_SET =
858
+ T.let(
859
+ :button_set,
860
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
861
+ )
862
+
863
+ sig do
864
+ override.returns(
865
+ T::Array[
866
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
867
+ ]
868
+ )
869
+ end
870
+ def self.values
871
+ end
872
+ end
873
+ end
874
+
875
+ sig do
876
+ override.returns(
877
+ T::Array[
878
+ Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::Variants
879
+ ]
880
+ )
881
+ end
882
+ def self.variants
883
+ end
884
+ end
885
+ end
886
+
887
+ sig do
888
+ override.returns(
889
+ T::Array[
890
+ Knockapi::Models::MessageGetContentResponse::Data::Variants
891
+ ]
892
+ )
893
+ end
894
+ def self.variants
895
+ end
896
+ end
897
+ end
898
+ end
899
+ end