trycourier 4.7.1 → 4.9.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 (418) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +63 -0
  3. data/README.md +25 -235
  4. data/lib/courier/client.rb +12 -0
  5. data/lib/courier/internal/util.rb +50 -6
  6. data/lib/courier/models/audience_delete_params.rb +7 -1
  7. data/lib/courier/models/audience_list_members_params.rb +8 -1
  8. data/lib/courier/models/audience_retrieve_params.rb +7 -1
  9. data/lib/courier/models/audience_update_params.rb +8 -1
  10. data/lib/courier/models/audit_event_retrieve_params.rb +7 -1
  11. data/lib/courier/models/automations/invoke_invoke_by_template_params.rb +7 -1
  12. data/lib/courier/models/brand_delete_params.rb +7 -1
  13. data/lib/courier/models/brand_retrieve_params.rb +7 -1
  14. data/lib/courier/models/brand_update_params.rb +8 -1
  15. data/lib/courier/models/bulk_add_users_params.rb +7 -1
  16. data/lib/courier/models/bulk_list_users_params.rb +8 -1
  17. data/lib/courier/models/bulk_retrieve_job_params.rb +7 -1
  18. data/lib/courier/models/bulk_run_job_params.rb +7 -1
  19. data/lib/courier/models/channel.rb +75 -0
  20. data/lib/courier/models/channel_metadata.rb +15 -0
  21. data/lib/courier/models/elemental_content.rb +3 -10
  22. data/lib/courier/models/elemental_html_node_with_type.rb +24 -0
  23. data/lib/courier/models/elemental_node.rb +3 -1
  24. data/lib/courier/models/journey.rb +63 -0
  25. data/lib/courier/models/journey_invoke_params.rb +20 -0
  26. data/lib/courier/models/journey_list_params.rb +47 -0
  27. data/lib/courier/models/journeys_invoke_request.rb +49 -0
  28. data/lib/courier/models/journeys_invoke_response.rb +17 -0
  29. data/lib/courier/models/journeys_list_response.rb +24 -0
  30. data/lib/courier/models/list_delete_params.rb +7 -1
  31. data/lib/courier/models/list_restore_params.rb +7 -1
  32. data/lib/courier/models/list_retrieve_params.rb +7 -1
  33. data/lib/courier/models/list_update_params.rb +7 -1
  34. data/lib/courier/models/lists/subscription_add_params.rb +7 -1
  35. data/lib/courier/models/lists/subscription_list_params.rb +8 -1
  36. data/lib/courier/models/lists/subscription_subscribe_params.rb +7 -1
  37. data/lib/courier/models/lists/subscription_subscribe_user_params.rb +7 -1
  38. data/lib/courier/models/lists/subscription_unsubscribe_user_params.rb +7 -1
  39. data/lib/courier/models/message_cancel_params.rb +7 -1
  40. data/lib/courier/models/message_channels.rb +8 -0
  41. data/lib/courier/models/message_content_params.rb +7 -1
  42. data/lib/courier/models/message_details.rb +37 -37
  43. data/lib/courier/models/message_history_params.rb +8 -1
  44. data/lib/courier/models/message_providers.rb +8 -0
  45. data/lib/courier/models/message_providers_type.rb +38 -0
  46. data/lib/courier/models/message_retrieve_params.rb +7 -1
  47. data/lib/courier/models/metadata.rb +15 -0
  48. data/lib/courier/models/notification_archive_params.rb +20 -0
  49. data/lib/courier/models/notification_create_params.rb +14 -0
  50. data/lib/courier/models/notification_list_params.rb +13 -4
  51. data/lib/courier/models/notification_list_response.rb +108 -93
  52. data/lib/courier/models/notification_list_versions_params.rb +37 -0
  53. data/lib/courier/models/notification_publish_params.rb +20 -0
  54. data/lib/courier/models/notification_replace_params.rb +20 -0
  55. data/lib/courier/models/notification_retrieve_content_params.rb +7 -1
  56. data/lib/courier/models/notification_retrieve_params.rb +33 -0
  57. data/lib/courier/models/notification_template_create_request.rb +45 -0
  58. data/lib/courier/models/notification_template_get_response.rb +92 -0
  59. data/lib/courier/models/notification_template_mutation_response.rb +51 -0
  60. data/lib/courier/models/notification_template_payload.rb +98 -0
  61. data/lib/courier/models/notification_template_publish_request.rb +19 -0
  62. data/lib/courier/models/notification_template_summary.rb +81 -0
  63. data/lib/courier/models/notification_template_update_request.rb +46 -0
  64. data/lib/courier/models/notification_template_version_list_response.rb +22 -0
  65. data/lib/courier/models/notifications/check_delete_params.rb +7 -1
  66. data/lib/courier/models/notifications/check_list_params.rb +7 -1
  67. data/lib/courier/models/notifications/check_update_params.rb +7 -1
  68. data/lib/courier/models/notifications/draft_retrieve_content_params.rb +7 -1
  69. data/lib/courier/models/profile_create_params.rb +7 -1
  70. data/lib/courier/models/profile_delete_params.rb +7 -1
  71. data/lib/courier/models/profile_replace_params.rb +7 -1
  72. data/lib/courier/models/profile_retrieve_params.rb +7 -1
  73. data/lib/courier/models/profile_update_params.rb +8 -1
  74. data/lib/courier/models/profiles/list_delete_params.rb +7 -1
  75. data/lib/courier/models/profiles/list_retrieve_params.rb +8 -1
  76. data/lib/courier/models/profiles/list_subscribe_params.rb +7 -1
  77. data/lib/courier/models/provider.rb +67 -0
  78. data/lib/courier/models/provider_create_params.rb +52 -0
  79. data/lib/courier/models/provider_delete_params.rb +20 -0
  80. data/lib/courier/models/provider_list_params.rb +22 -0
  81. data/lib/courier/models/provider_list_response.rb +24 -0
  82. data/lib/courier/models/provider_retrieve_params.rb +20 -0
  83. data/lib/courier/models/provider_update_params.rb +58 -0
  84. data/lib/courier/models/providers/catalog_list_params.rb +44 -0
  85. data/lib/courier/models/providers/catalog_list_response.rb +26 -0
  86. data/lib/courier/models/providers_catalog_entry.rb +86 -0
  87. data/lib/courier/models/request_archive_params.rb +7 -1
  88. data/lib/courier/models/routing_strategy_archive_params.rb +20 -0
  89. data/lib/courier/models/routing_strategy_create_params.rb +14 -0
  90. data/lib/courier/models/routing_strategy_create_request.rb +58 -0
  91. data/lib/courier/models/routing_strategy_get_response.rb +99 -0
  92. data/lib/courier/models/routing_strategy_list_params.rb +30 -0
  93. data/lib/courier/models/routing_strategy_list_response.rb +24 -0
  94. data/lib/courier/models/routing_strategy_mutation_response.rb +19 -0
  95. data/lib/courier/models/routing_strategy_replace_params.rb +20 -0
  96. data/lib/courier/models/routing_strategy_replace_request.rb +59 -0
  97. data/lib/courier/models/routing_strategy_retrieve_params.rb +20 -0
  98. data/lib/courier/models/routing_strategy_summary.rb +75 -0
  99. data/lib/courier/models/send_message_params.rb +6 -154
  100. data/lib/courier/models/tenant_delete_params.rb +7 -1
  101. data/lib/courier/models/tenant_list_users_params.rb +8 -1
  102. data/lib/courier/models/tenant_retrieve_params.rb +7 -1
  103. data/lib/courier/models/tenant_template_input.rb +6 -152
  104. data/lib/courier/models/tenant_update_params.rb +8 -1
  105. data/lib/courier/models/tenants/preferences/item_delete_params.rb +7 -1
  106. data/lib/courier/models/tenants/preferences/item_update_params.rb +7 -1
  107. data/lib/courier/models/tenants/template_list_params.rb +8 -1
  108. data/lib/courier/models/tenants/template_publish_params.rb +7 -1
  109. data/lib/courier/models/tenants/template_replace_params.rb +7 -1
  110. data/lib/courier/models/tenants/template_retrieve_params.rb +7 -1
  111. data/lib/courier/models/tenants/templates/version_retrieve_params.rb +7 -1
  112. data/lib/courier/models/timeouts.rb +21 -0
  113. data/lib/courier/models/translation_retrieve_params.rb +7 -1
  114. data/lib/courier/models/translation_update_params.rb +7 -1
  115. data/lib/courier/models/users/preference_retrieve_params.rb +8 -1
  116. data/lib/courier/models/users/preference_retrieve_topic_params.rb +8 -1
  117. data/lib/courier/models/users/preference_update_or_create_topic_params.rb +8 -1
  118. data/lib/courier/models/users/tenant_add_multiple_params.rb +7 -1
  119. data/lib/courier/models/users/tenant_add_single_params.rb +7 -1
  120. data/lib/courier/models/users/tenant_list_params.rb +8 -1
  121. data/lib/courier/models/users/tenant_remove_all_params.rb +7 -1
  122. data/lib/courier/models/users/tenant_remove_single_params.rb +7 -1
  123. data/lib/courier/models/users/token_add_multiple_params.rb +7 -1
  124. data/lib/courier/models/users/token_add_single_params.rb +168 -2
  125. data/lib/courier/models/users/token_delete_params.rb +7 -1
  126. data/lib/courier/models/users/token_list_params.rb +7 -1
  127. data/lib/courier/models/users/token_retrieve_params.rb +7 -1
  128. data/lib/courier/models/users/token_update_params.rb +7 -1
  129. data/lib/courier/models/version_node.rb +46 -0
  130. data/lib/courier/models.rb +98 -0
  131. data/lib/courier/resources/audiences.rb +4 -2
  132. data/lib/courier/resources/audit_events.rb +2 -1
  133. data/lib/courier/resources/automations.rb +2 -1
  134. data/lib/courier/resources/brands.rb +2 -1
  135. data/lib/courier/resources/bulk.rb +2 -1
  136. data/lib/courier/resources/journeys.rb +73 -0
  137. data/lib/courier/resources/lists/subscriptions.rb +2 -1
  138. data/lib/courier/resources/lists.rb +2 -1
  139. data/lib/courier/resources/messages.rb +4 -2
  140. data/lib/courier/resources/notifications.rb +167 -4
  141. data/lib/courier/resources/profiles/lists.rb +2 -1
  142. data/lib/courier/resources/providers/catalog.rb +49 -0
  143. data/lib/courier/resources/providers.rb +150 -0
  144. data/lib/courier/resources/routing_strategies.rb +151 -0
  145. data/lib/courier/resources/tenants/templates.rb +2 -1
  146. data/lib/courier/resources/tenants.rb +4 -2
  147. data/lib/courier/resources/users/preferences.rb +7 -4
  148. data/lib/courier/resources/users/tenants.rb +2 -1
  149. data/lib/courier/resources/users/tokens.rb +7 -9
  150. data/lib/courier/version.rb +1 -1
  151. data/lib/courier.rb +54 -0
  152. data/rbi/courier/client.rbi +9 -0
  153. data/rbi/courier/internal/util.rbi +28 -0
  154. data/rbi/courier/models/audience_delete_params.rbi +13 -5
  155. data/rbi/courier/models/audience_list_members_params.rbi +6 -0
  156. data/rbi/courier/models/audience_retrieve_params.rbi +13 -5
  157. data/rbi/courier/models/audience_update_params.rbi +6 -0
  158. data/rbi/courier/models/audit_event_retrieve_params.rbi +13 -5
  159. data/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi +6 -0
  160. data/rbi/courier/models/brand_delete_params.rbi +13 -5
  161. data/rbi/courier/models/brand_retrieve_params.rbi +13 -5
  162. data/rbi/courier/models/brand_update_params.rbi +6 -0
  163. data/rbi/courier/models/bulk_add_users_params.rbi +6 -1
  164. data/rbi/courier/models/bulk_list_users_params.rbi +6 -0
  165. data/rbi/courier/models/bulk_retrieve_job_params.rbi +13 -5
  166. data/rbi/courier/models/bulk_run_job_params.rbi +13 -5
  167. data/rbi/courier/models/channel.rbi +106 -0
  168. data/rbi/courier/models/channel_metadata.rbi +28 -0
  169. data/rbi/courier/models/elemental_content.rbi +9 -12
  170. data/rbi/courier/models/elemental_html_node_with_type.rbi +59 -0
  171. data/rbi/courier/models/elemental_node.rbi +2 -1
  172. data/rbi/courier/models/journey.rbi +91 -0
  173. data/rbi/courier/models/journey_invoke_params.rbi +35 -0
  174. data/rbi/courier/models/journey_list_params.rbi +85 -0
  175. data/rbi/courier/models/journeys_invoke_request.rbi +84 -0
  176. data/rbi/courier/models/journeys_invoke_response.rbi +27 -0
  177. data/rbi/courier/models/journeys_list_response.rbi +46 -0
  178. data/rbi/courier/models/list_delete_params.rbi +13 -5
  179. data/rbi/courier/models/list_restore_params.rbi +13 -5
  180. data/rbi/courier/models/list_retrieve_params.rbi +13 -5
  181. data/rbi/courier/models/list_update_params.rbi +6 -1
  182. data/rbi/courier/models/lists/subscription_add_params.rbi +6 -1
  183. data/rbi/courier/models/lists/subscription_list_params.rbi +6 -0
  184. data/rbi/courier/models/lists/subscription_subscribe_params.rbi +6 -1
  185. data/rbi/courier/models/lists/subscription_subscribe_user_params.rbi +6 -1
  186. data/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi +10 -2
  187. data/rbi/courier/models/message_cancel_params.rbi +13 -5
  188. data/rbi/courier/models/message_channels.rbi +11 -0
  189. data/rbi/courier/models/message_content_params.rbi +13 -5
  190. data/rbi/courier/models/message_details.rbi +55 -43
  191. data/rbi/courier/models/message_history_params.rbi +10 -1
  192. data/rbi/courier/models/message_providers.rbi +11 -0
  193. data/rbi/courier/models/message_providers_type.rbi +60 -0
  194. data/rbi/courier/models/message_retrieve_params.rbi +13 -5
  195. data/rbi/courier/models/metadata.rbi +26 -0
  196. data/rbi/courier/models/notification_archive_params.rbi +35 -0
  197. data/rbi/courier/models/notification_create_params.rbi +27 -0
  198. data/rbi/courier/models/notification_list_params.rbi +15 -2
  199. data/rbi/courier/models/notification_list_response.rbi +159 -119
  200. data/rbi/courier/models/notification_list_versions_params.rbi +66 -0
  201. data/rbi/courier/models/notification_publish_params.rbi +35 -0
  202. data/rbi/courier/models/notification_replace_params.rbi +35 -0
  203. data/rbi/courier/models/notification_retrieve_content_params.rbi +13 -5
  204. data/rbi/courier/models/notification_retrieve_params.rbi +54 -0
  205. data/rbi/courier/models/notification_template_create_request.rbi +102 -0
  206. data/rbi/courier/models/notification_template_get_response.rbi +162 -0
  207. data/rbi/courier/models/notification_template_mutation_response.rbi +121 -0
  208. data/rbi/courier/models/notification_template_payload.rbi +183 -0
  209. data/rbi/courier/models/notification_template_publish_request.rbi +35 -0
  210. data/rbi/courier/models/notification_template_summary.rbi +124 -0
  211. data/rbi/courier/models/notification_template_update_request.rbi +103 -0
  212. data/rbi/courier/models/notification_template_version_list_response.rbi +41 -0
  213. data/rbi/courier/models/notifications/check_delete_params.rbi +10 -2
  214. data/rbi/courier/models/notifications/check_list_params.rbi +10 -2
  215. data/rbi/courier/models/notifications/check_update_params.rbi +6 -1
  216. data/rbi/courier/models/notifications/draft_retrieve_content_params.rbi +13 -5
  217. data/rbi/courier/models/profile_create_params.rbi +6 -1
  218. data/rbi/courier/models/profile_delete_params.rbi +13 -5
  219. data/rbi/courier/models/profile_replace_params.rbi +6 -1
  220. data/rbi/courier/models/profile_retrieve_params.rbi +13 -5
  221. data/rbi/courier/models/profile_update_params.rbi +6 -0
  222. data/rbi/courier/models/profiles/list_delete_params.rbi +13 -5
  223. data/rbi/courier/models/profiles/list_retrieve_params.rbi +6 -0
  224. data/rbi/courier/models/profiles/list_subscribe_params.rbi +6 -1
  225. data/rbi/courier/models/provider.rbi +87 -0
  226. data/rbi/courier/models/provider_create_params.rbi +82 -0
  227. data/rbi/courier/models/provider_delete_params.rbi +35 -0
  228. data/rbi/courier/models/provider_list_params.rbi +43 -0
  229. data/rbi/courier/models/provider_list_response.rbi +42 -0
  230. data/rbi/courier/models/provider_retrieve_params.rbi +35 -0
  231. data/rbi/courier/models/provider_update_params.rbi +86 -0
  232. data/rbi/courier/models/providers/catalog_list_params.rbi +75 -0
  233. data/rbi/courier/models/providers/catalog_list_response.rbi +47 -0
  234. data/rbi/courier/models/providers_catalog_entry.rbi +129 -0
  235. data/rbi/courier/models/request_archive_params.rbi +13 -5
  236. data/rbi/courier/models/routing_strategy_archive_params.rbi +38 -0
  237. data/rbi/courier/models/routing_strategy_create_params.rbi +30 -0
  238. data/rbi/courier/models/routing_strategy_create_request.rbi +86 -0
  239. data/rbi/courier/models/routing_strategy_get_response.rbi +121 -0
  240. data/rbi/courier/models/routing_strategy_list_params.rbi +54 -0
  241. data/rbi/courier/models/routing_strategy_list_response.rbi +45 -0
  242. data/rbi/courier/models/routing_strategy_mutation_response.rbi +31 -0
  243. data/rbi/courier/models/routing_strategy_replace_params.rbi +38 -0
  244. data/rbi/courier/models/routing_strategy_replace_request.rbi +87 -0
  245. data/rbi/courier/models/routing_strategy_retrieve_params.rbi +38 -0
  246. data/rbi/courier/models/routing_strategy_summary.rbi +95 -0
  247. data/rbi/courier/models/send_message_params.rbi +6 -362
  248. data/rbi/courier/models/tenant_delete_params.rbi +13 -5
  249. data/rbi/courier/models/tenant_list_users_params.rbi +6 -0
  250. data/rbi/courier/models/tenant_retrieve_params.rbi +13 -5
  251. data/rbi/courier/models/tenant_template_input.rbi +8 -336
  252. data/rbi/courier/models/tenant_update_params.rbi +6 -0
  253. data/rbi/courier/models/tenants/preferences/item_delete_params.rbi +10 -2
  254. data/rbi/courier/models/tenants/preferences/item_update_params.rbi +10 -2
  255. data/rbi/courier/models/tenants/template_list_params.rbi +6 -0
  256. data/rbi/courier/models/tenants/template_publish_params.rbi +10 -2
  257. data/rbi/courier/models/tenants/template_replace_params.rbi +10 -2
  258. data/rbi/courier/models/tenants/template_retrieve_params.rbi +10 -2
  259. data/rbi/courier/models/tenants/templates/version_retrieve_params.rbi +6 -1
  260. data/rbi/courier/models/timeouts.rbi +33 -0
  261. data/rbi/courier/models/translation_retrieve_params.rbi +10 -2
  262. data/rbi/courier/models/translation_update_params.rbi +6 -1
  263. data/rbi/courier/models/users/preference_retrieve_params.rbi +6 -0
  264. data/rbi/courier/models/users/preference_retrieve_topic_params.rbi +6 -0
  265. data/rbi/courier/models/users/preference_update_or_create_topic_params.rbi +6 -0
  266. data/rbi/courier/models/users/tenant_add_multiple_params.rbi +6 -1
  267. data/rbi/courier/models/users/tenant_add_single_params.rbi +6 -1
  268. data/rbi/courier/models/users/tenant_list_params.rbi +6 -0
  269. data/rbi/courier/models/users/tenant_remove_all_params.rbi +13 -5
  270. data/rbi/courier/models/users/tenant_remove_single_params.rbi +10 -2
  271. data/rbi/courier/models/users/token_add_multiple_params.rbi +13 -5
  272. data/rbi/courier/models/users/token_add_single_params.rbi +290 -3
  273. data/rbi/courier/models/users/token_delete_params.rbi +10 -2
  274. data/rbi/courier/models/users/token_list_params.rbi +13 -5
  275. data/rbi/courier/models/users/token_retrieve_params.rbi +10 -2
  276. data/rbi/courier/models/users/token_update_params.rbi +6 -1
  277. data/rbi/courier/models/version_node.rbi +65 -0
  278. data/rbi/courier/models.rbi +106 -0
  279. data/rbi/courier/resources/journeys.rbi +64 -0
  280. data/rbi/courier/resources/notifications.rbi +119 -1
  281. data/rbi/courier/resources/providers/catalog.rbi +38 -0
  282. data/rbi/courier/resources/providers.rbi +116 -0
  283. data/rbi/courier/resources/routing_strategies.rbi +126 -0
  284. data/rbi/courier/resources/users/tokens.rbi +11 -9
  285. data/sig/courier/client.rbs +6 -0
  286. data/sig/courier/internal/util.rbs +14 -0
  287. data/sig/courier/models/audience_delete_params.rbs +11 -3
  288. data/sig/courier/models/audience_list_members_params.rbs +6 -1
  289. data/sig/courier/models/audience_retrieve_params.rbs +11 -3
  290. data/sig/courier/models/audience_update_params.rbs +5 -0
  291. data/sig/courier/models/audit_event_retrieve_params.rbs +11 -3
  292. data/sig/courier/models/automations/invoke_invoke_by_template_params.rbs +5 -0
  293. data/sig/courier/models/brand_delete_params.rbs +11 -3
  294. data/sig/courier/models/brand_retrieve_params.rbs +11 -3
  295. data/sig/courier/models/brand_update_params.rbs +5 -0
  296. data/sig/courier/models/bulk_add_users_params.rbs +5 -1
  297. data/sig/courier/models/bulk_list_users_params.rbs +6 -1
  298. data/sig/courier/models/bulk_retrieve_job_params.rbs +11 -3
  299. data/sig/courier/models/bulk_run_job_params.rbs +11 -3
  300. data/sig/courier/models/channel.rbs +61 -0
  301. data/sig/courier/models/channel_metadata.rbs +13 -0
  302. data/sig/courier/models/elemental_content.rbs +3 -11
  303. data/sig/courier/models/elemental_html_node_with_type.rbs +32 -0
  304. data/sig/courier/models/elemental_node.rbs +1 -0
  305. data/sig/courier/models/journey.rbs +55 -0
  306. data/sig/courier/models/journey_invoke_params.rbs +25 -0
  307. data/sig/courier/models/journey_list_params.rbs +45 -0
  308. data/sig/courier/models/journeys_invoke_request.rbs +36 -0
  309. data/sig/courier/models/journeys_invoke_response.rbs +13 -0
  310. data/sig/courier/models/journeys_list_response.rbs +23 -0
  311. data/sig/courier/models/list_delete_params.rbs +12 -3
  312. data/sig/courier/models/list_restore_params.rbs +11 -3
  313. data/sig/courier/models/list_retrieve_params.rbs +11 -3
  314. data/sig/courier/models/list_update_params.rbs +9 -1
  315. data/sig/courier/models/lists/subscription_add_params.rbs +8 -1
  316. data/sig/courier/models/lists/subscription_list_params.rbs +6 -1
  317. data/sig/courier/models/lists/subscription_subscribe_params.rbs +8 -1
  318. data/sig/courier/models/lists/subscription_subscribe_user_params.rbs +9 -1
  319. data/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs +6 -1
  320. data/sig/courier/models/message_cancel_params.rbs +11 -3
  321. data/sig/courier/models/message_channels.rbs +7 -0
  322. data/sig/courier/models/message_content_params.rbs +11 -3
  323. data/sig/courier/models/message_details.rbs +31 -23
  324. data/sig/courier/models/message_history_params.rbs +6 -1
  325. data/sig/courier/models/message_providers.rbs +7 -0
  326. data/sig/courier/models/message_providers_type.rbs +35 -0
  327. data/sig/courier/models/message_retrieve_params.rbs +11 -3
  328. data/sig/courier/models/metadata.rbs +13 -0
  329. data/sig/courier/models/notification_archive_params.rbs +20 -0
  330. data/sig/courier/models/notification_create_params.rbs +15 -0
  331. data/sig/courier/models/notification_list_params.rbs +7 -1
  332. data/sig/courier/models/notification_list_response.rbs +81 -71
  333. data/sig/courier/models/notification_list_versions_params.rbs +36 -0
  334. data/sig/courier/models/notification_publish_params.rbs +22 -0
  335. data/sig/courier/models/notification_replace_params.rbs +22 -0
  336. data/sig/courier/models/notification_retrieve_content_params.rbs +8 -3
  337. data/sig/courier/models/notification_retrieve_params.rbs +30 -0
  338. data/sig/courier/models/notification_template_create_request.rbs +40 -0
  339. data/sig/courier/models/notification_template_get_response.rbs +72 -0
  340. data/sig/courier/models/notification_template_mutation_response.rbs +46 -0
  341. data/sig/courier/models/notification_template_payload.rbs +75 -0
  342. data/sig/courier/models/notification_template_publish_request.rbs +15 -0
  343. data/sig/courier/models/notification_template_summary.rbs +70 -0
  344. data/sig/courier/models/notification_template_update_request.rbs +40 -0
  345. data/sig/courier/models/notification_template_version_list_response.rbs +22 -0
  346. data/sig/courier/models/notifications/check_delete_params.rbs +10 -2
  347. data/sig/courier/models/notifications/check_list_params.rbs +10 -2
  348. data/sig/courier/models/notifications/check_update_params.rbs +9 -1
  349. data/sig/courier/models/notifications/draft_retrieve_content_params.rbs +8 -3
  350. data/sig/courier/models/profile_create_params.rbs +5 -1
  351. data/sig/courier/models/profile_delete_params.rbs +11 -3
  352. data/sig/courier/models/profile_replace_params.rbs +5 -1
  353. data/sig/courier/models/profile_retrieve_params.rbs +11 -3
  354. data/sig/courier/models/profile_update_params.rbs +5 -1
  355. data/sig/courier/models/profiles/list_delete_params.rbs +11 -3
  356. data/sig/courier/models/profiles/list_retrieve_params.rbs +6 -1
  357. data/sig/courier/models/profiles/list_subscribe_params.rbs +8 -1
  358. data/sig/courier/models/provider.rbs +52 -0
  359. data/sig/courier/models/provider_create_params.rbs +47 -0
  360. data/sig/courier/models/provider_delete_params.rbs +20 -0
  361. data/sig/courier/models/provider_list_params.rbs +25 -0
  362. data/sig/courier/models/provider_list_response.rbs +22 -0
  363. data/sig/courier/models/provider_retrieve_params.rbs +20 -0
  364. data/sig/courier/models/provider_update_params.rbs +52 -0
  365. data/sig/courier/models/providers/catalog_list_params.rbs +40 -0
  366. data/sig/courier/models/providers/catalog_list_response.rbs +27 -0
  367. data/sig/courier/models/providers_catalog_entry.rbs +64 -0
  368. data/sig/courier/models/request_archive_params.rbs +11 -3
  369. data/sig/courier/models/routing_strategy_archive_params.rbs +20 -0
  370. data/sig/courier/models/routing_strategy_create_params.rbs +15 -0
  371. data/sig/courier/models/routing_strategy_create_request.rbs +45 -0
  372. data/sig/courier/models/routing_strategy_get_response.rbs +70 -0
  373. data/sig/courier/models/routing_strategy_list_params.rbs +30 -0
  374. data/sig/courier/models/routing_strategy_list_response.rbs +25 -0
  375. data/sig/courier/models/routing_strategy_mutation_response.rbs +13 -0
  376. data/sig/courier/models/routing_strategy_replace_params.rbs +22 -0
  377. data/sig/courier/models/routing_strategy_replace_request.rbs +45 -0
  378. data/sig/courier/models/routing_strategy_retrieve_params.rbs +20 -0
  379. data/sig/courier/models/routing_strategy_summary.rbs +55 -0
  380. data/sig/courier/models/send_message_params.rbs +8 -130
  381. data/sig/courier/models/tenant_delete_params.rbs +11 -3
  382. data/sig/courier/models/tenant_list_users_params.rbs +5 -1
  383. data/sig/courier/models/tenant_retrieve_params.rbs +11 -3
  384. data/sig/courier/models/tenant_template_input.rbs +12 -134
  385. data/sig/courier/models/tenant_update_params.rbs +5 -0
  386. data/sig/courier/models/tenants/preferences/item_delete_params.rbs +6 -1
  387. data/sig/courier/models/tenants/preferences/item_update_params.rbs +8 -1
  388. data/sig/courier/models/tenants/template_list_params.rbs +5 -1
  389. data/sig/courier/models/tenants/template_publish_params.rbs +8 -1
  390. data/sig/courier/models/tenants/template_replace_params.rbs +8 -1
  391. data/sig/courier/models/tenants/template_retrieve_params.rbs +6 -1
  392. data/sig/courier/models/tenants/templates/version_retrieve_params.rbs +5 -1
  393. data/sig/courier/models/timeouts.rbs +15 -0
  394. data/sig/courier/models/translation_retrieve_params.rbs +6 -1
  395. data/sig/courier/models/translation_update_params.rbs +5 -1
  396. data/sig/courier/models/users/preference_retrieve_params.rbs +6 -1
  397. data/sig/courier/models/users/preference_retrieve_topic_params.rbs +5 -1
  398. data/sig/courier/models/users/preference_update_or_create_topic_params.rbs +5 -0
  399. data/sig/courier/models/users/tenant_add_multiple_params.rbs +5 -1
  400. data/sig/courier/models/users/tenant_add_single_params.rbs +5 -1
  401. data/sig/courier/models/users/tenant_list_params.rbs +5 -1
  402. data/sig/courier/models/users/tenant_remove_all_params.rbs +11 -3
  403. data/sig/courier/models/users/tenant_remove_single_params.rbs +6 -1
  404. data/sig/courier/models/users/token_add_multiple_params.rbs +11 -3
  405. data/sig/courier/models/users/token_add_single_params.rbs +127 -4
  406. data/sig/courier/models/users/token_delete_params.rbs +6 -1
  407. data/sig/courier/models/users/token_list_params.rbs +11 -3
  408. data/sig/courier/models/users/token_retrieve_params.rbs +6 -1
  409. data/sig/courier/models/users/token_update_params.rbs +5 -0
  410. data/sig/courier/models/version_node.rbs +32 -0
  411. data/sig/courier/models.rbs +96 -0
  412. data/sig/courier/resources/journeys.rbs +21 -0
  413. data/sig/courier/resources/notifications.rbs +35 -0
  414. data/sig/courier/resources/providers/catalog.rbs +16 -0
  415. data/sig/courier/resources/providers.rbs +38 -0
  416. data/sig/courier/resources/routing_strategies.rbs +41 -0
  417. data/sig/courier/resources/users/tokens.rbs +5 -6
  418. metadata +164 -2
@@ -58,13 +58,7 @@ module Courier
58
58
 
59
59
  # Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
60
60
  # inbox, direct_message, banner, webhook.
61
- sig do
62
- returns(
63
- T.nilable(
64
- T::Hash[Symbol, Courier::SendMessageParams::Message::Channel]
65
- )
66
- )
67
- end
61
+ sig { returns(T.nilable(T::Hash[Symbol, Courier::Channel])) }
68
62
  attr_accessor :channels
69
63
 
70
64
  # Describes content that will work for email, inbox, push, chat, or any channel
@@ -148,11 +142,7 @@ module Courier
148
142
  attr_writer :preferences
149
143
 
150
144
  sig do
151
- returns(
152
- T.nilable(
153
- T::Hash[Symbol, Courier::SendMessageParams::Message::Provider]
154
- )
155
- )
145
+ returns(T.nilable(T::Hash[Symbol, Courier::MessageProvidersType]))
156
146
  end
157
147
  attr_accessor :providers
158
148
 
@@ -218,13 +208,7 @@ module Courier
218
208
  sig do
219
209
  params(
220
210
  brand_id: T.nilable(String),
221
- channels:
222
- T.nilable(
223
- T::Hash[
224
- Symbol,
225
- Courier::SendMessageParams::Message::Channel::OrHash
226
- ]
227
- ),
211
+ channels: T.nilable(T::Hash[Symbol, Courier::Channel::OrHash]),
228
212
  content:
229
213
  T.any(
230
214
  Courier::ElementalContentSugar::OrHash,
@@ -243,12 +227,7 @@ module Courier
243
227
  Courier::SendMessageParams::Message::Preferences::OrHash
244
228
  ),
245
229
  providers:
246
- T.nilable(
247
- T::Hash[
248
- Symbol,
249
- Courier::SendMessageParams::Message::Provider::OrHash
250
- ]
251
- ),
230
+ T.nilable(T::Hash[Symbol, Courier::MessageProvidersType::OrHash]),
252
231
  routing:
253
232
  T.nilable(Courier::SendMessageParams::Message::Routing::OrHash),
254
233
  template: T.nilable(String),
@@ -309,10 +288,7 @@ module Courier
309
288
  override.returns(
310
289
  {
311
290
  brand_id: T.nilable(String),
312
- channels:
313
- T.nilable(
314
- T::Hash[Symbol, Courier::SendMessageParams::Message::Channel]
315
- ),
291
+ channels: T.nilable(T::Hash[Symbol, Courier::Channel]),
316
292
  content:
317
293
  T.any(
318
294
  Courier::ElementalContentSugar,
@@ -327,9 +303,7 @@ module Courier
327
303
  preferences:
328
304
  T.nilable(Courier::SendMessageParams::Message::Preferences),
329
305
  providers:
330
- T.nilable(
331
- T::Hash[Symbol, Courier::SendMessageParams::Message::Provider]
332
- ),
306
+ T.nilable(T::Hash[Symbol, Courier::MessageProvidersType]),
333
307
  routing: T.nilable(Courier::SendMessageParams::Message::Routing),
334
308
  template: T.nilable(String),
335
309
  timeout: T.nilable(Courier::SendMessageParams::Message::Timeout),
@@ -364,233 +338,6 @@ module Courier
364
338
  def to_hash
365
339
  end
366
340
 
367
- class Channel < Courier::Internal::Type::BaseModel
368
- OrHash =
369
- T.type_alias do
370
- T.any(
371
- Courier::SendMessageParams::Message::Channel,
372
- Courier::Internal::AnyHash
373
- )
374
- end
375
-
376
- # Brand id used for rendering.
377
- sig { returns(T.nilable(String)) }
378
- attr_accessor :brand_id
379
-
380
- # JS conditional with access to data/profile.
381
- sig { returns(T.nilable(String)) }
382
- attr_accessor :if_
383
-
384
- sig do
385
- returns(
386
- T.nilable(Courier::SendMessageParams::Message::Channel::Metadata)
387
- )
388
- end
389
- attr_reader :metadata
390
-
391
- sig do
392
- params(
393
- metadata:
394
- T.nilable(
395
- Courier::SendMessageParams::Message::Channel::Metadata::OrHash
396
- )
397
- ).void
398
- end
399
- attr_writer :metadata
400
-
401
- # Channel specific overrides.
402
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
403
- attr_accessor :override
404
-
405
- # Providers enabled for this channel.
406
- sig { returns(T.nilable(T::Array[String])) }
407
- attr_accessor :providers
408
-
409
- # Defaults to `single`.
410
- sig do
411
- returns(
412
- T.nilable(
413
- Courier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
414
- )
415
- )
416
- end
417
- attr_accessor :routing_method
418
-
419
- sig do
420
- returns(
421
- T.nilable(Courier::SendMessageParams::Message::Channel::Timeouts)
422
- )
423
- end
424
- attr_reader :timeouts
425
-
426
- sig do
427
- params(
428
- timeouts:
429
- T.nilable(
430
- Courier::SendMessageParams::Message::Channel::Timeouts::OrHash
431
- )
432
- ).void
433
- end
434
- attr_writer :timeouts
435
-
436
- sig do
437
- params(
438
- brand_id: T.nilable(String),
439
- if_: T.nilable(String),
440
- metadata:
441
- T.nilable(
442
- Courier::SendMessageParams::Message::Channel::Metadata::OrHash
443
- ),
444
- override: T.nilable(T::Hash[Symbol, T.anything]),
445
- providers: T.nilable(T::Array[String]),
446
- routing_method:
447
- T.nilable(
448
- Courier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
449
- ),
450
- timeouts:
451
- T.nilable(
452
- Courier::SendMessageParams::Message::Channel::Timeouts::OrHash
453
- )
454
- ).returns(T.attached_class)
455
- end
456
- def self.new(
457
- # Brand id used for rendering.
458
- brand_id: nil,
459
- # JS conditional with access to data/profile.
460
- if_: nil,
461
- metadata: nil,
462
- # Channel specific overrides.
463
- override: nil,
464
- # Providers enabled for this channel.
465
- providers: nil,
466
- # Defaults to `single`.
467
- routing_method: nil,
468
- timeouts: nil
469
- )
470
- end
471
-
472
- sig do
473
- override.returns(
474
- {
475
- brand_id: T.nilable(String),
476
- if_: T.nilable(String),
477
- metadata:
478
- T.nilable(
479
- Courier::SendMessageParams::Message::Channel::Metadata
480
- ),
481
- override: T.nilable(T::Hash[Symbol, T.anything]),
482
- providers: T.nilable(T::Array[String]),
483
- routing_method:
484
- T.nilable(
485
- Courier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
486
- ),
487
- timeouts:
488
- T.nilable(
489
- Courier::SendMessageParams::Message::Channel::Timeouts
490
- )
491
- }
492
- )
493
- end
494
- def to_hash
495
- end
496
-
497
- class Metadata < Courier::Internal::Type::BaseModel
498
- OrHash =
499
- T.type_alias do
500
- T.any(
501
- Courier::SendMessageParams::Message::Channel::Metadata,
502
- Courier::Internal::AnyHash
503
- )
504
- end
505
-
506
- sig { returns(T.nilable(Courier::Utm)) }
507
- attr_reader :utm
508
-
509
- sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
510
- attr_writer :utm
511
-
512
- sig do
513
- params(utm: T.nilable(Courier::Utm::OrHash)).returns(
514
- T.attached_class
515
- )
516
- end
517
- def self.new(utm: nil)
518
- end
519
-
520
- sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
521
- def to_hash
522
- end
523
- end
524
-
525
- # Defaults to `single`.
526
- module RoutingMethod
527
- extend Courier::Internal::Type::Enum
528
-
529
- TaggedSymbol =
530
- T.type_alias do
531
- T.all(
532
- Symbol,
533
- Courier::SendMessageParams::Message::Channel::RoutingMethod
534
- )
535
- end
536
- OrSymbol = T.type_alias { T.any(Symbol, String) }
537
-
538
- ALL =
539
- T.let(
540
- :all,
541
- Courier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
542
- )
543
- SINGLE =
544
- T.let(
545
- :single,
546
- Courier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
547
- )
548
-
549
- sig do
550
- override.returns(
551
- T::Array[
552
- Courier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
553
- ]
554
- )
555
- end
556
- def self.values
557
- end
558
- end
559
-
560
- class Timeouts < Courier::Internal::Type::BaseModel
561
- OrHash =
562
- T.type_alias do
563
- T.any(
564
- Courier::SendMessageParams::Message::Channel::Timeouts,
565
- Courier::Internal::AnyHash
566
- )
567
- end
568
-
569
- sig { returns(T.nilable(Integer)) }
570
- attr_accessor :channel
571
-
572
- sig { returns(T.nilable(Integer)) }
573
- attr_accessor :provider
574
-
575
- sig do
576
- params(
577
- channel: T.nilable(Integer),
578
- provider: T.nilable(Integer)
579
- ).returns(T.attached_class)
580
- end
581
- def self.new(channel: nil, provider: nil)
582
- end
583
-
584
- sig do
585
- override.returns(
586
- { channel: T.nilable(Integer), provider: T.nilable(Integer) }
587
- )
588
- end
589
- def to_hash
590
- end
591
- end
592
- end
593
-
594
341
  # Describes content that will work for email, inbox, push, chat, or any channel
595
342
  # id.
596
343
  module Content
@@ -807,109 +554,6 @@ module Courier
807
554
  end
808
555
  end
809
556
 
810
- class Provider < Courier::Internal::Type::BaseModel
811
- OrHash =
812
- T.type_alias do
813
- T.any(
814
- Courier::SendMessageParams::Message::Provider,
815
- Courier::Internal::AnyHash
816
- )
817
- end
818
-
819
- # JS conditional with access to data/profile.
820
- sig { returns(T.nilable(String)) }
821
- attr_accessor :if_
822
-
823
- sig do
824
- returns(
825
- T.nilable(Courier::SendMessageParams::Message::Provider::Metadata)
826
- )
827
- end
828
- attr_reader :metadata
829
-
830
- sig do
831
- params(
832
- metadata:
833
- T.nilable(
834
- Courier::SendMessageParams::Message::Provider::Metadata::OrHash
835
- )
836
- ).void
837
- end
838
- attr_writer :metadata
839
-
840
- # Provider-specific overrides.
841
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
842
- attr_accessor :override
843
-
844
- sig { returns(T.nilable(Integer)) }
845
- attr_accessor :timeouts
846
-
847
- sig do
848
- params(
849
- if_: T.nilable(String),
850
- metadata:
851
- T.nilable(
852
- Courier::SendMessageParams::Message::Provider::Metadata::OrHash
853
- ),
854
- override: T.nilable(T::Hash[Symbol, T.anything]),
855
- timeouts: T.nilable(Integer)
856
- ).returns(T.attached_class)
857
- end
858
- def self.new(
859
- # JS conditional with access to data/profile.
860
- if_: nil,
861
- metadata: nil,
862
- # Provider-specific overrides.
863
- override: nil,
864
- timeouts: nil
865
- )
866
- end
867
-
868
- sig do
869
- override.returns(
870
- {
871
- if_: T.nilable(String),
872
- metadata:
873
- T.nilable(
874
- Courier::SendMessageParams::Message::Provider::Metadata
875
- ),
876
- override: T.nilable(T::Hash[Symbol, T.anything]),
877
- timeouts: T.nilable(Integer)
878
- }
879
- )
880
- end
881
- def to_hash
882
- end
883
-
884
- class Metadata < Courier::Internal::Type::BaseModel
885
- OrHash =
886
- T.type_alias do
887
- T.any(
888
- Courier::SendMessageParams::Message::Provider::Metadata,
889
- Courier::Internal::AnyHash
890
- )
891
- end
892
-
893
- sig { returns(T.nilable(Courier::Utm)) }
894
- attr_reader :utm
895
-
896
- sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
897
- attr_writer :utm
898
-
899
- sig do
900
- params(utm: T.nilable(Courier::Utm::OrHash)).returns(
901
- T.attached_class
902
- )
903
- end
904
- def self.new(utm: nil)
905
- end
906
-
907
- sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
908
- def to_hash
909
- end
910
- end
911
- end
912
-
913
557
  class Routing < Courier::Internal::Type::BaseModel
914
558
  OrHash =
915
559
  T.type_alias do
@@ -11,15 +11,23 @@ module Courier
11
11
  T.any(Courier::TenantDeleteParams, Courier::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :tenant_id
16
+
14
17
  sig do
15
- params(request_options: Courier::RequestOptions::OrHash).returns(
16
- T.attached_class
17
- )
18
+ params(
19
+ tenant_id: String,
20
+ request_options: Courier::RequestOptions::OrHash
21
+ ).returns(T.attached_class)
18
22
  end
19
- def self.new(request_options: {})
23
+ def self.new(tenant_id:, request_options: {})
20
24
  end
21
25
 
22
- sig { override.returns({ request_options: Courier::RequestOptions }) }
26
+ sig do
27
+ override.returns(
28
+ { tenant_id: String, request_options: Courier::RequestOptions }
29
+ )
30
+ end
23
31
  def to_hash
24
32
  end
25
33
  end
@@ -11,6 +11,9 @@ module Courier
11
11
  T.any(Courier::TenantListUsersParams, Courier::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :tenant_id
16
+
14
17
  # Continue the pagination with the next cursor
15
18
  sig { returns(T.nilable(String)) }
16
19
  attr_accessor :cursor
@@ -21,12 +24,14 @@ module Courier
21
24
 
22
25
  sig do
23
26
  params(
27
+ tenant_id: String,
24
28
  cursor: T.nilable(String),
25
29
  limit: T.nilable(Integer),
26
30
  request_options: Courier::RequestOptions::OrHash
27
31
  ).returns(T.attached_class)
28
32
  end
29
33
  def self.new(
34
+ tenant_id:,
30
35
  # Continue the pagination with the next cursor
31
36
  cursor: nil,
32
37
  # The number of accounts to return (defaults to 20, maximum value of 100)
@@ -38,6 +43,7 @@ module Courier
38
43
  sig do
39
44
  override.returns(
40
45
  {
46
+ tenant_id: String,
41
47
  cursor: T.nilable(String),
42
48
  limit: T.nilable(Integer),
43
49
  request_options: Courier::RequestOptions
@@ -11,15 +11,23 @@ module Courier
11
11
  T.any(Courier::TenantRetrieveParams, Courier::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :tenant_id
16
+
14
17
  sig do
15
- params(request_options: Courier::RequestOptions::OrHash).returns(
16
- T.attached_class
17
- )
18
+ params(
19
+ tenant_id: String,
20
+ request_options: Courier::RequestOptions::OrHash
21
+ ).returns(T.attached_class)
18
22
  end
19
- def self.new(request_options: {})
23
+ def self.new(tenant_id:, request_options: {})
20
24
  end
21
25
 
22
- sig { override.returns({ request_options: Courier::RequestOptions }) }
26
+ sig do
27
+ override.returns(
28
+ { tenant_id: String, request_options: Courier::RequestOptions }
29
+ )
30
+ end
23
31
  def to_hash
24
32
  end
25
33
  end