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