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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 02b5965b9c39219da8275caf8ea54d22451c919330a110155657f1dbc5fa480c
4
- data.tar.gz: b43840005837b8649093bbb354b82f5401afcfcb260adb93c175a3837206f7dd
3
+ metadata.gz: c57d893d557fe8c19367b85213334576858a8024857ea969f05f0dd2368d9b8c
4
+ data.tar.gz: 3becb6c5c1d4cd3abd4a48a5abb818b035e1771651afd4172641bf228b336a83
5
5
  SHA512:
6
- metadata.gz: 8ffbb9e5354ab085a0e1551d689847d3f6cb5ee9ad3ec0c765cbf54943cac5c3e1b663848a2c21395e8d83dd32838e0c2b0f9a1c88ad1bd38b7f37f6a149ce60
7
- data.tar.gz: a904c79300bdd5f979520191dc2d10321814ba231243a74f2c8a1a093df9f21952bda7c4833a0d91fae529320f825bc09858aa5a97a60f6c4de58349de797ea9
6
+ metadata.gz: 3241238cd0cc508b9c967d0f035b036483d1a1e774d84409adc91632b1629927079074c5692a8ef231dfe0bbdb68e227687da1e7f0d96124545a04f269388c4a
7
+ data.tar.gz: 89c50a639748a21f1733a174bc65017286875121414669dca2074d98d457796e7e96eddd5241a6b43c6efe2e8d31eecb73adfb0251ac836b8f90c0e0bdba038d
data/.ignore ADDED
@@ -0,0 +1,2 @@
1
+ rbi/*
2
+ sig/*
data/CHANGELOG.md ADDED
@@ -0,0 +1,61 @@
1
+ # Changelog
2
+
3
+ ## 1.1.0 (2025-05-15)
4
+
5
+ Full Changelog: [v1.0.0...v1.1.0](https://github.com/knocklabs/knock-ruby/compare/v1.0.0...v1.1.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([02959e8](https://github.com/knocklabs/knock-ruby/commit/02959e82c2148f3a1a3e9e6021d48298644305e9))
10
+ * **api:** api update ([6bc31c4](https://github.com/knocklabs/knock-ruby/commit/6bc31c4a6c0a81e096267f1c5a1cb3a9f8b29dac))
11
+ * **api:** removes duplicate activities section ([e83c36e](https://github.com/knocklabs/knock-ruby/commit/e83c36e5c6e88a457f7306ab7515d03c1ae0a7bc))
12
+ * bump default connection pool size limit to minimum of 99 ([b04fe89](https://github.com/knocklabs/knock-ruby/commit/b04fe8949b02a6f56979748226d24b2a30e2ea62))
13
+ * expose base client options as read only attributes ([4f7b9a2](https://github.com/knocklabs/knock-ruby/commit/4f7b9a248aed50a6b0077a5db4f34b764f86ffd5))
14
+ * expose recursive `#to_h` conversion ([153be54](https://github.com/knocklabs/knock-ruby/commit/153be54a04fd0b2ac0dd27278d96be70cc87b1e1))
15
+ * support sorbet aliases at the runtime ([5e9d146](https://github.com/knocklabs/knock-ruby/commit/5e9d146ae0303f729ebeb949d0d6bb4a9943e4be))
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * **internal:** ensure formatting always uses c.utf-8 locale ([9f8e834](https://github.com/knocklabs/knock-ruby/commit/9f8e8345f2206a5b060d55838f9e22226fa47589))
21
+ * **internal:** fix formatting script for macos ([11e651e](https://github.com/knocklabs/knock-ruby/commit/11e651eaea730816e2a558cf708382eed559a71c))
22
+ * **internal:** update gemspec name ([2a1af3a](https://github.com/knocklabs/knock-ruby/commit/2a1af3a8e6f8dbea4f448ce3acbdf694f993aea8))
23
+
24
+
25
+ ### Chores
26
+
27
+ * accept all nd-json mimetype variants ([f13a7aa](https://github.com/knocklabs/knock-ruby/commit/f13a7aa66b6ef36d0d044cea3674bfeef1f18ac2))
28
+ * always check if current page is empty in `next_page?` ([b43503c](https://github.com/knocklabs/knock-ruby/commit/b43503c22d1c7ca08adcf1f8a01d3d3c48608962))
29
+ * fix misc linting / minor issues ([4d8eadc](https://github.com/knocklabs/knock-ruby/commit/4d8eadcee14d85c3eb7f95b0417b74d932b344ad))
30
+ * **internal:** codegen related update ([1ab97b3](https://github.com/knocklabs/knock-ruby/commit/1ab97b344adc1bebd79bef05e33bf825500e91e2))
31
+ * **internal:** codegen related update ([1cdabfe](https://github.com/knocklabs/knock-ruby/commit/1cdabfed4481b5bc2f1892647c604f37ec4f201b))
32
+ * re-export top level models under library namespace ([a2bbf55](https://github.com/knocklabs/knock-ruby/commit/a2bbf558687ac11cdb6d72e9d54c47e0a8998e7b))
33
+ * remove Gemfile.lock during bootstrap ([b0ad2cd](https://github.com/knocklabs/knock-ruby/commit/b0ad2cd268ff2f6fe6f96d8cf1baa7296287eec4))
34
+ * reorganize type aliases ([c50a167](https://github.com/knocklabs/knock-ruby/commit/c50a16701c7a044b1b0b5c2b6aefffe2fc1eb102))
35
+ * revert ignoring Gemfile.lock ([c005465](https://github.com/knocklabs/knock-ruby/commit/c0054656e506496ba90c6c3b68c18e2017531fec))
36
+ * validate request option coercion correctness ([611e596](https://github.com/knocklabs/knock-ruby/commit/611e5969960440e4004a73158af6a26da4fb4755))
37
+
38
+
39
+ ### Documentation
40
+
41
+ * illustrate environmental defaults for auth variables ([a6de609](https://github.com/knocklabs/knock-ruby/commit/a6de609be150aa0d64298b0cb8a696c27c3f724c))
42
+ * rewrite much of README.md for readability ([0530377](https://github.com/knocklabs/knock-ruby/commit/0530377bd49cb6e65155c36ed30239fa64b3bc7b))
43
+
44
+ ## 1.0.0 (2025-05-01)
45
+
46
+ Full Changelog: [v0.6.2...v1.0.0](https://github.com/knocklabs/knock-ruby/compare/v0.6.2...v1.0.0)
47
+
48
+ ### Features
49
+
50
+ * **api:** manual updates ([0d8043c](https://github.com/knocklabs/knock-ruby/commit/0d8043c40d338254cffd95c5bf060c31e01df817))
51
+ * **api:** manual updates ([4653cd4](https://github.com/knocklabs/knock-ruby/commit/4653cd4dc7b6f2350040335188c828248b91ac8e))
52
+ * **api:** manual updates ([5db7143](https://github.com/knocklabs/knock-ruby/commit/5db71437a429d5c23a01679ca17c7bd33e76927b))
53
+
54
+
55
+ ### Chores
56
+
57
+ * sync repo ([603bdff](https://github.com/knocklabs/knock-ruby/commit/603bdff217b859fa636333ee19f4e8a0099a2829))
58
+ * update SDK settings ([f89c129](https://github.com/knocklabs/knock-ruby/commit/f89c129b79de76e1b69b99d53c036ea5081d1198))
59
+ * update SDK settings ([02bbb1c](https://github.com/knocklabs/knock-ruby/commit/02bbb1cdd204dc68f5c70ac979ac08679dcdbbec))
60
+ * update SDK settings ([5feae14](https://github.com/knocklabs/knock-ruby/commit/5feae14501d46021f9f5bfd9da198816a9fb680e))
61
+ * update SDK settings ([bdd01f1](https://github.com/knocklabs/knock-ruby/commit/bdd01f128840d10797e51673a3caf66f70adc033))
data/README.md CHANGED
@@ -1,148 +1,263 @@
1
- # Knock Ruby library
1
+ # Knock Ruby API library
2
2
 
3
- Knock API access for applications written in Ruby.
3
+ The Knock Ruby library provides convenient access to the Knock REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/knocklabs/knock-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
4
+
5
+ It is generated with [Stainless](https://www.stainless.com/).
4
6
 
5
7
  ## Documentation
6
8
 
7
- See the documentation for Ruby usage examples.
9
+ Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/knockapi).
10
+
11
+ The REST API documentation can be found on [docs.knock.app](https://docs.knock.app).
8
12
 
9
13
  ## Installation
10
14
 
11
- ```bash
12
- gem install knockapi
15
+ To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
16
+
17
+ <!-- x-release-please-start-version -->
18
+
19
+ ```ruby
20
+ gem "knockapi", "~> 1.1.0"
13
21
  ```
14
22
 
15
- ## Configuration
23
+ <!-- x-release-please-end -->
24
+
25
+ ## Usage
26
+
27
+ ```ruby
28
+ require "bundler/setup"
29
+ require "knockapi"
16
30
 
17
- To use the library you must provide a secret API key, provided in the Knock dashboard.
31
+ knock = Knockapi::Client.new(
32
+ api_key: ENV["KNOCK_API_KEY"] # This is the default and can be omitted
33
+ )
18
34
 
19
- You can set it as an environment variable:
35
+ response = knock.workflows.trigger("dinosaurs-loose", recipients: ["dnedry"], data: {dinosaur: "triceratops"})
20
36
 
21
- ```bash
22
- KNOCK_API_KEY="sk_12345"
37
+ puts(response.workflow_run_id)
23
38
  ```
24
39
 
25
- Or, you may set the key yourself in an initializer:
40
+ ### Pagination
41
+
42
+ List methods in the Knock API are paginated.
43
+
44
+ This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
26
45
 
27
46
  ```ruby
28
- # /config/initializers/knock.rb
29
- Knock.configure do |config|
30
- config.key = '[your api key]'
31
- config.timeout = 120
47
+ page = knock.users.list
48
+
49
+ # Fetch single item from page.
50
+ user = page.entries[0]
51
+ puts(user.id)
52
+
53
+ # Automatically fetches more pages as needed.
54
+ page.auto_paging_each do |user|
55
+ puts(user.id)
32
56
  end
33
57
  ```
34
58
 
35
- ## Usage
59
+ Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
36
60
 
37
- ### Identifying users
61
+ ```ruby
62
+ if page.next_page?
63
+ new_page = page.next_page
64
+ puts(new_page.entries[0].id)
65
+ end
66
+ ```
67
+
68
+ ### Handling errors
69
+
70
+ When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Knockapi::Errors::APIError` will be thrown:
38
71
 
39
72
  ```ruby
40
- Knock::Users.identify(
41
- id: "jhammond",
42
- data: {
43
- name: "John Hammond",
44
- email: "jhammond@ingen.net",
45
- }
46
- )
73
+ begin
74
+ user = knock.users.get("dnedry")
75
+ rescue Knockapi::Errors::APIConnectionError => e
76
+ puts("The server could not be reached")
77
+ puts(e.cause) # an underlying Exception, likely raised within `net/http`
78
+ rescue Knockapi::Errors::RateLimitError => e
79
+ puts("A 429 status code was received; we should back off a bit.")
80
+ rescue Knockapi::Errors::APIStatusError => e
81
+ puts("Another non-200-range status code was received")
82
+ puts(e.status)
83
+ end
47
84
  ```
48
85
 
49
- ### Sending notifies (triggering workflows)
86
+ Error codes are as follows:
87
+
88
+ | Cause | Error Type |
89
+ | ---------------- | -------------------------- |
90
+ | HTTP 400 | `BadRequestError` |
91
+ | HTTP 401 | `AuthenticationError` |
92
+ | HTTP 403 | `PermissionDeniedError` |
93
+ | HTTP 404 | `NotFoundError` |
94
+ | HTTP 409 | `ConflictError` |
95
+ | HTTP 422 | `UnprocessableEntityError` |
96
+ | HTTP 429 | `RateLimitError` |
97
+ | HTTP >= 500 | `InternalServerError` |
98
+ | Other HTTP error | `APIStatusError` |
99
+ | Timeout | `APITimeoutError` |
100
+ | Network error | `APIConnectionError` |
101
+
102
+ ### Retries
103
+
104
+ Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
105
+
106
+ Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
107
+
108
+ You can use the `max_retries` option to configure or disable this:
50
109
 
51
110
  ```ruby
52
- # The key of the workflow (from Knock dashboard)
53
- Knock::Workflows.trigger(
54
- key: "dinosaurs-loose",
55
- # user id of who performed the action
56
- actor: "dnedry",
57
- # list of user ids for who should receive the notif
58
- recipients: ["jhammond", "agrant", "imalcolm", "esattler"],
59
- # data payload to send through
60
- data: {
61
- type: "trex",
62
- priority: 1,
63
- },
64
- # an optional key to provide to cancel a notify
65
- cancellation_key: trigger_alert.id,
111
+ # Configure the default for all requests:
112
+ knock = Knockapi::Client.new(
113
+ max_retries: 0 # default is 2
66
114
  )
115
+
116
+ # Or, configure per-request:
117
+ knock.users.get("dnedry", request_options: {max_retries: 5})
67
118
  ```
68
119
 
69
- ### Retrieving users
120
+ ### Timeouts
121
+
122
+ By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
70
123
 
71
124
  ```ruby
72
- Knock::Users.get(id: "jhammond")
125
+ # Configure the default for all requests:
126
+ knock = Knockapi::Client.new(
127
+ timeout: nil # default is 60
128
+ )
129
+
130
+ # Or, configure per-request:
131
+ knock.users.get("dnedry", request_options: {timeout: 5})
73
132
  ```
74
133
 
75
- ### Deleting users
134
+ On timeout, `Knockapi::Errors::APITimeoutError` is raised.
135
+
136
+ Note that requests that time out are retried by default.
137
+
138
+ ## Advanced concepts
139
+
140
+ ### BaseModel
141
+
142
+ All parameter and response objects inherit from `Knockapi::Internal::Type::BaseModel`, which provides several conveniences, including:
143
+
144
+ 1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
145
+
146
+ 2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
147
+
148
+ 3. Both instances and the classes themselves can be pretty-printed.
149
+
150
+ 4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
151
+
152
+ ### Making custom or undocumented requests
153
+
154
+ #### Undocumented properties
155
+
156
+ You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
157
+
158
+ Note: the `extra_` parameters of the same name overrides the documented parameters.
76
159
 
77
160
  ```ruby
78
- Knock::Users.delete(id: "jhammond")
161
+ user =
162
+ knock.users.get(
163
+ "dnedry",
164
+ request_options: {
165
+ extra_query: {my_query_parameter: value},
166
+ extra_body: {my_body_parameter: value},
167
+ extra_headers: {"my-header": value}
168
+ }
169
+ )
170
+
171
+ puts(user[:my_undocumented_property])
79
172
  ```
80
173
 
81
- ### Preferences
174
+ #### Undocumented request params
175
+
176
+ If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
177
+
178
+ #### Undocumented endpoints
179
+
180
+ To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
82
181
 
83
182
  ```ruby
84
- # Set an entire preference set
85
- Knock::Users.set_preferences(
86
- user_id: "jhammond",
87
- channel_types: { email: true, sms: false },
88
- workflows: {
89
- 'dinosaurs-loose': {
90
- channel_types: { email: false, in_app_feed: false }
91
- }
92
- }
183
+ response = client.request(
184
+ method: :post,
185
+ path: '/undocumented/endpoint',
186
+ query: {"dog": "woof"},
187
+ headers: {"useful-header": "interesting-value"},
188
+ body: {"hello": "world"}
93
189
  )
190
+ ```
191
+
192
+ ### Concurrency & connection pooling
193
+
194
+ The `Knockapi::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
195
+
196
+ Each instance of `Knockapi::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
94
197
 
95
- # Get an entire preference set
96
- Knock::Users.get_preferences(user_id: "jhammond")
198
+ When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
199
+
200
+ Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
201
+
202
+ ## Sorbet
203
+
204
+ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
205
+
206
+ You can provide typesafe request parameters like so:
207
+
208
+ ```ruby
209
+ knock.workflows.trigger("dinosaurs-loose", recipients: ["dnedry"], data: {dinosaur: "triceratops"})
97
210
  ```
98
211
 
99
- ### Getting and setting channel data
212
+ Or, equivalently:
100
213
 
101
214
  ```ruby
102
- # Set channel data for an APNS
103
- Knock::Users.set_channel_data(
104
- id: "jhammond",
105
- channel_id: KNOCK_APNS_CHANNEL_ID,
106
- channel_data: {
107
- 'tokens': [apns_token]
108
- }
109
- )
215
+ # Hashes work, but are not typesafe:
216
+ knock.workflows.trigger("dinosaurs-loose", recipients: ["dnedry"], data: {dinosaur: "triceratops"})
110
217
 
111
- # Get channel data for the APNS channel
112
- Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNEL_ID)
218
+ # You can also splat a full Params class:
219
+ params = Knockapi::WorkflowTriggerParams.new(recipients: ["dnedry"], data: {dinosaur: "triceratops"})
220
+ knock.workflows.trigger("dinosaurs-loose", **params)
113
221
  ```
114
222
 
115
- ### Cancelling workflows
223
+ ### Enums
224
+
225
+ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
116
226
 
117
227
  ```ruby
118
- Knock::Workflows.cancel(
119
- key: "dinosaurs-loose",
120
- cancellation_key: trigger_alert.id,
121
- # Optionally, you can provide recipients to cancel for
122
- recipients: ["jhammond"]
228
+ # :exclude
229
+ puts(Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE)
230
+
231
+ # Revealed type: `T.all(Knockapi::Users::FeedListItemsParams::Archived, Symbol)`
232
+ T.reveal_type(Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE)
233
+ ```
234
+
235
+ Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
236
+
237
+ ```ruby
238
+ # Using the enum constants preserves the tagged type information:
239
+ knock.users.feeds.list_items(
240
+ archived: Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE,
241
+ # …
242
+ )
243
+
244
+ # Literal values is also permissible:
245
+ knock.users.feeds.list_items(
246
+ archived: :exclude,
247
+ # …
123
248
  )
124
249
  ```
125
250
 
126
- ### Signing JWTs
251
+ ## Versioning
127
252
 
128
- You can use the `jwt` gem to sign JWTs easily. You will need to generate an environment specific signing key, which you can find in the Knock dashboard.
253
+ This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
129
254
 
130
- If you're using a signing token you will need to pass this to your client to perform authentication. You can read more about [clientside authentication here](https://docs.knock.app/client-integration/authenticating-users).
255
+ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
131
256
 
132
- ```ruby
133
- require 'jwt'
257
+ ## Requirements
134
258
 
135
- secret = ENV['KNOCK_SIGNING_KEY']
136
- now = Time.now.to_i
259
+ Ruby 3.2.0 or higher.
137
260
 
138
- payload = {
139
- # The subject of the token
140
- sub: 'jhammond',
141
- # When the token was issued
142
- iat: now,
143
- # Expire the token in 1 week
144
- exp: now + (24 * 7 * 3600)
145
- }
261
+ ## Contributing
146
262
 
147
- JWT.encode(payload, secret, 'RS256')
148
- ```
263
+ See [the contributing documentation](https://github.com/knocklabs/knock-ruby/tree/main/CONTRIBUTING.md).
data/SECURITY.md ADDED
@@ -0,0 +1,27 @@
1
+ # Security Policy
2
+
3
+ ## Reporting Security Issues
4
+
5
+ This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
6
+
7
+ To report a security issue, please contact the Stainless team at security@stainless.com.
8
+
9
+ ## Responsible Disclosure
10
+
11
+ We appreciate the efforts of security researchers and individuals who help us maintain the security of
12
+ SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
13
+ disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
14
+ before making any information public.
15
+
16
+ ## Reporting Non-SDK Related Security Issues
17
+
18
+ If you encounter security issues that are not directly related to SDKs but pertain to the services
19
+ or products provided by Knock please follow the respective company's security reporting guidelines.
20
+
21
+ ### Knock Terms and Policies
22
+
23
+ Please contact security@knock.app for any questions or concerns regarding security of our services.
24
+
25
+ ---
26
+
27
+ Thank you for helping us keep the SDKs and systems they interact with secure.
@@ -0,0 +1,122 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Knockapi
4
+ class Client < Knockapi::Internal::Transport::BaseClient
5
+ # Default max number of retries to attempt after a failed retryable request.
6
+ DEFAULT_MAX_RETRIES = 2
7
+
8
+ # Default per-request timeout.
9
+ DEFAULT_TIMEOUT_IN_SECONDS = 60.0
10
+
11
+ # Default initial retry delay in seconds.
12
+ # Overall delay is calculated using exponential backoff + jitter.
13
+ DEFAULT_INITIAL_RETRY_DELAY = 0.5
14
+
15
+ # Default max retry delay in seconds.
16
+ DEFAULT_MAX_RETRY_DELAY = 8.0
17
+
18
+ # @return [String]
19
+ attr_reader :api_key
20
+
21
+ # @return [Knockapi::Resources::Shared]
22
+ attr_reader :shared
23
+
24
+ # @return [Knockapi::Resources::Recipients]
25
+ attr_reader :recipients
26
+
27
+ # @return [Knockapi::Resources::Users]
28
+ attr_reader :users
29
+
30
+ # @return [Knockapi::Resources::Objects]
31
+ attr_reader :objects
32
+
33
+ # @return [Knockapi::Resources::Tenants]
34
+ attr_reader :tenants
35
+
36
+ # @return [Knockapi::Resources::BulkOperations]
37
+ attr_reader :bulk_operations
38
+
39
+ # @return [Knockapi::Resources::Messages]
40
+ attr_reader :messages
41
+
42
+ # @return [Knockapi::Resources::Providers]
43
+ attr_reader :providers
44
+
45
+ # @return [Knockapi::Resources::Integrations]
46
+ attr_reader :integrations
47
+
48
+ # @return [Knockapi::Resources::Workflows]
49
+ attr_reader :workflows
50
+
51
+ # @return [Knockapi::Resources::Schedules]
52
+ attr_reader :schedules
53
+
54
+ # @return [Knockapi::Resources::Channels]
55
+ attr_reader :channels
56
+
57
+ # @return [Knockapi::Resources::Audiences]
58
+ attr_reader :audiences
59
+
60
+ # @api private
61
+ #
62
+ # @return [Hash{String=>String}]
63
+ private def auth_headers
64
+ return {} if @api_key.nil?
65
+
66
+ {"authorization" => "Bearer #{@api_key}"}
67
+ end
68
+
69
+ # Creates and returns a new client for interacting with the API.
70
+ #
71
+ # @param api_key [String, nil] Defaults to `ENV["KNOCK_API_KEY"]`
72
+ #
73
+ # @param base_url [String, nil] Override the default base URL for the API, e.g.,
74
+ # `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
75
+ #
76
+ # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
77
+ #
78
+ # @param timeout [Float]
79
+ #
80
+ # @param initial_retry_delay [Float]
81
+ #
82
+ # @param max_retry_delay [Float]
83
+ def initialize(
84
+ api_key: ENV["KNOCK_API_KEY"],
85
+ base_url: ENV["KNOCK_BASE_URL"],
86
+ max_retries: self.class::DEFAULT_MAX_RETRIES,
87
+ timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
88
+ initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
89
+ max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
90
+ )
91
+ base_url ||= "https://api.knock.app"
92
+
93
+ if api_key.nil?
94
+ raise ArgumentError.new("api_key is required, and can be set via environ: \"KNOCK_API_KEY\"")
95
+ end
96
+
97
+ @api_key = api_key.to_s
98
+
99
+ super(
100
+ base_url: base_url,
101
+ timeout: timeout,
102
+ max_retries: max_retries,
103
+ initial_retry_delay: initial_retry_delay,
104
+ max_retry_delay: max_retry_delay
105
+ )
106
+
107
+ @shared = Knockapi::Resources::Shared.new(client: self)
108
+ @recipients = Knockapi::Resources::Recipients.new(client: self)
109
+ @users = Knockapi::Resources::Users.new(client: self)
110
+ @objects = Knockapi::Resources::Objects.new(client: self)
111
+ @tenants = Knockapi::Resources::Tenants.new(client: self)
112
+ @bulk_operations = Knockapi::Resources::BulkOperations.new(client: self)
113
+ @messages = Knockapi::Resources::Messages.new(client: self)
114
+ @providers = Knockapi::Resources::Providers.new(client: self)
115
+ @integrations = Knockapi::Resources::Integrations.new(client: self)
116
+ @workflows = Knockapi::Resources::Workflows.new(client: self)
117
+ @schedules = Knockapi::Resources::Schedules.new(client: self)
118
+ @channels = Knockapi::Resources::Channels.new(client: self)
119
+ @audiences = Knockapi::Resources::Audiences.new(client: self)
120
+ end
121
+ end
122
+ end