knockapi 1.2.0 → 1.3.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 (262) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/knockapi/internal/items_cursor.rb +2 -2
  6. data/lib/knockapi/internal/util.rb +10 -2
  7. data/lib/knockapi/models/activity.rb +4 -4
  8. data/lib/knockapi/models/audience_add_members_params.rb +5 -5
  9. data/lib/knockapi/models/audience_list_members_response.rb +4 -4
  10. data/lib/knockapi/models/audience_member.rb +4 -4
  11. data/lib/knockapi/models/audience_remove_members_params.rb +5 -5
  12. data/lib/knockapi/models/bulk_operation.rb +5 -5
  13. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +6 -6
  14. data/lib/knockapi/models/condition.rb +3 -3
  15. data/lib/knockapi/models/identify_user_request.rb +5 -5
  16. data/lib/knockapi/models/inline_identify_user_request.rb +5 -5
  17. data/lib/knockapi/models/inline_object_request.rb +4 -4
  18. data/lib/knockapi/models/inline_tenant_request.rb +1 -1
  19. data/lib/knockapi/models/message.rb +14 -14
  20. data/lib/knockapi/models/message_delivery_log.rb +13 -13
  21. data/lib/knockapi/models/message_event.rb +7 -7
  22. data/lib/knockapi/models/message_list_params.rb +6 -6
  23. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  24. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  25. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  26. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  27. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  28. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  29. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  30. data/lib/knockapi/models/object_add_subscriptions_params.rb +2 -2
  31. data/lib/knockapi/models/object_delete_subscriptions_params.rb +2 -2
  32. data/lib/knockapi/models/object_list_messages_params.rb +6 -6
  33. data/lib/knockapi/models/object_list_params.rb +2 -2
  34. data/lib/knockapi/models/object_list_subscriptions_params.rb +8 -8
  35. data/lib/knockapi/models/object_set_params.rb +4 -4
  36. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +6 -5
  37. data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
  38. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -3
  39. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -3
  40. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -3
  41. data/lib/knockapi/models/recipient.rb +1 -1
  42. data/lib/knockapi/models/recipient_reference.rb +1 -1
  43. data/lib/knockapi/models/recipient_request.rb +1 -1
  44. data/lib/knockapi/models/recipients/channel_data.rb +7 -7
  45. data/lib/knockapi/models/recipients/channel_data_request.rb +4 -4
  46. data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -6
  47. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -1
  48. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -6
  49. data/lib/knockapi/models/recipients/preference_set.rb +17 -17
  50. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
  51. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -24
  52. data/lib/knockapi/models/recipients/preference_set_request.rb +17 -17
  53. data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -6
  54. data/lib/knockapi/models/recipients/subscription.rb +4 -4
  55. data/lib/knockapi/models/schedule.rb +13 -10
  56. data/lib/knockapi/models/schedule_create_params.rb +14 -8
  57. data/lib/knockapi/models/schedule_repeat_rule.rb +5 -5
  58. data/lib/knockapi/models/schedule_update_params.rb +11 -8
  59. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -13
  60. data/lib/knockapi/models/tenant.rb +10 -10
  61. data/lib/knockapi/models/tenant_request.rb +13 -13
  62. data/lib/knockapi/models/tenant_set_params.rb +12 -12
  63. data/lib/knockapi/models/tenants/bulk_set_params.rb +2 -2
  64. data/lib/knockapi/models/user.rb +2 -2
  65. data/lib/knockapi/models/user_list_messages_params.rb +6 -6
  66. data/lib/knockapi/models/user_list_params.rb +2 -2
  67. data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
  68. data/lib/knockapi/models/users/bulk_identify_params.rb +2 -2
  69. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +2 -2
  70. data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
  71. data/lib/knockapi/models/users/feed_list_items_response.rb +4 -4
  72. data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
  73. data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
  74. data/lib/knockapi/resources/audiences.rb +2 -2
  75. data/lib/knockapi/resources/bulk_operations.rb +1 -1
  76. data/lib/knockapi/resources/channels/bulk.rb +5 -5
  77. data/lib/knockapi/resources/messages/batch.rb +14 -14
  78. data/lib/knockapi/resources/messages.rb +18 -18
  79. data/lib/knockapi/resources/objects/bulk.rb +5 -5
  80. data/lib/knockapi/resources/objects.rb +30 -30
  81. data/lib/knockapi/resources/providers/ms_teams.rb +2 -2
  82. data/lib/knockapi/resources/providers/slack.rb +1 -1
  83. data/lib/knockapi/resources/schedules/bulk.rb +2 -2
  84. data/lib/knockapi/resources/schedules.rb +15 -12
  85. data/lib/knockapi/resources/tenants/bulk.rb +3 -3
  86. data/lib/knockapi/resources/tenants.rb +6 -6
  87. data/lib/knockapi/resources/users/bulk.rb +5 -5
  88. data/lib/knockapi/resources/users/feeds.rb +2 -2
  89. data/lib/knockapi/resources/users.rb +24 -24
  90. data/lib/knockapi/resources/workflows.rb +5 -5
  91. data/lib/knockapi/version.rb +1 -1
  92. data/lib/knockapi.rb +3 -1
  93. data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
  94. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +1 -1
  95. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +1 -1
  96. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +1 -1
  97. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +1 -1
  98. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +1 -1
  99. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +1 -1
  100. data/rbi/knockapi/models/schedule.rbi +8 -2
  101. data/rbi/knockapi/models/schedule_create_params.rbi +8 -2
  102. data/rbi/knockapi/models/schedule_update_params.rbi +8 -2
  103. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -2
  104. data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -2
  105. data/rbi/knockapi/resources/messages/batch.rbi +7 -7
  106. data/rbi/knockapi/resources/messages.rbi +3 -5
  107. data/rbi/knockapi/resources/objects.rbi +1 -1
  108. data/rbi/knockapi/resources/schedules.rbi +8 -2
  109. data/rbi/knockapi/resources/users.rbi +1 -1
  110. data/rbi/knockapi/resources/workflows.rbi +4 -1
  111. data/sig/knockapi/internal/entries_cursor.rbs +2 -0
  112. data/sig/knockapi/internal/items_cursor.rbs +2 -0
  113. data/sig/knockapi/models/activity.rbs +10 -0
  114. data/sig/knockapi/models/audience_add_members_params.rbs +12 -0
  115. data/sig/knockapi/models/audience_list_members_params.rbs +2 -0
  116. data/sig/knockapi/models/audience_list_members_response.rbs +5 -0
  117. data/sig/knockapi/models/audience_member.rbs +8 -0
  118. data/sig/knockapi/models/audience_remove_members_params.rbs +12 -0
  119. data/sig/knockapi/models/bulk_operation.rbs +24 -4
  120. data/sig/knockapi/models/bulk_operation_get_params.rbs +2 -0
  121. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +14 -0
  122. data/sig/knockapi/models/condition.rbs +10 -4
  123. data/sig/knockapi/models/identify_user_request.rbs +12 -0
  124. data/sig/knockapi/models/inline_identify_user_request.rbs +13 -0
  125. data/sig/knockapi/models/inline_object_request.rbs +8 -0
  126. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +8 -0
  127. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +2 -0
  128. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +8 -0
  129. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +2 -0
  130. data/sig/knockapi/models/message.rbs +44 -11
  131. data/sig/knockapi/models/message_archive_params.rbs +2 -0
  132. data/sig/knockapi/models/message_delivery_log.rbs +43 -18
  133. data/sig/knockapi/models/message_event.rbs +13 -4
  134. data/sig/knockapi/models/message_get_content_params.rbs +2 -0
  135. data/sig/knockapi/models/message_get_content_response.rbs +68 -0
  136. data/sig/knockapi/models/message_get_params.rbs +2 -0
  137. data/sig/knockapi/models/message_list_activities_params.rbs +8 -0
  138. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +7 -0
  139. data/sig/knockapi/models/message_list_events_params.rbs +7 -0
  140. data/sig/knockapi/models/message_list_params.rbs +32 -12
  141. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -0
  142. data/sig/knockapi/models/message_mark_as_read_params.rbs +2 -0
  143. data/sig/knockapi/models/message_mark_as_seen_params.rbs +2 -0
  144. data/sig/knockapi/models/message_mark_as_unread_params.rbs +2 -0
  145. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +2 -0
  146. data/sig/knockapi/models/message_unarchive_params.rbs +2 -0
  147. data/sig/knockapi/models/messages/batch_archive_params.rbs +5 -0
  148. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  149. data/sig/knockapi/models/messages/batch_get_content_params.rbs +5 -0
  150. data/sig/knockapi/models/messages/batch_get_content_response.rbs +72 -0
  151. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +6 -0
  152. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +2 -1
  153. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +5 -0
  154. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  155. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +5 -0
  156. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  157. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +5 -0
  158. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  159. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +5 -0
  160. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  161. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +5 -0
  162. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  163. data/sig/knockapi/models/object.rbs +9 -0
  164. data/sig/knockapi/models/object_add_subscriptions_params.rbs +6 -0
  165. data/sig/knockapi/models/object_delete_params.rbs +2 -0
  166. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +5 -0
  167. data/sig/knockapi/models/object_get_channel_data_params.rbs +2 -0
  168. data/sig/knockapi/models/object_get_params.rbs +2 -0
  169. data/sig/knockapi/models/object_get_preferences_params.rbs +2 -0
  170. data/sig/knockapi/models/object_list_messages_params.rbs +32 -12
  171. data/sig/knockapi/models/object_list_params.rbs +14 -6
  172. data/sig/knockapi/models/object_list_preferences_params.rbs +2 -0
  173. data/sig/knockapi/models/object_list_schedules_params.rbs +9 -0
  174. data/sig/knockapi/models/object_list_subscriptions_params.rbs +19 -6
  175. data/sig/knockapi/models/object_set_channel_data_params.rbs +2 -0
  176. data/sig/knockapi/models/object_set_params.rbs +8 -0
  177. data/sig/knockapi/models/object_set_preferences_params.rbs +2 -0
  178. data/sig/knockapi/models/object_unset_channel_data_params.rbs +2 -0
  179. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +10 -0
  180. data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -0
  181. data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
  182. data/sig/knockapi/models/page_info.rbs +7 -0
  183. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -0
  184. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +6 -0
  185. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +9 -0
  186. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +13 -0
  187. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +13 -0
  188. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +6 -0
  189. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -0
  190. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +2 -0
  191. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -0
  192. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +6 -0
  193. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +14 -0
  194. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +8 -0
  195. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -0
  196. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +2 -0
  197. data/sig/knockapi/models/recipient_reference.rbs +2 -0
  198. data/sig/knockapi/models/recipients/channel_data.rbs +17 -10
  199. data/sig/knockapi/models/recipients/channel_data_request.rbs +8 -4
  200. data/sig/knockapi/models/recipients/discord_channel_data.rbs +16 -4
  201. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +2 -2
  202. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +22 -4
  203. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +2 -0
  204. data/sig/knockapi/models/recipients/preference_set.rbs +25 -8
  205. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +2 -0
  206. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +45 -36
  207. data/sig/knockapi/models/recipients/preference_set_request.rbs +24 -8
  208. data/sig/knockapi/models/recipients/push_channel_data.rbs +2 -0
  209. data/sig/knockapi/models/recipients/slack_channel_data.rbs +19 -4
  210. data/sig/knockapi/models/recipients/subscription.rbs +9 -0
  211. data/sig/knockapi/models/schedule.rbs +15 -0
  212. data/sig/knockapi/models/schedule_create_params.rbs +11 -0
  213. data/sig/knockapi/models/schedule_delete_params.rbs +5 -0
  214. data/sig/knockapi/models/schedule_list_params.rbs +10 -0
  215. data/sig/knockapi/models/schedule_repeat_rule.rbs +18 -8
  216. data/sig/knockapi/models/schedule_update_params.rbs +11 -0
  217. data/sig/knockapi/models/schedules/bulk_create_params.rbs +16 -0
  218. data/sig/knockapi/models/tenant.rbs +19 -0
  219. data/sig/knockapi/models/tenant_delete_params.rbs +2 -0
  220. data/sig/knockapi/models/tenant_get_params.rbs +2 -0
  221. data/sig/knockapi/models/tenant_list_params.rbs +9 -0
  222. data/sig/knockapi/models/tenant_request.rbs +19 -0
  223. data/sig/knockapi/models/tenant_set_params.rbs +19 -0
  224. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +5 -0
  225. data/sig/knockapi/models/tenants/bulk_set_params.rbs +5 -0
  226. data/sig/knockapi/models/user.rbs +12 -0
  227. data/sig/knockapi/models/user_delete_params.rbs +2 -0
  228. data/sig/knockapi/models/user_get_channel_data_params.rbs +2 -0
  229. data/sig/knockapi/models/user_get_params.rbs +2 -0
  230. data/sig/knockapi/models/user_get_preferences_params.rbs +5 -0
  231. data/sig/knockapi/models/user_list_messages_params.rbs +32 -12
  232. data/sig/knockapi/models/user_list_params.rbs +14 -6
  233. data/sig/knockapi/models/user_list_preferences_params.rbs +2 -0
  234. data/sig/knockapi/models/user_list_schedules_params.rbs +9 -0
  235. data/sig/knockapi/models/user_list_subscriptions_params.rbs +15 -6
  236. data/sig/knockapi/models/user_merge_params.rbs +5 -0
  237. data/sig/knockapi/models/user_set_channel_data_params.rbs +2 -0
  238. data/sig/knockapi/models/user_set_preferences_params.rbs +2 -0
  239. data/sig/knockapi/models/user_unset_channel_data_params.rbs +2 -0
  240. data/sig/knockapi/models/user_update_params.rbs +2 -0
  241. data/sig/knockapi/models/users/bulk_delete_params.rbs +5 -0
  242. data/sig/knockapi/models/users/bulk_identify_params.rbs +5 -0
  243. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +6 -0
  244. data/sig/knockapi/models/users/feed_get_settings_params.rbs +2 -0
  245. data/sig/knockapi/models/users/feed_get_settings_response.rbs +6 -0
  246. data/sig/knockapi/models/users/feed_list_items_params.rbs +14 -0
  247. data/sig/knockapi/models/users/feed_list_items_response.rbs +43 -0
  248. data/sig/knockapi/models/users/guide_get_channel_params.rbs +7 -0
  249. data/sig/knockapi/models/users/guide_get_channel_response.rbs +14 -0
  250. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +13 -0
  251. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +2 -0
  252. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +13 -0
  253. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +2 -0
  254. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +13 -0
  255. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +2 -0
  256. data/sig/knockapi/models/workflow_cancel_params.rbs +6 -0
  257. data/sig/knockapi/models/workflow_trigger_params.rbs +9 -0
  258. data/sig/knockapi/models/workflow_trigger_response.rbs +2 -0
  259. data/sig/knockapi/resources/messages.rbs +5 -5
  260. data/sig/knockapi/resources/objects.rbs +7 -7
  261. data/sig/knockapi/resources/users.rbs +7 -7
  262. metadata +2 -2
@@ -10,7 +10,7 @@ module Knockapi
10
10
  # @!attribute channel_data
11
11
  # A request to set channel data for a type of channel inline.
12
12
  #
13
- # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
13
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
14
14
  optional :channel_data,
15
15
  -> {
16
16
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -20,7 +20,7 @@ module Knockapi
20
20
  # @!attribute preferences
21
21
  # Inline set preferences for a recipient, where the key is the preference set id.
22
22
  #
23
- # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
23
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
24
24
  optional :preferences,
25
25
  -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
26
26
  nil?: true
@@ -28,15 +28,15 @@ module Knockapi
28
28
  # @!attribute settings
29
29
  # The settings for the tenant. Includes branding and preference set.
30
30
  #
31
- # @return [Knockapi::TenantSetParams::Settings, nil]
31
+ # @return [Knockapi::Models::TenantSetParams::Settings, nil]
32
32
  optional :settings, -> { Knockapi::TenantSetParams::Settings }
33
33
 
34
34
  # @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
35
- # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
35
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
36
36
  #
37
- # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
37
+ # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
38
38
  #
39
- # @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
39
+ # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
40
40
  #
41
41
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
42
42
 
@@ -44,23 +44,23 @@ module Knockapi
44
44
  # @!attribute branding
45
45
  # The branding for the tenant.
46
46
  #
47
- # @return [Knockapi::TenantSetParams::Settings::Branding, nil]
47
+ # @return [Knockapi::Models::TenantSetParams::Settings::Branding, nil]
48
48
  optional :branding, -> { Knockapi::TenantSetParams::Settings::Branding }
49
49
 
50
50
  # @!attribute preference_set
51
51
  # A request to set a preference set for a recipient.
52
52
  #
53
- # @return [Knockapi::Recipients::PreferenceSetRequest, nil]
53
+ # @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
54
54
  optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
55
55
 
56
56
  # @!method initialize(branding: nil, preference_set: nil)
57
57
  # The settings for the tenant. Includes branding and preference set.
58
58
  #
59
- # @param branding [Knockapi::TenantSetParams::Settings::Branding] The branding for the tenant.
59
+ # @param branding [Knockapi::Models::TenantSetParams::Settings::Branding] The branding for the tenant.
60
60
  #
61
- # @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
61
+ # @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
62
62
 
63
- # @see Knockapi::TenantSetParams::Settings#branding
63
+ # @see Knockapi::Models::TenantSetParams::Settings#branding
64
64
  class Branding < Knockapi::Internal::Type::BaseModel
65
65
  # @!attribute icon_url
66
66
  # The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -90,7 +90,7 @@ module Knockapi
90
90
 
91
91
  # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
92
92
  # Some parameter documentations has been truncated, see
93
- # {Knockapi::TenantSetParams::Settings::Branding} for more details.
93
+ # {Knockapi::Models::TenantSetParams::Settings::Branding} for more details.
94
94
  #
95
95
  # The branding for the tenant.
96
96
  #
@@ -11,11 +11,11 @@ module Knockapi
11
11
  # @!attribute tenants
12
12
  # The tenants to be upserted.
13
13
  #
14
- # @return [Array<String, Knockapi::TenantRequest>]
14
+ # @return [Array<String, Knockapi::Models::TenantRequest>]
15
15
  required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::InlineTenantRequest] }
16
16
 
17
17
  # @!method initialize(tenants:, request_options: {})
18
- # @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
18
+ # @param tenants [Array<String, Knockapi::Models::TenantRequest>] The tenants to be upserted.
19
19
  #
20
20
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
21
21
  end
@@ -63,8 +63,8 @@ module Knockapi
63
63
  optional :timezone, String, nil?: true
64
64
 
65
65
  # @!method initialize(id:, _typename:, updated_at:, avatar: nil, created_at: nil, email: nil, name: nil, phone_number: nil, timezone: nil)
66
- # Some parameter documentations has been truncated, see {Knockapi::User} for more
67
- # details.
66
+ # Some parameter documentations has been truncated, see {Knockapi::Models::User}
67
+ # for more details.
68
68
  #
69
69
  # A [User](/concepts/users) represents an individual in your system who can
70
70
  # receive notifications through Knock. Users are the most common recipients of
@@ -28,7 +28,7 @@ module Knockapi
28
28
  # @!attribute engagement_status
29
29
  # Limits the results to messages with the given engagement status.
30
30
  #
31
- # @return [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>, nil]
31
+ # @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>, nil]
32
32
  optional :engagement_status,
33
33
  -> {
34
34
  Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::EngagementStatus]
@@ -36,7 +36,7 @@ module Knockapi
36
36
 
37
37
  # @!attribute inserted_at
38
38
  #
39
- # @return [Knockapi::UserListMessagesParams::InsertedAt, nil]
39
+ # @return [Knockapi::Models::UserListMessagesParams::InsertedAt, nil]
40
40
  optional :inserted_at, -> { Knockapi::UserListMessagesParams::InsertedAt }
41
41
 
42
42
  # @!attribute message_ids
@@ -61,7 +61,7 @@ module Knockapi
61
61
  # @!attribute status
62
62
  # Limits the results to messages with the given delivery status.
63
63
  #
64
- # @return [Array<Symbol, Knockapi::UserListMessagesParams::Status>, nil]
64
+ # @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>, nil]
65
65
  optional :status,
66
66
  -> {
67
67
  Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::Status]
@@ -110,9 +110,9 @@ module Knockapi
110
110
  #
111
111
  # @param channel_id [String] Limits the results to items with the corresponding channel ID.
112
112
  #
113
- # @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
113
+ # @param engagement_status [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
114
114
  #
115
- # @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
115
+ # @param inserted_at [Knockapi::Models::UserListMessagesParams::InsertedAt]
116
116
  #
117
117
  # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
118
118
  #
@@ -120,7 +120,7 @@ module Knockapi
120
120
  #
121
121
  # @param source [String] Limits the results to messages triggered by the given workflow key.
122
122
  #
123
- # @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
123
+ # @param status [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
124
124
  #
125
125
  # @param tenant [String] Limits the results to items with the corresponding tenant.
126
126
  #
@@ -22,7 +22,7 @@ module Knockapi
22
22
  # @!attribute include
23
23
  # Associated resources to include in the response.
24
24
  #
25
- # @return [Array<Symbol, Knockapi::UserListParams::Include>, nil]
25
+ # @return [Array<Symbol, Knockapi::Models::UserListParams::Include>, nil]
26
26
  optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListParams::Include] }
27
27
 
28
28
  # @!attribute page_size
@@ -36,7 +36,7 @@ module Knockapi
36
36
  #
37
37
  # @param before [String] The cursor to fetch entries before.
38
38
  #
39
- # @param include [Array<Symbol, Knockapi::UserListParams::Include>] Associated resources to include in the response.
39
+ # @param include [Array<Symbol, Knockapi::Models::UserListParams::Include>] Associated resources to include in the response.
40
40
  #
41
41
  # @param page_size [Integer] The number of items per page.
42
42
  #
@@ -22,7 +22,7 @@ module Knockapi
22
22
  # @!attribute include
23
23
  # Associated resources to include in the response.
24
24
  #
25
- # @return [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>, nil]
25
+ # @return [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>, nil]
26
26
  optional :include,
27
27
  -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListSubscriptionsParams::Include] }
28
28
 
@@ -43,7 +43,7 @@ module Knockapi
43
43
  #
44
44
  # @param before [String] The cursor to fetch entries before.
45
45
  #
46
- # @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
46
+ # @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
47
47
  #
48
48
  # @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
49
49
  #
@@ -11,11 +11,11 @@ module Knockapi
11
11
  # @!attribute users
12
12
  # A list of users.
13
13
  #
14
- # @return [Array<Knockapi::InlineIdentifyUserRequest>]
14
+ # @return [Array<Knockapi::Models::InlineIdentifyUserRequest>]
15
15
  required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineIdentifyUserRequest] }
16
16
 
17
17
  # @!method initialize(users:, request_options: {})
18
- # @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
18
+ # @param users [Array<Knockapi::Models::InlineIdentifyUserRequest>] A list of users.
19
19
  #
20
20
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
21
21
  end
@@ -11,7 +11,7 @@ module Knockapi
11
11
  # @!attribute preferences
12
12
  # A request to set a preference set for a recipient.
13
13
  #
14
- # @return [Knockapi::Recipients::PreferenceSetRequest]
14
+ # @return [Knockapi::Models::Recipients::PreferenceSetRequest]
15
15
  required :preferences, -> { Knockapi::Recipients::PreferenceSetRequest }
16
16
 
17
17
  # @!attribute user_ids
@@ -21,7 +21,7 @@ module Knockapi
21
21
  required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
22
22
 
23
23
  # @!method initialize(preferences:, user_ids:, request_options: {})
24
- # @param preferences [Knockapi::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
24
+ # @param preferences [Knockapi::Models::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
25
25
  #
26
26
  # @param user_ids [Array<String>] A list of user IDs.
27
27
  #
@@ -17,7 +17,7 @@ module Knockapi
17
17
  # @!attribute archived
18
18
  # The archived status of the feed items.
19
19
  #
20
- # @return [Symbol, Knockapi::Users::FeedListItemsParams::Archived, nil]
20
+ # @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived, nil]
21
21
  optional :archived, enum: -> { Knockapi::Users::FeedListItemsParams::Archived }
22
22
 
23
23
  # @!attribute before
@@ -47,7 +47,7 @@ module Knockapi
47
47
  # @!attribute status
48
48
  # The status of the feed items.
49
49
  #
50
- # @return [Symbol, Knockapi::Users::FeedListItemsParams::Status, nil]
50
+ # @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status, nil]
51
51
  optional :status, enum: -> { Knockapi::Users::FeedListItemsParams::Status }
52
52
 
53
53
  # @!attribute tenant
@@ -71,7 +71,7 @@ module Knockapi
71
71
  # @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
72
72
  # @param after [String] The cursor to fetch entries after.
73
73
  #
74
- # @param archived [Symbol, Knockapi::Users::FeedListItemsParams::Archived] The archived status of the feed items.
74
+ # @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
75
75
  #
76
76
  # @param before [String] The cursor to fetch entries before.
77
77
  #
@@ -81,7 +81,7 @@ module Knockapi
81
81
  #
82
82
  # @param source [String] The source of the feed items.
83
83
  #
84
- # @param status [Symbol, Knockapi::Users::FeedListItemsParams::Status] The status of the feed items.
84
+ # @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
85
85
  #
86
86
  # @param tenant [String] The tenant associated with the feed items.
87
87
  #
@@ -20,13 +20,13 @@ module Knockapi
20
20
  # @!attribute activities
21
21
  # List of activities associated with this feed item.
22
22
  #
23
- # @return [Array<Knockapi::Activity>]
23
+ # @return [Array<Knockapi::Models::Activity>]
24
24
  required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Activity] }
25
25
 
26
26
  # @!attribute actors
27
27
  # List of actors associated with this feed item.
28
28
  #
29
- # @return [Array<Knockapi::User, Knockapi::Object>]
29
+ # @return [Array<Knockapi::Models::User, Knockapi::Models::Object>]
30
30
  required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipient] }
31
31
 
32
32
  # @!attribute blocks
@@ -121,9 +121,9 @@ module Knockapi
121
121
  #
122
122
  # @param _typename [String] The typename of the schema.
123
123
  #
124
- # @param activities [Array<Knockapi::Activity>] List of activities associated with this feed item.
124
+ # @param activities [Array<Knockapi::Models::Activity>] List of activities associated with this feed item.
125
125
  #
126
- # @param actors [Array<Knockapi::User, Knockapi::Object>] List of actors associated with this feed item.
126
+ # @param actors [Array<Knockapi::Models::User, Knockapi::Models::Object>] List of actors associated with this feed item.
127
127
  #
128
128
  # @param blocks [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>] Content blocks that make up the feed item.
129
129
  #
@@ -21,7 +21,7 @@ module Knockapi
21
21
  # A list of recipients to cancel the notification for. If omitted, cancels for all
22
22
  # recipients associated with the cancellation key.
23
23
  #
24
- # @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
24
+ # @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
25
25
  optional :recipients,
26
26
  -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
27
27
  nil?: true
@@ -32,7 +32,7 @@ module Knockapi
32
32
  #
33
33
  # @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
34
34
  #
35
- # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
35
+ # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
36
36
  #
37
37
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
38
38
  end
@@ -11,7 +11,7 @@ module Knockapi
11
11
  # The recipients to trigger the workflow for. Can inline identify users, objects,
12
12
  # or use a list of user IDs. Limited to 1,000 recipients.
13
13
  #
14
- # @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
14
+ # @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
15
15
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
16
16
 
17
17
  # @!attribute actor
@@ -19,7 +19,7 @@ module Knockapi
19
19
  # (string), an inline user request (object), or an inline object request, which is
20
20
  # determined by the presence of a `collection` property.
21
21
  #
22
- # @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
22
+ # @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
23
23
  optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
24
24
 
25
25
  # @!attribute cancellation_key
@@ -33,7 +33,10 @@ module Knockapi
33
33
  optional :cancellation_key, String, nil?: true
34
34
 
35
35
  # @!attribute data
36
- # An optional map of data to pass into the workflow execution.
36
+ # An optional map of data to pass into the workflow execution. There is a 1024
37
+ # byte limit on the size of any single string value (with the exception of
38
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
39
+ # size of the full `data` payload.
37
40
  #
38
41
  # @return [Hash{Symbol=>Object}, nil]
39
42
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -41,22 +44,22 @@ module Knockapi
41
44
  # @!attribute tenant
42
45
  # An request to set a tenant inline.
43
46
  #
44
- # @return [String, Knockapi::TenantRequest, nil]
47
+ # @return [String, Knockapi::Models::TenantRequest, nil]
45
48
  optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
46
49
 
47
50
  # @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
48
51
  # Some parameter documentations has been truncated, see
49
52
  # {Knockapi::Models::WorkflowTriggerParams} for more details.
50
53
  #
51
- # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
54
+ # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
52
55
  #
53
- # @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
56
+ # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
54
57
  #
55
58
  # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
56
59
  #
57
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
60
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
58
61
  #
59
- # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
62
+ # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
60
63
  #
61
64
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
62
65
  end
@@ -9,7 +9,7 @@ module Knockapi
9
9
  #
10
10
  # @param key [String] The key of the audience.
11
11
  #
12
- # @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
12
+ # @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
13
13
  #
14
14
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
15
15
  #
@@ -53,7 +53,7 @@ module Knockapi
53
53
  #
54
54
  # @param key [String] The key of the audience.
55
55
  #
56
- # @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
56
+ # @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
57
57
  #
58
58
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
59
59
  #
@@ -11,7 +11,7 @@ module Knockapi
11
11
  #
12
12
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
13
13
  #
14
- # @return [Knockapi::BulkOperation]
14
+ # @return [Knockapi::Models::BulkOperation]
15
15
  #
16
16
  # @see Knockapi::Models::BulkOperationGetParams
17
17
  def get(id, params = {})
@@ -16,13 +16,13 @@ module Knockapi
16
16
  #
17
17
  # @param channel_id [String] The ID of the channel to update messages for.
18
18
  #
19
- # @param action [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
19
+ # @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
20
20
  #
21
- # @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
21
+ # @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
22
22
  #
23
- # @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
23
+ # @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
24
24
  #
25
- # @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
25
+ # @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
26
26
  #
27
27
  # @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
28
28
  #
@@ -40,7 +40,7 @@ module Knockapi
40
40
  #
41
41
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
42
42
  #
43
- # @return [Knockapi::BulkOperation]
43
+ # @return [Knockapi::Models::BulkOperation]
44
44
  #
45
45
  # @see Knockapi::Models::Channels::BulkUpdateMessageStatusParams
46
46
  def update_message_status(channel_id, action, params = {})
@@ -13,7 +13,7 @@ module Knockapi
13
13
  #
14
14
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
15
15
  #
16
- # @return [Array<Knockapi::Message>]
16
+ # @return [Array<Knockapi::Models::Message>]
17
17
  #
18
18
  # @see Knockapi::Models::Messages::BatchArchiveParams
19
19
  def archive(params)
@@ -22,7 +22,7 @@ module Knockapi
22
22
  method: :post,
23
23
  path: "v1/messages/batch/archived",
24
24
  body: parsed,
25
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
25
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
26
26
  options: options
27
27
  )
28
28
  end
@@ -63,7 +63,7 @@ module Knockapi
63
63
  #
64
64
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
65
65
  #
66
- # @return [Array<Knockapi::Message>]
66
+ # @return [Array<Knockapi::Models::Message>]
67
67
  #
68
68
  # @see Knockapi::Models::Messages::BatchMarkAsInteractedParams
69
69
  def mark_as_interacted(params)
@@ -72,7 +72,7 @@ module Knockapi
72
72
  method: :post,
73
73
  path: "v1/messages/batch/interacted",
74
74
  body: parsed,
75
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
75
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
76
76
  options: options
77
77
  )
78
78
  end
@@ -86,7 +86,7 @@ module Knockapi
86
86
  #
87
87
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
88
88
  #
89
- # @return [Array<Knockapi::Message>]
89
+ # @return [Array<Knockapi::Models::Message>]
90
90
  #
91
91
  # @see Knockapi::Models::Messages::BatchMarkAsReadParams
92
92
  def mark_as_read(params)
@@ -95,7 +95,7 @@ module Knockapi
95
95
  method: :post,
96
96
  path: "v1/messages/batch/read",
97
97
  body: parsed,
98
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
98
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
99
99
  options: options
100
100
  )
101
101
  end
@@ -110,7 +110,7 @@ module Knockapi
110
110
  #
111
111
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
112
112
  #
113
- # @return [Array<Knockapi::Message>]
113
+ # @return [Array<Knockapi::Models::Message>]
114
114
  #
115
115
  # @see Knockapi::Models::Messages::BatchMarkAsSeenParams
116
116
  def mark_as_seen(params)
@@ -119,7 +119,7 @@ module Knockapi
119
119
  method: :post,
120
120
  path: "v1/messages/batch/seen",
121
121
  body: parsed,
122
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
122
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
123
123
  options: options
124
124
  )
125
125
  end
@@ -134,7 +134,7 @@ module Knockapi
134
134
  #
135
135
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
136
136
  #
137
- # @return [Array<Knockapi::Message>]
137
+ # @return [Array<Knockapi::Models::Message>]
138
138
  #
139
139
  # @see Knockapi::Models::Messages::BatchMarkAsUnreadParams
140
140
  def mark_as_unread(params)
@@ -143,7 +143,7 @@ module Knockapi
143
143
  method: :post,
144
144
  path: "v1/messages/batch/unread",
145
145
  body: parsed,
146
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
146
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
147
147
  options: options
148
148
  )
149
149
  end
@@ -158,7 +158,7 @@ module Knockapi
158
158
  #
159
159
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
160
160
  #
161
- # @return [Array<Knockapi::Message>]
161
+ # @return [Array<Knockapi::Models::Message>]
162
162
  #
163
163
  # @see Knockapi::Models::Messages::BatchMarkAsUnseenParams
164
164
  def mark_as_unseen(params)
@@ -167,7 +167,7 @@ module Knockapi
167
167
  method: :post,
168
168
  path: "v1/messages/batch/unseen",
169
169
  body: parsed,
170
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
170
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
171
171
  options: options
172
172
  )
173
173
  end
@@ -182,7 +182,7 @@ module Knockapi
182
182
  #
183
183
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
184
184
  #
185
- # @return [Array<Knockapi::Message>]
185
+ # @return [Array<Knockapi::Models::Message>]
186
186
  #
187
187
  # @see Knockapi::Models::Messages::BatchUnarchiveParams
188
188
  def unarchive(params)
@@ -191,7 +191,7 @@ module Knockapi
191
191
  method: :post,
192
192
  path: "v1/messages/batch/unarchived",
193
193
  body: parsed,
194
- model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
194
+ model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
195
195
  options: options
196
196
  )
197
197
  end