trycourier 4.7.0 → 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 +39 -0
  3. data/README.md +25 -235
  4. data/lib/courier/client.rb +4 -0
  5. data/lib/courier/internal/util.rb +32 -1
  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 +21 -1
  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
@@ -2,20 +2,25 @@ module Courier
2
2
  module Models
3
3
  module Lists
4
4
  type subscription_list_params =
5
- { cursor: String? } & Courier::Internal::Type::request_parameters
5
+ { list_id: String, cursor: String? }
6
+ & Courier::Internal::Type::request_parameters
6
7
 
7
8
  class SubscriptionListParams < Courier::Internal::Type::BaseModel
8
9
  extend Courier::Internal::Type::RequestParameters::Converter
9
10
  include Courier::Internal::Type::RequestParameters
10
11
 
12
+ attr_accessor list_id: String
13
+
11
14
  attr_accessor cursor: String?
12
15
 
13
16
  def initialize: (
17
+ list_id: String,
14
18
  ?cursor: String?,
15
19
  ?request_options: Courier::request_opts
16
20
  ) -> void
17
21
 
18
22
  def to_hash: -> {
23
+ list_id: String,
19
24
  cursor: String?,
20
25
  request_options: Courier::RequestOptions
21
26
  }
@@ -2,21 +2,28 @@ module Courier
2
2
  module Models
3
3
  module Lists
4
4
  type subscription_subscribe_params =
5
- { recipients: ::Array[Courier::PutSubscriptionsRecipient] }
5
+ {
6
+ list_id: String,
7
+ recipients: ::Array[Courier::PutSubscriptionsRecipient]
8
+ }
6
9
  & Courier::Internal::Type::request_parameters
7
10
 
8
11
  class SubscriptionSubscribeParams < Courier::Internal::Type::BaseModel
9
12
  extend Courier::Internal::Type::RequestParameters::Converter
10
13
  include Courier::Internal::Type::RequestParameters
11
14
 
15
+ attr_accessor list_id: String
16
+
12
17
  attr_accessor recipients: ::Array[Courier::PutSubscriptionsRecipient]
13
18
 
14
19
  def initialize: (
20
+ list_id: String,
15
21
  recipients: ::Array[Courier::PutSubscriptionsRecipient],
16
22
  ?request_options: Courier::request_opts
17
23
  ) -> void
18
24
 
19
25
  def to_hash: -> {
26
+ list_id: String,
20
27
  recipients: ::Array[Courier::PutSubscriptionsRecipient],
21
28
  request_options: Courier::RequestOptions
22
29
  }
@@ -2,7 +2,11 @@ module Courier
2
2
  module Models
3
3
  module Lists
4
4
  type subscription_subscribe_user_params =
5
- { list_id: String, preferences: Courier::RecipientPreferences? }
5
+ {
6
+ list_id: String,
7
+ user_id: String,
8
+ preferences: Courier::RecipientPreferences?
9
+ }
6
10
  & Courier::Internal::Type::request_parameters
7
11
 
8
12
  class SubscriptionSubscribeUserParams < Courier::Internal::Type::BaseModel
@@ -11,16 +15,20 @@ module Courier
11
15
 
12
16
  attr_accessor list_id: String
13
17
 
18
+ attr_accessor user_id: String
19
+
14
20
  attr_accessor preferences: Courier::RecipientPreferences?
15
21
 
16
22
  def initialize: (
17
23
  list_id: String,
24
+ user_id: String,
18
25
  ?preferences: Courier::RecipientPreferences?,
19
26
  ?request_options: Courier::request_opts
20
27
  ) -> void
21
28
 
22
29
  def to_hash: -> {
23
30
  list_id: String,
31
+ user_id: String,
24
32
  preferences: Courier::RecipientPreferences?,
25
33
  request_options: Courier::RequestOptions
26
34
  }
@@ -2,7 +2,8 @@ module Courier
2
2
  module Models
3
3
  module Lists
4
4
  type subscription_unsubscribe_user_params =
5
- { list_id: String } & Courier::Internal::Type::request_parameters
5
+ { list_id: String, user_id: String }
6
+ & Courier::Internal::Type::request_parameters
6
7
 
7
8
  class SubscriptionUnsubscribeUserParams < Courier::Internal::Type::BaseModel
8
9
  extend Courier::Internal::Type::RequestParameters::Converter
@@ -10,13 +11,17 @@ module Courier
10
11
 
11
12
  attr_accessor list_id: String
12
13
 
14
+ attr_accessor user_id: String
15
+
13
16
  def initialize: (
14
17
  list_id: String,
18
+ user_id: String,
15
19
  ?request_options: Courier::request_opts
16
20
  ) -> void
17
21
 
18
22
  def to_hash: -> {
19
23
  list_id: String,
24
+ user_id: String,
20
25
  request_options: Courier::RequestOptions
21
26
  }
22
27
  end
@@ -1,15 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
3
  type message_cancel_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { message_id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class MessageCancelParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor message_id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ message_id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ message_id: String,
19
+ request_options: Courier::RequestOptions
20
+ }
13
21
  end
14
22
  end
15
23
  end
@@ -1,15 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
3
  type message_content_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { message_id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class MessageContentParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor message_id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ message_id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ message_id: String,
19
+ request_options: Courier::RequestOptions
20
+ }
13
21
  end
14
22
  end
15
23
  end
@@ -3,72 +3,80 @@ module Courier
3
3
  type message_details =
4
4
  {
5
5
  id: String,
6
- clicked: Integer,
7
- delivered: Integer,
8
6
  enqueued: Integer,
9
7
  event: String,
10
8
  notification: String,
11
- opened: Integer,
12
9
  recipient: String,
13
- sent: Integer,
14
10
  status: Courier::Models::MessageDetails::status,
11
+ clicked: Integer,
12
+ delivered: Integer,
15
13
  error: String?,
16
- reason: Courier::Models::MessageDetails::reason?
14
+ opened: Integer,
15
+ reason: Courier::Models::MessageDetails::reason?,
16
+ sent: Integer
17
17
  }
18
18
 
19
19
  class MessageDetails < Courier::Internal::Type::BaseModel
20
20
  attr_accessor id: String
21
21
 
22
- attr_accessor clicked: Integer
23
-
24
- attr_accessor delivered: Integer
25
-
26
22
  attr_accessor enqueued: Integer
27
23
 
28
24
  attr_accessor event: String
29
25
 
30
26
  attr_accessor notification: String
31
27
 
32
- attr_accessor opened: Integer
33
-
34
28
  attr_accessor recipient: String
35
29
 
36
- attr_accessor sent: Integer
37
-
38
30
  attr_accessor status: Courier::Models::MessageDetails::status
39
31
 
32
+ attr_reader clicked: Integer?
33
+
34
+ def clicked=: (Integer) -> Integer
35
+
36
+ attr_reader delivered: Integer?
37
+
38
+ def delivered=: (Integer) -> Integer
39
+
40
40
  attr_accessor error: String?
41
41
 
42
+ attr_reader opened: Integer?
43
+
44
+ def opened=: (Integer) -> Integer
45
+
42
46
  attr_accessor reason: Courier::Models::MessageDetails::reason?
43
47
 
48
+ attr_reader sent: Integer?
49
+
50
+ def sent=: (Integer) -> Integer
51
+
44
52
  def initialize: (
45
53
  id: String,
46
- clicked: Integer,
47
- delivered: Integer,
48
54
  enqueued: Integer,
49
55
  event: String,
50
56
  notification: String,
51
- opened: Integer,
52
57
  recipient: String,
53
- sent: Integer,
54
58
  status: Courier::Models::MessageDetails::status,
59
+ ?clicked: Integer,
60
+ ?delivered: Integer,
55
61
  ?error: String?,
56
- ?reason: Courier::Models::MessageDetails::reason?
62
+ ?opened: Integer,
63
+ ?reason: Courier::Models::MessageDetails::reason?,
64
+ ?sent: Integer
57
65
  ) -> void
58
66
 
59
67
  def to_hash: -> {
60
68
  id: String,
61
- clicked: Integer,
62
- delivered: Integer,
63
69
  enqueued: Integer,
64
70
  event: String,
65
71
  notification: String,
66
- opened: Integer,
67
72
  recipient: String,
68
- sent: Integer,
69
73
  status: Courier::Models::MessageDetails::status,
74
+ clicked: Integer,
75
+ delivered: Integer,
70
76
  error: String?,
71
- reason: Courier::Models::MessageDetails::reason?
77
+ opened: Integer,
78
+ reason: Courier::Models::MessageDetails::reason?,
79
+ sent: Integer
72
80
  }
73
81
 
74
82
  type status =
@@ -1,20 +1,25 @@
1
1
  module Courier
2
2
  module Models
3
3
  type message_history_params =
4
- { type: String? } & Courier::Internal::Type::request_parameters
4
+ { message_id: String, type: String? }
5
+ & Courier::Internal::Type::request_parameters
5
6
 
6
7
  class MessageHistoryParams < Courier::Internal::Type::BaseModel
7
8
  extend Courier::Internal::Type::RequestParameters::Converter
8
9
  include Courier::Internal::Type::RequestParameters
9
10
 
11
+ attr_accessor message_id: String
12
+
10
13
  attr_accessor type: String?
11
14
 
12
15
  def initialize: (
16
+ message_id: String,
13
17
  ?type: String?,
14
18
  ?request_options: Courier::request_opts
15
19
  ) -> void
16
20
 
17
21
  def to_hash: -> {
22
+ message_id: String,
18
23
  type: String?,
19
24
  request_options: Courier::RequestOptions
20
25
  }
@@ -1,15 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
3
  type message_retrieve_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { message_id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class MessageRetrieveParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor message_id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ message_id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ message_id: String,
19
+ request_options: Courier::RequestOptions
20
+ }
13
21
  end
14
22
  end
15
23
  end
@@ -1,15 +1,20 @@
1
1
  module Courier
2
2
  module Models
3
3
  type notification_retrieve_content_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class NotificationRetrieveContentParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> { id: String, request_options: Courier::RequestOptions }
13
18
  end
14
19
  end
15
20
  end
@@ -2,7 +2,8 @@ module Courier
2
2
  module Models
3
3
  module Notifications
4
4
  type check_delete_params =
5
- { id: String } & Courier::Internal::Type::request_parameters
5
+ { id: String, submission_id: String }
6
+ & Courier::Internal::Type::request_parameters
6
7
 
7
8
  class CheckDeleteParams < Courier::Internal::Type::BaseModel
8
9
  extend Courier::Internal::Type::RequestParameters::Converter
@@ -10,12 +11,19 @@ module Courier
10
11
 
11
12
  attr_accessor id: String
12
13
 
14
+ attr_accessor submission_id: String
15
+
13
16
  def initialize: (
14
17
  id: String,
18
+ submission_id: String,
15
19
  ?request_options: Courier::request_opts
16
20
  ) -> void
17
21
 
18
- def to_hash: -> { id: String, request_options: Courier::RequestOptions }
22
+ def to_hash: -> {
23
+ id: String,
24
+ submission_id: String,
25
+ request_options: Courier::RequestOptions
26
+ }
19
27
  end
20
28
  end
21
29
  end
@@ -2,7 +2,8 @@ module Courier
2
2
  module Models
3
3
  module Notifications
4
4
  type check_list_params =
5
- { id: String } & Courier::Internal::Type::request_parameters
5
+ { id: String, submission_id: String }
6
+ & Courier::Internal::Type::request_parameters
6
7
 
7
8
  class CheckListParams < Courier::Internal::Type::BaseModel
8
9
  extend Courier::Internal::Type::RequestParameters::Converter
@@ -10,12 +11,19 @@ module Courier
10
11
 
11
12
  attr_accessor id: String
12
13
 
14
+ attr_accessor submission_id: String
15
+
13
16
  def initialize: (
14
17
  id: String,
18
+ submission_id: String,
15
19
  ?request_options: Courier::request_opts
16
20
  ) -> void
17
21
 
18
- def to_hash: -> { id: String, request_options: Courier::RequestOptions }
22
+ def to_hash: -> {
23
+ id: String,
24
+ submission_id: String,
25
+ request_options: Courier::RequestOptions
26
+ }
19
27
  end
20
28
  end
21
29
  end
@@ -2,7 +2,11 @@ module Courier
2
2
  module Models
3
3
  module Notifications
4
4
  type check_update_params =
5
- { id: String, checks: ::Array[Courier::BaseCheck] }
5
+ {
6
+ id: String,
7
+ submission_id: String,
8
+ checks: ::Array[Courier::BaseCheck]
9
+ }
6
10
  & Courier::Internal::Type::request_parameters
7
11
 
8
12
  class CheckUpdateParams < Courier::Internal::Type::BaseModel
@@ -11,16 +15,20 @@ module Courier
11
15
 
12
16
  attr_accessor id: String
13
17
 
18
+ attr_accessor submission_id: String
19
+
14
20
  attr_accessor checks: ::Array[Courier::BaseCheck]
15
21
 
16
22
  def initialize: (
17
23
  id: String,
24
+ submission_id: String,
18
25
  checks: ::Array[Courier::BaseCheck],
19
26
  ?request_options: Courier::request_opts
20
27
  ) -> void
21
28
 
22
29
  def to_hash: -> {
23
30
  id: String,
31
+ submission_id: String,
24
32
  checks: ::Array[Courier::BaseCheck],
25
33
  request_options: Courier::RequestOptions
26
34
  }
@@ -2,15 +2,20 @@ module Courier
2
2
  module Models
3
3
  module Notifications
4
4
  type draft_retrieve_content_params =
5
- { } & Courier::Internal::Type::request_parameters
5
+ { id: String } & Courier::Internal::Type::request_parameters
6
6
 
7
7
  class DraftRetrieveContentParams < Courier::Internal::Type::BaseModel
8
8
  extend Courier::Internal::Type::RequestParameters::Converter
9
9
  include Courier::Internal::Type::RequestParameters
10
10
 
11
- def initialize: (?request_options: Courier::request_opts) -> void
11
+ attr_accessor id: String
12
12
 
13
- def to_hash: -> { request_options: Courier::RequestOptions }
13
+ def initialize: (
14
+ id: String,
15
+ ?request_options: Courier::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> { id: String, request_options: Courier::RequestOptions }
14
19
  end
15
20
  end
16
21
  end
@@ -1,21 +1,25 @@
1
1
  module Courier
2
2
  module Models
3
3
  type profile_create_params =
4
- { profile: ::Hash[Symbol, top] }
4
+ { user_id: String, profile: ::Hash[Symbol, top] }
5
5
  & Courier::Internal::Type::request_parameters
6
6
 
7
7
  class ProfileCreateParams < Courier::Internal::Type::BaseModel
8
8
  extend Courier::Internal::Type::RequestParameters::Converter
9
9
  include Courier::Internal::Type::RequestParameters
10
10
 
11
+ attr_accessor user_id: String
12
+
11
13
  attr_accessor profile: ::Hash[Symbol, top]
12
14
 
13
15
  def initialize: (
16
+ user_id: String,
14
17
  profile: ::Hash[Symbol, top],
15
18
  ?request_options: Courier::request_opts
16
19
  ) -> void
17
20
 
18
21
  def to_hash: -> {
22
+ user_id: String,
19
23
  profile: ::Hash[Symbol, top],
20
24
  request_options: Courier::RequestOptions
21
25
  }
@@ -1,15 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
3
  type profile_delete_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { user_id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class ProfileDeleteParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor user_id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ user_id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ user_id: String,
19
+ request_options: Courier::RequestOptions
20
+ }
13
21
  end
14
22
  end
15
23
  end
@@ -1,21 +1,25 @@
1
1
  module Courier
2
2
  module Models
3
3
  type profile_replace_params =
4
- { profile: ::Hash[Symbol, top] }
4
+ { user_id: String, profile: ::Hash[Symbol, top] }
5
5
  & Courier::Internal::Type::request_parameters
6
6
 
7
7
  class ProfileReplaceParams < Courier::Internal::Type::BaseModel
8
8
  extend Courier::Internal::Type::RequestParameters::Converter
9
9
  include Courier::Internal::Type::RequestParameters
10
10
 
11
+ attr_accessor user_id: String
12
+
11
13
  attr_accessor profile: ::Hash[Symbol, top]
12
14
 
13
15
  def initialize: (
16
+ user_id: String,
14
17
  profile: ::Hash[Symbol, top],
15
18
  ?request_options: Courier::request_opts
16
19
  ) -> void
17
20
 
18
21
  def to_hash: -> {
22
+ user_id: String,
19
23
  profile: ::Hash[Symbol, top],
20
24
  request_options: Courier::RequestOptions
21
25
  }
@@ -1,15 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
3
  type profile_retrieve_params =
4
- { } & Courier::Internal::Type::request_parameters
4
+ { user_id: String } & Courier::Internal::Type::request_parameters
5
5
 
6
6
  class ProfileRetrieveParams < Courier::Internal::Type::BaseModel
7
7
  extend Courier::Internal::Type::RequestParameters::Converter
8
8
  include Courier::Internal::Type::RequestParameters
9
9
 
10
- def initialize: (?request_options: Courier::request_opts) -> void
10
+ attr_accessor user_id: String
11
11
 
12
- def to_hash: -> { request_options: Courier::RequestOptions }
12
+ def initialize: (
13
+ user_id: String,
14
+ ?request_options: Courier::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ user_id: String,
19
+ request_options: Courier::RequestOptions
20
+ }
13
21
  end
14
22
  end
15
23
  end
@@ -1,21 +1,25 @@
1
1
  module Courier
2
2
  module Models
3
3
  type profile_update_params =
4
- { patch: ::Array[Courier::ProfileUpdateParams::Patch] }
4
+ { user_id: String, patch: ::Array[Courier::ProfileUpdateParams::Patch] }
5
5
  & Courier::Internal::Type::request_parameters
6
6
 
7
7
  class ProfileUpdateParams < Courier::Internal::Type::BaseModel
8
8
  extend Courier::Internal::Type::RequestParameters::Converter
9
9
  include Courier::Internal::Type::RequestParameters
10
10
 
11
+ attr_accessor user_id: String
12
+
11
13
  attr_accessor patch: ::Array[Courier::ProfileUpdateParams::Patch]
12
14
 
13
15
  def initialize: (
16
+ user_id: String,
14
17
  patch: ::Array[Courier::ProfileUpdateParams::Patch],
15
18
  ?request_options: Courier::request_opts
16
19
  ) -> void
17
20
 
18
21
  def to_hash: -> {
22
+ user_id: String,
19
23
  patch: ::Array[Courier::ProfileUpdateParams::Patch],
20
24
  request_options: Courier::RequestOptions
21
25
  }
@@ -2,15 +2,23 @@ module Courier
2
2
  module Models
3
3
  module Profiles
4
4
  type list_delete_params =
5
- { } & Courier::Internal::Type::request_parameters
5
+ { user_id: String } & Courier::Internal::Type::request_parameters
6
6
 
7
7
  class ListDeleteParams < Courier::Internal::Type::BaseModel
8
8
  extend Courier::Internal::Type::RequestParameters::Converter
9
9
  include Courier::Internal::Type::RequestParameters
10
10
 
11
- def initialize: (?request_options: Courier::request_opts) -> void
11
+ attr_accessor user_id: String
12
12
 
13
- def to_hash: -> { request_options: Courier::RequestOptions }
13
+ def initialize: (
14
+ user_id: String,
15
+ ?request_options: Courier::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ user_id: String,
20
+ request_options: Courier::RequestOptions
21
+ }
14
22
  end
15
23
  end
16
24
  end
@@ -2,20 +2,25 @@ module Courier
2
2
  module Models
3
3
  module Profiles
4
4
  type list_retrieve_params =
5
- { cursor: String? } & Courier::Internal::Type::request_parameters
5
+ { user_id: String, cursor: String? }
6
+ & Courier::Internal::Type::request_parameters
6
7
 
7
8
  class ListRetrieveParams < Courier::Internal::Type::BaseModel
8
9
  extend Courier::Internal::Type::RequestParameters::Converter
9
10
  include Courier::Internal::Type::RequestParameters
10
11
 
12
+ attr_accessor user_id: String
13
+
11
14
  attr_accessor cursor: String?
12
15
 
13
16
  def initialize: (
17
+ user_id: String,
14
18
  ?cursor: String?,
15
19
  ?request_options: Courier::request_opts
16
20
  ) -> void
17
21
 
18
22
  def to_hash: -> {
23
+ user_id: String,
19
24
  cursor: String?,
20
25
  request_options: Courier::RequestOptions
21
26
  }