trycourier 4.7.1 → 4.8.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 (260) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/README.md +25 -235
  4. data/lib/courier/client.rb +4 -0
  5. data/lib/courier/internal/util.rb +31 -0
  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/elemental_content.rb +1 -8
  20. data/lib/courier/models/journey.rb +63 -0
  21. data/lib/courier/models/journey_invoke_params.rb +20 -0
  22. data/lib/courier/models/journey_list_params.rb +47 -0
  23. data/lib/courier/models/journeys_invoke_request.rb +49 -0
  24. data/lib/courier/models/journeys_invoke_response.rb +17 -0
  25. data/lib/courier/models/journeys_list_response.rb +24 -0
  26. data/lib/courier/models/list_delete_params.rb +7 -1
  27. data/lib/courier/models/list_restore_params.rb +7 -1
  28. data/lib/courier/models/list_retrieve_params.rb +7 -1
  29. data/lib/courier/models/list_update_params.rb +7 -1
  30. data/lib/courier/models/lists/subscription_add_params.rb +7 -1
  31. data/lib/courier/models/lists/subscription_list_params.rb +8 -1
  32. data/lib/courier/models/lists/subscription_subscribe_params.rb +7 -1
  33. data/lib/courier/models/lists/subscription_subscribe_user_params.rb +7 -1
  34. data/lib/courier/models/lists/subscription_unsubscribe_user_params.rb +7 -1
  35. data/lib/courier/models/message_cancel_params.rb +7 -1
  36. data/lib/courier/models/message_content_params.rb +7 -1
  37. data/lib/courier/models/message_details.rb +37 -37
  38. data/lib/courier/models/message_history_params.rb +8 -1
  39. data/lib/courier/models/message_retrieve_params.rb +7 -1
  40. data/lib/courier/models/notification_retrieve_content_params.rb +7 -1
  41. data/lib/courier/models/notifications/check_delete_params.rb +7 -1
  42. data/lib/courier/models/notifications/check_list_params.rb +7 -1
  43. data/lib/courier/models/notifications/check_update_params.rb +7 -1
  44. data/lib/courier/models/notifications/draft_retrieve_content_params.rb +7 -1
  45. data/lib/courier/models/profile_create_params.rb +7 -1
  46. data/lib/courier/models/profile_delete_params.rb +7 -1
  47. data/lib/courier/models/profile_replace_params.rb +7 -1
  48. data/lib/courier/models/profile_retrieve_params.rb +7 -1
  49. data/lib/courier/models/profile_update_params.rb +8 -1
  50. data/lib/courier/models/profiles/list_delete_params.rb +7 -1
  51. data/lib/courier/models/profiles/list_retrieve_params.rb +8 -1
  52. data/lib/courier/models/profiles/list_subscribe_params.rb +7 -1
  53. data/lib/courier/models/request_archive_params.rb +7 -1
  54. data/lib/courier/models/tenant_delete_params.rb +7 -1
  55. data/lib/courier/models/tenant_list_users_params.rb +8 -1
  56. data/lib/courier/models/tenant_retrieve_params.rb +7 -1
  57. data/lib/courier/models/tenant_update_params.rb +8 -1
  58. data/lib/courier/models/tenants/preferences/item_delete_params.rb +7 -1
  59. data/lib/courier/models/tenants/preferences/item_update_params.rb +7 -1
  60. data/lib/courier/models/tenants/template_list_params.rb +8 -1
  61. data/lib/courier/models/tenants/template_publish_params.rb +7 -1
  62. data/lib/courier/models/tenants/template_replace_params.rb +7 -1
  63. data/lib/courier/models/tenants/template_retrieve_params.rb +7 -1
  64. data/lib/courier/models/tenants/templates/version_retrieve_params.rb +7 -1
  65. data/lib/courier/models/translation_retrieve_params.rb +7 -1
  66. data/lib/courier/models/translation_update_params.rb +7 -1
  67. data/lib/courier/models/users/preference_retrieve_params.rb +8 -1
  68. data/lib/courier/models/users/preference_retrieve_topic_params.rb +8 -1
  69. data/lib/courier/models/users/preference_update_or_create_topic_params.rb +8 -1
  70. data/lib/courier/models/users/tenant_add_multiple_params.rb +7 -1
  71. data/lib/courier/models/users/tenant_add_single_params.rb +7 -1
  72. data/lib/courier/models/users/tenant_list_params.rb +8 -1
  73. data/lib/courier/models/users/tenant_remove_all_params.rb +7 -1
  74. data/lib/courier/models/users/tenant_remove_single_params.rb +7 -1
  75. data/lib/courier/models/users/token_add_multiple_params.rb +7 -1
  76. data/lib/courier/models/users/token_add_single_params.rb +168 -2
  77. data/lib/courier/models/users/token_delete_params.rb +7 -1
  78. data/lib/courier/models/users/token_list_params.rb +7 -1
  79. data/lib/courier/models/users/token_retrieve_params.rb +7 -1
  80. data/lib/courier/models/users/token_update_params.rb +7 -1
  81. data/lib/courier/models.rb +12 -0
  82. data/lib/courier/resources/audiences.rb +4 -2
  83. data/lib/courier/resources/audit_events.rb +2 -1
  84. data/lib/courier/resources/automations.rb +2 -1
  85. data/lib/courier/resources/brands.rb +2 -1
  86. data/lib/courier/resources/bulk.rb +2 -1
  87. data/lib/courier/resources/journeys.rb +73 -0
  88. data/lib/courier/resources/lists/subscriptions.rb +2 -1
  89. data/lib/courier/resources/lists.rb +2 -1
  90. data/lib/courier/resources/messages.rb +4 -2
  91. data/lib/courier/resources/notifications.rb +2 -1
  92. data/lib/courier/resources/profiles/lists.rb +2 -1
  93. data/lib/courier/resources/tenants/templates.rb +2 -1
  94. data/lib/courier/resources/tenants.rb +4 -2
  95. data/lib/courier/resources/users/preferences.rb +7 -4
  96. data/lib/courier/resources/users/tenants.rb +2 -1
  97. data/lib/courier/resources/users/tokens.rb +7 -9
  98. data/lib/courier/version.rb +1 -1
  99. data/lib/courier.rb +7 -0
  100. data/rbi/courier/client.rbi +3 -0
  101. data/rbi/courier/internal/util.rbi +20 -0
  102. data/rbi/courier/models/audience_delete_params.rbi +13 -5
  103. data/rbi/courier/models/audience_list_members_params.rbi +6 -0
  104. data/rbi/courier/models/audience_retrieve_params.rbi +13 -5
  105. data/rbi/courier/models/audience_update_params.rbi +6 -0
  106. data/rbi/courier/models/audit_event_retrieve_params.rbi +13 -5
  107. data/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi +6 -0
  108. data/rbi/courier/models/brand_delete_params.rbi +13 -5
  109. data/rbi/courier/models/brand_retrieve_params.rbi +13 -5
  110. data/rbi/courier/models/brand_update_params.rbi +6 -0
  111. data/rbi/courier/models/bulk_add_users_params.rbi +6 -1
  112. data/rbi/courier/models/bulk_list_users_params.rbi +6 -0
  113. data/rbi/courier/models/bulk_retrieve_job_params.rbi +13 -5
  114. data/rbi/courier/models/bulk_run_job_params.rbi +13 -5
  115. data/rbi/courier/models/elemental_content.rbi +3 -9
  116. data/rbi/courier/models/journey.rbi +91 -0
  117. data/rbi/courier/models/journey_invoke_params.rbi +35 -0
  118. data/rbi/courier/models/journey_list_params.rbi +85 -0
  119. data/rbi/courier/models/journeys_invoke_request.rbi +84 -0
  120. data/rbi/courier/models/journeys_invoke_response.rbi +27 -0
  121. data/rbi/courier/models/journeys_list_response.rbi +46 -0
  122. data/rbi/courier/models/list_delete_params.rbi +13 -5
  123. data/rbi/courier/models/list_restore_params.rbi +13 -5
  124. data/rbi/courier/models/list_retrieve_params.rbi +13 -5
  125. data/rbi/courier/models/list_update_params.rbi +6 -1
  126. data/rbi/courier/models/lists/subscription_add_params.rbi +6 -1
  127. data/rbi/courier/models/lists/subscription_list_params.rbi +6 -0
  128. data/rbi/courier/models/lists/subscription_subscribe_params.rbi +6 -1
  129. data/rbi/courier/models/lists/subscription_subscribe_user_params.rbi +6 -1
  130. data/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi +10 -2
  131. data/rbi/courier/models/message_cancel_params.rbi +13 -5
  132. data/rbi/courier/models/message_content_params.rbi +13 -5
  133. data/rbi/courier/models/message_details.rbi +55 -43
  134. data/rbi/courier/models/message_history_params.rbi +10 -1
  135. data/rbi/courier/models/message_retrieve_params.rbi +13 -5
  136. data/rbi/courier/models/notification_retrieve_content_params.rbi +13 -5
  137. data/rbi/courier/models/notifications/check_delete_params.rbi +10 -2
  138. data/rbi/courier/models/notifications/check_list_params.rbi +10 -2
  139. data/rbi/courier/models/notifications/check_update_params.rbi +6 -1
  140. data/rbi/courier/models/notifications/draft_retrieve_content_params.rbi +13 -5
  141. data/rbi/courier/models/profile_create_params.rbi +6 -1
  142. data/rbi/courier/models/profile_delete_params.rbi +13 -5
  143. data/rbi/courier/models/profile_replace_params.rbi +6 -1
  144. data/rbi/courier/models/profile_retrieve_params.rbi +13 -5
  145. data/rbi/courier/models/profile_update_params.rbi +6 -0
  146. data/rbi/courier/models/profiles/list_delete_params.rbi +13 -5
  147. data/rbi/courier/models/profiles/list_retrieve_params.rbi +6 -0
  148. data/rbi/courier/models/profiles/list_subscribe_params.rbi +6 -1
  149. data/rbi/courier/models/request_archive_params.rbi +13 -5
  150. data/rbi/courier/models/tenant_delete_params.rbi +13 -5
  151. data/rbi/courier/models/tenant_list_users_params.rbi +6 -0
  152. data/rbi/courier/models/tenant_retrieve_params.rbi +13 -5
  153. data/rbi/courier/models/tenant_update_params.rbi +6 -0
  154. data/rbi/courier/models/tenants/preferences/item_delete_params.rbi +10 -2
  155. data/rbi/courier/models/tenants/preferences/item_update_params.rbi +10 -2
  156. data/rbi/courier/models/tenants/template_list_params.rbi +6 -0
  157. data/rbi/courier/models/tenants/template_publish_params.rbi +10 -2
  158. data/rbi/courier/models/tenants/template_replace_params.rbi +10 -2
  159. data/rbi/courier/models/tenants/template_retrieve_params.rbi +10 -2
  160. data/rbi/courier/models/tenants/templates/version_retrieve_params.rbi +6 -1
  161. data/rbi/courier/models/translation_retrieve_params.rbi +10 -2
  162. data/rbi/courier/models/translation_update_params.rbi +6 -1
  163. data/rbi/courier/models/users/preference_retrieve_params.rbi +6 -0
  164. data/rbi/courier/models/users/preference_retrieve_topic_params.rbi +6 -0
  165. data/rbi/courier/models/users/preference_update_or_create_topic_params.rbi +6 -0
  166. data/rbi/courier/models/users/tenant_add_multiple_params.rbi +6 -1
  167. data/rbi/courier/models/users/tenant_add_single_params.rbi +6 -1
  168. data/rbi/courier/models/users/tenant_list_params.rbi +6 -0
  169. data/rbi/courier/models/users/tenant_remove_all_params.rbi +13 -5
  170. data/rbi/courier/models/users/tenant_remove_single_params.rbi +10 -2
  171. data/rbi/courier/models/users/token_add_multiple_params.rbi +13 -5
  172. data/rbi/courier/models/users/token_add_single_params.rbi +290 -3
  173. data/rbi/courier/models/users/token_delete_params.rbi +10 -2
  174. data/rbi/courier/models/users/token_list_params.rbi +13 -5
  175. data/rbi/courier/models/users/token_retrieve_params.rbi +10 -2
  176. data/rbi/courier/models/users/token_update_params.rbi +6 -1
  177. data/rbi/courier/models.rbi +12 -0
  178. data/rbi/courier/resources/journeys.rbi +64 -0
  179. data/rbi/courier/resources/users/tokens.rbi +11 -9
  180. data/sig/courier/client.rbs +2 -0
  181. data/sig/courier/internal/util.rbs +10 -0
  182. data/sig/courier/models/audience_delete_params.rbs +11 -3
  183. data/sig/courier/models/audience_list_members_params.rbs +6 -1
  184. data/sig/courier/models/audience_retrieve_params.rbs +11 -3
  185. data/sig/courier/models/audience_update_params.rbs +5 -0
  186. data/sig/courier/models/audit_event_retrieve_params.rbs +11 -3
  187. data/sig/courier/models/automations/invoke_invoke_by_template_params.rbs +5 -0
  188. data/sig/courier/models/brand_delete_params.rbs +11 -3
  189. data/sig/courier/models/brand_retrieve_params.rbs +11 -3
  190. data/sig/courier/models/brand_update_params.rbs +5 -0
  191. data/sig/courier/models/bulk_add_users_params.rbs +5 -1
  192. data/sig/courier/models/bulk_list_users_params.rbs +6 -1
  193. data/sig/courier/models/bulk_retrieve_job_params.rbs +11 -3
  194. data/sig/courier/models/bulk_run_job_params.rbs +11 -3
  195. data/sig/courier/models/elemental_content.rbs +3 -11
  196. data/sig/courier/models/journey.rbs +55 -0
  197. data/sig/courier/models/journey_invoke_params.rbs +25 -0
  198. data/sig/courier/models/journey_list_params.rbs +45 -0
  199. data/sig/courier/models/journeys_invoke_request.rbs +36 -0
  200. data/sig/courier/models/journeys_invoke_response.rbs +13 -0
  201. data/sig/courier/models/journeys_list_response.rbs +23 -0
  202. data/sig/courier/models/list_delete_params.rbs +12 -3
  203. data/sig/courier/models/list_restore_params.rbs +11 -3
  204. data/sig/courier/models/list_retrieve_params.rbs +11 -3
  205. data/sig/courier/models/list_update_params.rbs +9 -1
  206. data/sig/courier/models/lists/subscription_add_params.rbs +8 -1
  207. data/sig/courier/models/lists/subscription_list_params.rbs +6 -1
  208. data/sig/courier/models/lists/subscription_subscribe_params.rbs +8 -1
  209. data/sig/courier/models/lists/subscription_subscribe_user_params.rbs +9 -1
  210. data/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs +6 -1
  211. data/sig/courier/models/message_cancel_params.rbs +11 -3
  212. data/sig/courier/models/message_content_params.rbs +11 -3
  213. data/sig/courier/models/message_details.rbs +31 -23
  214. data/sig/courier/models/message_history_params.rbs +6 -1
  215. data/sig/courier/models/message_retrieve_params.rbs +11 -3
  216. data/sig/courier/models/notification_retrieve_content_params.rbs +8 -3
  217. data/sig/courier/models/notifications/check_delete_params.rbs +10 -2
  218. data/sig/courier/models/notifications/check_list_params.rbs +10 -2
  219. data/sig/courier/models/notifications/check_update_params.rbs +9 -1
  220. data/sig/courier/models/notifications/draft_retrieve_content_params.rbs +8 -3
  221. data/sig/courier/models/profile_create_params.rbs +5 -1
  222. data/sig/courier/models/profile_delete_params.rbs +11 -3
  223. data/sig/courier/models/profile_replace_params.rbs +5 -1
  224. data/sig/courier/models/profile_retrieve_params.rbs +11 -3
  225. data/sig/courier/models/profile_update_params.rbs +5 -1
  226. data/sig/courier/models/profiles/list_delete_params.rbs +11 -3
  227. data/sig/courier/models/profiles/list_retrieve_params.rbs +6 -1
  228. data/sig/courier/models/profiles/list_subscribe_params.rbs +8 -1
  229. data/sig/courier/models/request_archive_params.rbs +11 -3
  230. data/sig/courier/models/tenant_delete_params.rbs +11 -3
  231. data/sig/courier/models/tenant_list_users_params.rbs +5 -1
  232. data/sig/courier/models/tenant_retrieve_params.rbs +11 -3
  233. data/sig/courier/models/tenant_update_params.rbs +5 -0
  234. data/sig/courier/models/tenants/preferences/item_delete_params.rbs +6 -1
  235. data/sig/courier/models/tenants/preferences/item_update_params.rbs +8 -1
  236. data/sig/courier/models/tenants/template_list_params.rbs +5 -1
  237. data/sig/courier/models/tenants/template_publish_params.rbs +8 -1
  238. data/sig/courier/models/tenants/template_replace_params.rbs +8 -1
  239. data/sig/courier/models/tenants/template_retrieve_params.rbs +6 -1
  240. data/sig/courier/models/tenants/templates/version_retrieve_params.rbs +5 -1
  241. data/sig/courier/models/translation_retrieve_params.rbs +6 -1
  242. data/sig/courier/models/translation_update_params.rbs +5 -1
  243. data/sig/courier/models/users/preference_retrieve_params.rbs +6 -1
  244. data/sig/courier/models/users/preference_retrieve_topic_params.rbs +5 -1
  245. data/sig/courier/models/users/preference_update_or_create_topic_params.rbs +5 -0
  246. data/sig/courier/models/users/tenant_add_multiple_params.rbs +5 -1
  247. data/sig/courier/models/users/tenant_add_single_params.rbs +5 -1
  248. data/sig/courier/models/users/tenant_list_params.rbs +5 -1
  249. data/sig/courier/models/users/tenant_remove_all_params.rbs +11 -3
  250. data/sig/courier/models/users/tenant_remove_single_params.rbs +6 -1
  251. data/sig/courier/models/users/token_add_multiple_params.rbs +11 -3
  252. data/sig/courier/models/users/token_add_single_params.rbs +127 -4
  253. data/sig/courier/models/users/token_delete_params.rbs +6 -1
  254. data/sig/courier/models/users/token_list_params.rbs +11 -3
  255. data/sig/courier/models/users/token_retrieve_params.rbs +6 -1
  256. data/sig/courier/models/users/token_update_params.rbs +5 -0
  257. data/sig/courier/models.rbs +12 -0
  258. data/sig/courier/resources/journeys.rbs +21 -0
  259. data/sig/courier/resources/users/tokens.rbs +5 -6
  260. metadata +23 -2
@@ -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
@@ -11,6 +11,9 @@ module Courier
11
11
  T.any(Courier::TenantUpdateParams, Courier::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :tenant_id
16
+
14
17
  # Name of the tenant.
15
18
  sig { returns(String) }
16
19
  attr_accessor :name
@@ -45,6 +48,7 @@ module Courier
45
48
 
46
49
  sig do
47
50
  params(
51
+ tenant_id: String,
48
52
  name: String,
49
53
  brand_id: T.nilable(String),
50
54
  default_preferences: T.nilable(Courier::DefaultPreferences::OrHash),
@@ -55,6 +59,7 @@ module Courier
55
59
  ).returns(T.attached_class)
56
60
  end
57
61
  def self.new(
62
+ tenant_id:,
58
63
  # Name of the tenant.
59
64
  name:,
60
65
  # Brand to be used for the account when one is not specified by the send call.
@@ -75,6 +80,7 @@ module Courier
75
80
  sig do
76
81
  override.returns(
77
82
  {
83
+ tenant_id: String,
78
84
  name: String,
79
85
  brand_id: T.nilable(String),
80
86
  default_preferences: T.nilable(Courier::DefaultPreferences),
@@ -19,18 +19,26 @@ module Courier
19
19
  sig { returns(String) }
20
20
  attr_accessor :tenant_id
21
21
 
22
+ sig { returns(String) }
23
+ attr_accessor :topic_id
24
+
22
25
  sig do
23
26
  params(
24
27
  tenant_id: String,
28
+ topic_id: String,
25
29
  request_options: Courier::RequestOptions::OrHash
26
30
  ).returns(T.attached_class)
27
31
  end
28
- def self.new(tenant_id:, request_options: {})
32
+ def self.new(tenant_id:, topic_id:, request_options: {})
29
33
  end
30
34
 
31
35
  sig do
32
36
  override.returns(
33
- { tenant_id: String, request_options: Courier::RequestOptions }
37
+ {
38
+ tenant_id: String,
39
+ topic_id: String,
40
+ request_options: Courier::RequestOptions
41
+ }
34
42
  )
35
43
  end
36
44
  def to_hash
@@ -19,18 +19,26 @@ module Courier
19
19
  sig { returns(String) }
20
20
  attr_accessor :tenant_id
21
21
 
22
+ sig { returns(String) }
23
+ attr_accessor :topic_id
24
+
22
25
  sig do
23
26
  params(
24
27
  tenant_id: String,
28
+ topic_id: String,
25
29
  request_options: Courier::RequestOptions::OrHash
26
30
  ).returns(T.attached_class)
27
31
  end
28
- def self.new(tenant_id:, request_options: {})
32
+ def self.new(tenant_id:, topic_id:, request_options: {})
29
33
  end
30
34
 
31
35
  sig do
32
36
  override.returns(
33
- { tenant_id: String, request_options: Courier::RequestOptions }
37
+ {
38
+ tenant_id: String,
39
+ topic_id: String,
40
+ request_options: Courier::RequestOptions
41
+ }
34
42
  )
35
43
  end
36
44
  def to_hash
@@ -15,6 +15,9 @@ module Courier
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :tenant_id
20
+
18
21
  # Continue the pagination with the next cursor
19
22
  sig { returns(T.nilable(String)) }
20
23
  attr_accessor :cursor
@@ -25,12 +28,14 @@ module Courier
25
28
 
26
29
  sig do
27
30
  params(
31
+ tenant_id: String,
28
32
  cursor: T.nilable(String),
29
33
  limit: T.nilable(Integer),
30
34
  request_options: Courier::RequestOptions::OrHash
31
35
  ).returns(T.attached_class)
32
36
  end
33
37
  def self.new(
38
+ tenant_id:,
34
39
  # Continue the pagination with the next cursor
35
40
  cursor: nil,
36
41
  # The number of templates to return (defaults to 20, maximum value of 100)
@@ -42,6 +47,7 @@ module Courier
42
47
  sig do
43
48
  override.returns(
44
49
  {
50
+ tenant_id: String,
45
51
  cursor: T.nilable(String),
46
52
  limit: T.nilable(Integer),
47
53
  request_options: Courier::RequestOptions
@@ -18,18 +18,26 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :tenant_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :template_id
23
+
21
24
  sig do
22
25
  params(
23
26
  tenant_id: String,
27
+ template_id: String,
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(tenant_id:, request_options: {})
31
+ def self.new(tenant_id:, template_id:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
- { tenant_id: String, request_options: Courier::RequestOptions }
36
+ {
37
+ tenant_id: String,
38
+ template_id: String,
39
+ request_options: Courier::RequestOptions
40
+ }
33
41
  )
34
42
  end
35
43
  def to_hash
@@ -18,18 +18,26 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :tenant_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :template_id
23
+
21
24
  sig do
22
25
  params(
23
26
  tenant_id: String,
27
+ template_id: String,
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(tenant_id:, request_options: {})
31
+ def self.new(tenant_id:, template_id:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
- { tenant_id: String, request_options: Courier::RequestOptions }
36
+ {
37
+ tenant_id: String,
38
+ template_id: String,
39
+ request_options: Courier::RequestOptions
40
+ }
33
41
  )
34
42
  end
35
43
  def to_hash
@@ -18,18 +18,26 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :tenant_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :template_id
23
+
21
24
  sig do
22
25
  params(
23
26
  tenant_id: String,
27
+ template_id: String,
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(tenant_id:, request_options: {})
31
+ def self.new(tenant_id:, template_id:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
- { tenant_id: String, request_options: Courier::RequestOptions }
36
+ {
37
+ tenant_id: String,
38
+ template_id: String,
39
+ request_options: Courier::RequestOptions
40
+ }
33
41
  )
34
42
  end
35
43
  def to_hash
@@ -22,14 +22,18 @@ module Courier
22
22
  sig { returns(String) }
23
23
  attr_accessor :template_id
24
24
 
25
+ sig { returns(String) }
26
+ attr_accessor :version
27
+
25
28
  sig do
26
29
  params(
27
30
  tenant_id: String,
28
31
  template_id: String,
32
+ version: String,
29
33
  request_options: Courier::RequestOptions::OrHash
30
34
  ).returns(T.attached_class)
31
35
  end
32
- def self.new(tenant_id:, template_id:, request_options: {})
36
+ def self.new(tenant_id:, template_id:, version:, request_options: {})
33
37
  end
34
38
 
35
39
  sig do
@@ -37,6 +41,7 @@ module Courier
37
41
  {
38
42
  tenant_id: String,
39
43
  template_id: String,
44
+ version: String,
40
45
  request_options: Courier::RequestOptions
41
46
  }
42
47
  )
@@ -14,18 +14,26 @@ module Courier
14
14
  sig { returns(String) }
15
15
  attr_accessor :domain
16
16
 
17
+ sig { returns(String) }
18
+ attr_accessor :locale
19
+
17
20
  sig do
18
21
  params(
19
22
  domain: String,
23
+ locale: String,
20
24
  request_options: Courier::RequestOptions::OrHash
21
25
  ).returns(T.attached_class)
22
26
  end
23
- def self.new(domain:, request_options: {})
27
+ def self.new(domain:, locale:, request_options: {})
24
28
  end
25
29
 
26
30
  sig do
27
31
  override.returns(
28
- { domain: String, request_options: Courier::RequestOptions }
32
+ {
33
+ domain: String,
34
+ locale: String,
35
+ request_options: Courier::RequestOptions
36
+ }
29
37
  )
30
38
  end
31
39
  def to_hash
@@ -14,23 +14,28 @@ module Courier
14
14
  sig { returns(String) }
15
15
  attr_accessor :domain
16
16
 
17
+ sig { returns(String) }
18
+ attr_accessor :locale
19
+
17
20
  sig { returns(String) }
18
21
  attr_accessor :body
19
22
 
20
23
  sig do
21
24
  params(
22
25
  domain: String,
26
+ locale: String,
23
27
  body: String,
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(domain:, body:, request_options: {})
31
+ def self.new(domain:, locale:, body:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
36
  {
33
37
  domain: String,
38
+ locale: String,
34
39
  body: String,
35
40
  request_options: Courier::RequestOptions
36
41
  }
@@ -15,17 +15,22 @@ module Courier
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :user_id
20
+
18
21
  # Query the preferences of a user for this specific tenant context.
19
22
  sig { returns(T.nilable(String)) }
20
23
  attr_accessor :tenant_id
21
24
 
22
25
  sig do
23
26
  params(
27
+ user_id: String,
24
28
  tenant_id: T.nilable(String),
25
29
  request_options: Courier::RequestOptions::OrHash
26
30
  ).returns(T.attached_class)
27
31
  end
28
32
  def self.new(
33
+ user_id:,
29
34
  # Query the preferences of a user for this specific tenant context.
30
35
  tenant_id: nil,
31
36
  request_options: {}
@@ -35,6 +40,7 @@ module Courier
35
40
  sig do
36
41
  override.returns(
37
42
  {
43
+ user_id: String,
38
44
  tenant_id: T.nilable(String),
39
45
  request_options: Courier::RequestOptions
40
46
  }
@@ -18,6 +18,9 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :user_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :topic_id
23
+
21
24
  # Query the preferences of a user for this specific tenant context.
22
25
  sig { returns(T.nilable(String)) }
23
26
  attr_accessor :tenant_id
@@ -25,12 +28,14 @@ module Courier
25
28
  sig do
26
29
  params(
27
30
  user_id: String,
31
+ topic_id: String,
28
32
  tenant_id: T.nilable(String),
29
33
  request_options: Courier::RequestOptions::OrHash
30
34
  ).returns(T.attached_class)
31
35
  end
32
36
  def self.new(
33
37
  user_id:,
38
+ topic_id:,
34
39
  # Query the preferences of a user for this specific tenant context.
35
40
  tenant_id: nil,
36
41
  request_options: {}
@@ -41,6 +46,7 @@ module Courier
41
46
  override.returns(
42
47
  {
43
48
  user_id: String,
49
+ topic_id: String,
44
50
  tenant_id: T.nilable(String),
45
51
  request_options: Courier::RequestOptions
46
52
  }
@@ -18,6 +18,9 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :user_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :topic_id
23
+
21
24
  sig do
22
25
  returns(Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic)
23
26
  end
@@ -38,6 +41,7 @@ module Courier
38
41
  sig do
39
42
  params(
40
43
  user_id: String,
44
+ topic_id: String,
41
45
  topic:
42
46
  Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic::OrHash,
43
47
  tenant_id: T.nilable(String),
@@ -46,6 +50,7 @@ module Courier
46
50
  end
47
51
  def self.new(
48
52
  user_id:,
53
+ topic_id:,
49
54
  topic:,
50
55
  # Update the preferences of a user for this specific tenant context.
51
56
  tenant_id: nil,
@@ -57,6 +62,7 @@ module Courier
57
62
  override.returns(
58
63
  {
59
64
  user_id: String,
65
+ topic_id: String,
60
66
  topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
61
67
  tenant_id: T.nilable(String),
62
68
  request_options: Courier::RequestOptions
@@ -15,21 +15,26 @@ module Courier
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :user_id
20
+
18
21
  sig { returns(T::Array[Courier::TenantAssociation]) }
19
22
  attr_accessor :tenants
20
23
 
21
24
  sig do
22
25
  params(
26
+ user_id: String,
23
27
  tenants: T::Array[Courier::TenantAssociation::OrHash],
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(tenants:, request_options: {})
31
+ def self.new(user_id:, tenants:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
36
  {
37
+ user_id: String,
33
38
  tenants: T::Array[Courier::TenantAssociation],
34
39
  request_options: Courier::RequestOptions
35
40
  }
@@ -18,23 +18,28 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :user_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :tenant_id
23
+
21
24
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
22
25
  attr_accessor :profile
23
26
 
24
27
  sig do
25
28
  params(
26
29
  user_id: String,
30
+ tenant_id: String,
27
31
  profile: T.nilable(T::Hash[Symbol, T.anything]),
28
32
  request_options: Courier::RequestOptions::OrHash
29
33
  ).returns(T.attached_class)
30
34
  end
31
- def self.new(user_id:, profile: nil, request_options: {})
35
+ def self.new(user_id:, tenant_id:, profile: nil, request_options: {})
32
36
  end
33
37
 
34
38
  sig do
35
39
  override.returns(
36
40
  {
37
41
  user_id: String,
42
+ tenant_id: String,
38
43
  profile: T.nilable(T::Hash[Symbol, T.anything]),
39
44
  request_options: Courier::RequestOptions
40
45
  }
@@ -12,6 +12,9 @@ module Courier
12
12
  T.any(Courier::Users::TenantListParams, Courier::Internal::AnyHash)
13
13
  end
14
14
 
15
+ sig { returns(String) }
16
+ attr_accessor :user_id
17
+
15
18
  # Continue the pagination with the next cursor
16
19
  sig { returns(T.nilable(String)) }
17
20
  attr_accessor :cursor
@@ -22,12 +25,14 @@ module Courier
22
25
 
23
26
  sig do
24
27
  params(
28
+ user_id: String,
25
29
  cursor: T.nilable(String),
26
30
  limit: T.nilable(Integer),
27
31
  request_options: Courier::RequestOptions::OrHash
28
32
  ).returns(T.attached_class)
29
33
  end
30
34
  def self.new(
35
+ user_id:,
31
36
  # Continue the pagination with the next cursor
32
37
  cursor: nil,
33
38
  # The number of accounts to return (defaults to 20, maximum value of 100)
@@ -39,6 +44,7 @@ module Courier
39
44
  sig do
40
45
  override.returns(
41
46
  {
47
+ user_id: String,
42
48
  cursor: T.nilable(String),
43
49
  limit: T.nilable(Integer),
44
50
  request_options: Courier::RequestOptions
@@ -15,15 +15,23 @@ module Courier
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :user_id
20
+
18
21
  sig do
19
- params(request_options: Courier::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
22
+ params(
23
+ user_id: String,
24
+ request_options: Courier::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
22
26
  end
23
- def self.new(request_options: {})
27
+ def self.new(user_id:, request_options: {})
24
28
  end
25
29
 
26
- sig { override.returns({ request_options: Courier::RequestOptions }) }
30
+ sig do
31
+ override.returns(
32
+ { user_id: String, request_options: Courier::RequestOptions }
33
+ )
34
+ end
27
35
  def to_hash
28
36
  end
29
37
  end
@@ -18,18 +18,26 @@ module Courier
18
18
  sig { returns(String) }
19
19
  attr_accessor :user_id
20
20
 
21
+ sig { returns(String) }
22
+ attr_accessor :tenant_id
23
+
21
24
  sig do
22
25
  params(
23
26
  user_id: String,
27
+ tenant_id: String,
24
28
  request_options: Courier::RequestOptions::OrHash
25
29
  ).returns(T.attached_class)
26
30
  end
27
- def self.new(user_id:, request_options: {})
31
+ def self.new(user_id:, tenant_id:, request_options: {})
28
32
  end
29
33
 
30
34
  sig do
31
35
  override.returns(
32
- { user_id: String, request_options: Courier::RequestOptions }
36
+ {
37
+ user_id: String,
38
+ tenant_id: String,
39
+ request_options: Courier::RequestOptions
40
+ }
33
41
  )
34
42
  end
35
43
  def to_hash
@@ -15,15 +15,23 @@ module Courier
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :user_id
20
+
18
21
  sig do
19
- params(request_options: Courier::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
22
+ params(
23
+ user_id: String,
24
+ request_options: Courier::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
22
26
  end
23
- def self.new(request_options: {})
27
+ def self.new(user_id:, request_options: {})
24
28
  end
25
29
 
26
- sig { override.returns({ request_options: Courier::RequestOptions }) }
30
+ sig do
31
+ override.returns(
32
+ { user_id: String, request_options: Courier::RequestOptions }
33
+ )
34
+ end
27
35
  def to_hash
28
36
  end
29
37
  end