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
@@ -8,7 +8,7 @@ module Knockapi
8
8
  # An object where the key is the category and the values are the preference
9
9
  # settings for that category.
10
10
  #
11
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
11
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
12
12
  optional :categories,
13
13
  -> {
14
14
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Category]
@@ -18,14 +18,14 @@ module Knockapi
18
18
  # @!attribute channel_types
19
19
  # Channel type preferences.
20
20
  #
21
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
21
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
22
22
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
23
23
 
24
24
  # @!attribute workflows
25
25
  # An object where the key is the workflow key and the values are the preference
26
26
  # settings for that workflow.
27
27
  #
28
- # @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
28
+ # @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
29
29
  optional :workflows,
30
30
  -> {
31
31
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Workflow]
@@ -34,15 +34,15 @@ module Knockapi
34
34
 
35
35
  # @!method initialize(categories: nil, channel_types: nil, workflows: nil)
36
36
  # Some parameter documentations has been truncated, see
37
- # {Knockapi::Recipients::PreferenceSetRequest} for more details.
37
+ # {Knockapi::Models::Recipients::PreferenceSetRequest} for more details.
38
38
  #
39
39
  # A request to set a preference set for a recipient.
40
40
  #
41
- # @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
41
+ # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
42
42
  #
43
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
43
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
44
44
  #
45
- # @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
45
+ # @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
46
46
 
47
47
  # Workflow or category preferences within a preference set
48
48
  module Category
@@ -59,26 +59,26 @@ module Knockapi
59
59
  # @!attribute channel_types
60
60
  # Channel type preferences.
61
61
  #
62
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
62
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
63
63
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
64
64
 
65
65
  # @!attribute conditions
66
66
  # A list of conditions to apply to a channel type.
67
67
  #
68
- # @return [Array<Knockapi::Condition>, nil]
68
+ # @return [Array<Knockapi::Models::Condition>, nil]
69
69
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
70
70
 
71
71
  # @!method initialize(channel_types: nil, conditions: nil)
72
72
  # The settings object for a workflow or category, where you can specify channel
73
73
  # types or conditions.
74
74
  #
75
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
75
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
76
76
  #
77
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
77
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
78
78
  end
79
79
 
80
80
  # @!method self.variants
81
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
81
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
82
82
  end
83
83
 
84
84
  # Workflow or category preferences within a preference set
@@ -96,26 +96,26 @@ module Knockapi
96
96
  # @!attribute channel_types
97
97
  # Channel type preferences.
98
98
  #
99
- # @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
99
+ # @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
100
100
  optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
101
101
 
102
102
  # @!attribute conditions
103
103
  # A list of conditions to apply to a channel type.
104
104
  #
105
- # @return [Array<Knockapi::Condition>, nil]
105
+ # @return [Array<Knockapi::Models::Condition>, nil]
106
106
  optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
107
107
 
108
108
  # @!method initialize(channel_types: nil, conditions: nil)
109
109
  # The settings object for a workflow or category, where you can specify channel
110
110
  # types or conditions.
111
111
  #
112
- # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
112
+ # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
113
113
  #
114
- # @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
114
+ # @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
115
115
  end
116
116
 
117
117
  # @!method self.variants
118
- # @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
118
+ # @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
119
119
  end
120
120
  end
121
121
  end
@@ -7,7 +7,7 @@ module Knockapi
7
7
  # @!attribute connections
8
8
  # List of Slack channel connections.
9
9
  #
10
- # @return [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
10
+ # @return [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
11
11
  required :connections,
12
12
  -> {
13
13
  Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::SlackChannelData::Connection]
@@ -16,15 +16,15 @@ module Knockapi
16
16
  # @!attribute token
17
17
  # A Slack connection token.
18
18
  #
19
- # @return [Knockapi::Recipients::SlackChannelData::Token, nil]
19
+ # @return [Knockapi::Models::Recipients::SlackChannelData::Token, nil]
20
20
  optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
21
21
 
22
22
  # @!method initialize(connections:, token: nil)
23
23
  # Slack channel data
24
24
  #
25
- # @param connections [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
25
+ # @param connections [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
26
26
  #
27
- # @param token [Knockapi::Recipients::SlackChannelData::Token, nil] A Slack connection token.
27
+ # @param token [Knockapi::Models::Recipients::SlackChannelData::Token, nil] A Slack connection token.
28
28
 
29
29
  # A Slack connection, either an access token or an incoming webhook
30
30
  module Connection
@@ -79,10 +79,10 @@ module Knockapi
79
79
  end
80
80
 
81
81
  # @!method self.variants
82
- # @return [Array(Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
82
+ # @return [Array(Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
83
83
  end
84
84
 
85
- # @see Knockapi::Recipients::SlackChannelData#token
85
+ # @see Knockapi::Models::Recipients::SlackChannelData#token
86
86
  class Token < Knockapi::Internal::Type::BaseModel
87
87
  # @!attribute access_token
88
88
  # A Slack access token.
@@ -19,13 +19,13 @@ module Knockapi
19
19
  # @!attribute object
20
20
  # A custom [Object](/concepts/objects) entity which belongs to a collection.
21
21
  #
22
- # @return [Knockapi::Object]
22
+ # @return [Knockapi::Models::Object]
23
23
  required :object, -> { Knockapi::Object }
24
24
 
25
25
  # @!attribute recipient
26
26
  # A recipient of a notification, which is either a user or an object.
27
27
  #
28
- # @return [Knockapi::User, Knockapi::Object]
28
+ # @return [Knockapi::Models::User, Knockapi::Models::Object]
29
29
  required :recipient, union: -> { Knockapi::Recipient }
30
30
 
31
31
  # @!attribute updated_at
@@ -47,9 +47,9 @@ module Knockapi
47
47
  #
48
48
  # @param inserted_at [Time] Timestamp when the resource was created.
49
49
  #
50
- # @param object [Knockapi::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
50
+ # @param object [Knockapi::Models::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
51
51
  #
52
- # @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
52
+ # @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
53
53
  #
54
54
  # @param updated_at [Time] The timestamp when the resource was last updated.
55
55
  #
@@ -19,13 +19,13 @@ module Knockapi
19
19
  # @!attribute recipient
20
20
  # A recipient of a notification, which is either a user or an object.
21
21
  #
22
- # @return [Knockapi::User, Knockapi::Object]
22
+ # @return [Knockapi::Models::User, Knockapi::Models::Object]
23
23
  required :recipient, union: -> { Knockapi::Recipient }
24
24
 
25
25
  # @!attribute repeats
26
26
  # The repeat rule for the schedule.
27
27
  #
28
- # @return [Array<Knockapi::ScheduleRepeatRule>]
28
+ # @return [Array<Knockapi::Models::ScheduleRepeatRule>]
29
29
  required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
30
30
 
31
31
  # @!attribute updated_at
@@ -49,11 +49,14 @@ module Knockapi
49
49
  # @!attribute actor
50
50
  # A recipient of a notification, which is either a user or an object.
51
51
  #
52
- # @return [Knockapi::User, Knockapi::Object, nil]
52
+ # @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
53
53
  optional :actor, union: -> { Knockapi::Recipient }, nil?: true
54
54
 
55
55
  # @!attribute data
56
- # An optional map of data to pass into the workflow execution.
56
+ # An optional map of data to pass into the workflow execution. There is a 1024
57
+ # byte limit on the size of any single string value (with the exception of
58
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
59
+ # size of the full `data` payload.
57
60
  #
58
61
  # @return [Hash{Symbol=>Object}, nil]
59
62
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -79,8 +82,8 @@ module Knockapi
79
82
  optional :tenant, String, nil?: true
80
83
 
81
84
  # @!method initialize(id:, inserted_at:, recipient:, repeats:, updated_at:, workflow:, _typename: nil, actor: nil, data: nil, last_occurrence_at: nil, next_occurrence_at: nil, tenant: nil)
82
- # Some parameter documentations has been truncated, see {Knockapi::Schedule} for
83
- # more details.
85
+ # Some parameter documentations has been truncated, see
86
+ # {Knockapi::Models::Schedule} for more details.
84
87
  #
85
88
  # A schedule represents a recurring workflow execution.
86
89
  #
@@ -88,9 +91,9 @@ module Knockapi
88
91
  #
89
92
  # @param inserted_at [Time] Timestamp when the resource was created.
90
93
  #
91
- # @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
94
+ # @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
92
95
  #
93
- # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
96
+ # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
94
97
  #
95
98
  # @param updated_at [Time] The timestamp when the resource was last updated.
96
99
  #
@@ -98,9 +101,9 @@ module Knockapi
98
101
  #
99
102
  # @param _typename [String] The typename of the schema.
100
103
  #
101
- # @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
104
+ # @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
102
105
  #
103
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
106
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
104
107
  #
105
108
  # @param last_occurrence_at [Time, nil] The last occurrence of the schedule.
106
109
  #
@@ -10,13 +10,13 @@ module Knockapi
10
10
  # @!attribute recipients
11
11
  # The recipients to set the schedule for. Limited to 100 recipients per request.
12
12
  #
13
- # @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
13
+ # @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
14
14
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
15
15
 
16
16
  # @!attribute repeats
17
17
  # The repeat rule for the schedule.
18
18
  #
19
- # @return [Array<Knockapi::ScheduleRepeatRule>]
19
+ # @return [Array<Knockapi::Models::ScheduleRepeatRule>]
20
20
  required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
21
21
 
22
22
  # @!attribute workflow
@@ -26,7 +26,10 @@ module Knockapi
26
26
  required :workflow, String
27
27
 
28
28
  # @!attribute data
29
- # An optional map of data to pass into the workflow execution.
29
+ # An optional map of data to pass into the workflow execution. There is a 1024
30
+ # byte limit on the size of any single string value (with the exception of
31
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
32
+ # size of the full `data` payload.
30
33
  #
31
34
  # @return [Hash{Symbol=>Object}, nil]
32
35
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -46,23 +49,26 @@ module Knockapi
46
49
  # @!attribute tenant
47
50
  # An request to set a tenant inline.
48
51
  #
49
- # @return [String, Knockapi::TenantRequest, nil]
52
+ # @return [String, Knockapi::Models::TenantRequest, nil]
50
53
  optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
51
54
 
52
55
  # @!method initialize(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
53
- # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
56
+ # Some parameter documentations has been truncated, see
57
+ # {Knockapi::Models::ScheduleCreateParams} for more details.
54
58
  #
55
- # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
59
+ # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
60
+ #
61
+ # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
56
62
  #
57
63
  # @param workflow [String] The key of the workflow.
58
64
  #
59
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
65
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
60
66
  #
61
67
  # @param ending_at [Time, nil] The ending date and time for the schedule.
62
68
  #
63
69
  # @param scheduled_at [Time, nil] The starting date and time for the schedule.
64
70
  #
65
- # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
71
+ # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
66
72
  #
67
73
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
68
74
  end
@@ -12,7 +12,7 @@ module Knockapi
12
12
  # @!attribute frequency
13
13
  # The frequency of the schedule.
14
14
  #
15
- # @return [Symbol, Knockapi::ScheduleRepeatRule::Frequency]
15
+ # @return [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency]
16
16
  required :frequency, enum: -> { Knockapi::ScheduleRepeatRule::Frequency }
17
17
 
18
18
  # @!attribute day_of_month
@@ -24,7 +24,7 @@ module Knockapi
24
24
  # @!attribute days
25
25
  # The days of the week to repeat the schedule.
26
26
  #
27
- # @return [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil]
27
+ # @return [Array<Symbol, Knockapi::Models::ScheduleRepeatRule::Day>, nil]
28
28
  optional :days,
29
29
  -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ScheduleRepeatRule::Day] },
30
30
  nil?: true
@@ -52,11 +52,11 @@ module Knockapi
52
52
  #
53
53
  # @param _typename [String] The typename of the schema.
54
54
  #
55
- # @param frequency [Symbol, Knockapi::ScheduleRepeatRule::Frequency] The frequency of the schedule.
55
+ # @param frequency [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency] The frequency of the schedule.
56
56
  #
57
57
  # @param day_of_month [Integer, nil] The day of the month to repeat the schedule.
58
58
  #
59
- # @param days [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
59
+ # @param days [Array<Symbol, Knockapi::Models::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
60
60
  #
61
61
  # @param hours [Integer, nil] The hour of the day to repeat the schedule.
62
62
  #
@@ -66,7 +66,7 @@ module Knockapi
66
66
 
67
67
  # The frequency of the schedule.
68
68
  #
69
- # @see Knockapi::ScheduleRepeatRule#frequency
69
+ # @see Knockapi::Models::ScheduleRepeatRule#frequency
70
70
  module Frequency
71
71
  extend Knockapi::Internal::Type::Enum
72
72
 
@@ -17,11 +17,14 @@ module Knockapi
17
17
  # A reference to a recipient, either a user identifier (string) or an object
18
18
  # reference (ID, collection).
19
19
  #
20
- # @return [String, Knockapi::RecipientReference::ObjectReference, nil]
20
+ # @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
21
21
  optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true
22
22
 
23
23
  # @!attribute data
24
- # An optional map of data to pass into the workflow execution.
24
+ # An optional map of data to pass into the workflow execution. There is a 1024
25
+ # byte limit on the size of any single string value (with the exception of
26
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
27
+ # size of the full `data` payload.
25
28
  #
26
29
  # @return [Hash{Symbol=>Object}, nil]
27
30
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -35,7 +38,7 @@ module Knockapi
35
38
  # @!attribute repeats
36
39
  # The repeat rule for the schedule.
37
40
  #
38
- # @return [Array<Knockapi::ScheduleRepeatRule>, nil]
41
+ # @return [Array<Knockapi::Models::ScheduleRepeatRule>, nil]
39
42
  optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
40
43
 
41
44
  # @!attribute scheduled_at
@@ -47,7 +50,7 @@ module Knockapi
47
50
  # @!attribute tenant
48
51
  # An request to set a tenant inline.
49
52
  #
50
- # @return [String, Knockapi::TenantRequest, nil]
53
+ # @return [String, Knockapi::Models::TenantRequest, nil]
51
54
  optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
52
55
 
53
56
  # @!method initialize(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
@@ -56,17 +59,17 @@ module Knockapi
56
59
  #
57
60
  # @param schedule_ids [Array<String>] A list of schedule IDs.
58
61
  #
59
- # @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
62
+ # @param actor [String, Knockapi::Models::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
60
63
  #
61
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
64
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
62
65
  #
63
66
  # @param ending_at [Time, nil] The ending date and time for the schedule.
64
67
  #
65
- # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
68
+ # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
66
69
  #
67
70
  # @param scheduled_at [Time, nil] The starting date and time for the schedule.
68
71
  #
69
- # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
72
+ # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
70
73
  #
71
74
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
72
75
  end
@@ -11,12 +11,12 @@ module Knockapi
11
11
  # @!attribute schedules
12
12
  # A list of schedules.
13
13
  #
14
- # @return [Array<Knockapi::Schedules::BulkCreateParams::Schedule>]
14
+ # @return [Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>]
15
15
  required :schedules,
16
16
  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Schedules::BulkCreateParams::Schedule] }
17
17
 
18
18
  # @!method initialize(schedules:, request_options: {})
19
- # @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
19
+ # @param schedules [Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>] A list of schedules.
20
20
  #
21
21
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
22
22
 
@@ -32,11 +32,14 @@ module Knockapi
32
32
  # (string), an inline user request (object), or an inline object request, which is
33
33
  # determined by the presence of a `collection` property.
34
34
  #
35
- # @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
35
+ # @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
36
36
  optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
37
37
 
38
38
  # @!attribute data
39
- # An optional map of data to pass into the workflow execution.
39
+ # An optional map of data to pass into the workflow execution. There is a 1024
40
+ # byte limit on the size of any single string value (with the exception of
41
+ # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
42
+ # size of the full `data` payload.
40
43
  #
41
44
  # @return [Hash{Symbol=>Object}, nil]
42
45
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -52,13 +55,13 @@ module Knockapi
52
55
  # (string), an inline user request (object), or an inline object request, which is
53
56
  # determined by the presence of a `collection` property.
54
57
  #
55
- # @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
58
+ # @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
56
59
  optional :recipient, union: -> { Knockapi::RecipientRequest }
57
60
 
58
61
  # @!attribute repeats
59
62
  # The repeat rule for the schedule.
60
63
  #
61
- # @return [Array<Knockapi::ScheduleRepeatRule>, nil]
64
+ # @return [Array<Knockapi::Models::ScheduleRepeatRule>, nil]
62
65
  optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
63
66
 
64
67
  # @!attribute scheduled_at
@@ -70,30 +73,30 @@ module Knockapi
70
73
  # @!attribute tenant
71
74
  # An request to set a tenant inline.
72
75
  #
73
- # @return [String, Knockapi::TenantRequest, nil]
76
+ # @return [String, Knockapi::Models::TenantRequest, nil]
74
77
  optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
75
78
 
76
79
  # @!method initialize(workflow:, actor: nil, data: nil, ending_at: nil, recipient: nil, repeats: nil, scheduled_at: nil, tenant: nil)
77
80
  # Some parameter documentations has been truncated, see
78
- # {Knockapi::Schedules::BulkCreateParams::Schedule} for more details.
81
+ # {Knockapi::Models::Schedules::BulkCreateParams::Schedule} for more details.
79
82
  #
80
83
  # A schedule represents a recurring workflow execution.
81
84
  #
82
85
  # @param workflow [String] The key of the workflow.
83
86
  #
84
- # @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
87
+ # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
85
88
  #
86
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
89
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
87
90
  #
88
91
  # @param ending_at [Time, nil] The ending date and time for the schedule.
89
92
  #
90
- # @param recipient [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
93
+ # @param recipient [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
91
94
  #
92
- # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
95
+ # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
93
96
  #
94
97
  # @param scheduled_at [Time, nil] The starting date and time for the schedule.
95
98
  #
96
- # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
99
+ # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
97
100
  end
98
101
  end
99
102
  end
@@ -25,7 +25,7 @@ module Knockapi
25
25
  # @!attribute settings
26
26
  # The settings for the tenant. Includes branding and preference set.
27
27
  #
28
- # @return [Knockapi::Tenant::Settings, nil]
28
+ # @return [Knockapi::Models::Tenant::Settings, nil]
29
29
  optional :settings, -> { Knockapi::Tenant::Settings }, nil?: true
30
30
 
31
31
  # @!method initialize(id:, _typename:, name: nil, settings: nil)
@@ -37,34 +37,34 @@ module Knockapi
37
37
  #
38
38
  # @param name [String, nil] An optional name for the tenant.
39
39
  #
40
- # @param settings [Knockapi::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
40
+ # @param settings [Knockapi::Models::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
41
41
 
42
- # @see Knockapi::Tenant#settings
42
+ # @see Knockapi::Models::Tenant#settings
43
43
  class Settings < Knockapi::Internal::Type::BaseModel
44
44
  # @!attribute branding
45
45
  # The branding for the tenant.
46
46
  #
47
- # @return [Knockapi::Tenant::Settings::Branding, nil]
47
+ # @return [Knockapi::Models::Tenant::Settings::Branding, nil]
48
48
  optional :branding, -> { Knockapi::Tenant::Settings::Branding }, nil?: true
49
49
 
50
50
  # @!attribute preference_set
51
51
  # A preference set represents a specific set of notification preferences for a
52
52
  # recipient. A recipient can have multiple preference sets.
53
53
  #
54
- # @return [Knockapi::Recipients::PreferenceSet, nil]
54
+ # @return [Knockapi::Models::Recipients::PreferenceSet, nil]
55
55
  optional :preference_set, -> { Knockapi::Recipients::PreferenceSet }, nil?: true
56
56
 
57
57
  # @!method initialize(branding: nil, preference_set: nil)
58
58
  # Some parameter documentations has been truncated, see
59
- # {Knockapi::Tenant::Settings} for more details.
59
+ # {Knockapi::Models::Tenant::Settings} for more details.
60
60
  #
61
61
  # The settings for the tenant. Includes branding and preference set.
62
62
  #
63
- # @param branding [Knockapi::Tenant::Settings::Branding, nil] The branding for the tenant.
63
+ # @param branding [Knockapi::Models::Tenant::Settings::Branding, nil] The branding for the tenant.
64
64
  #
65
- # @param preference_set [Knockapi::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
65
+ # @param preference_set [Knockapi::Models::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
66
66
 
67
- # @see Knockapi::Tenant::Settings#branding
67
+ # @see Knockapi::Models::Tenant::Settings#branding
68
68
  class Branding < Knockapi::Internal::Type::BaseModel
69
69
  # @!attribute icon_url
70
70
  # The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -94,7 +94,7 @@ module Knockapi
94
94
 
95
95
  # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
96
96
  # Some parameter documentations has been truncated, see
97
- # {Knockapi::Tenant::Settings::Branding} for more details.
97
+ # {Knockapi::Models::Tenant::Settings::Branding} for more details.
98
98
  #
99
99
  # The branding for the tenant.
100
100
  #
@@ -12,7 +12,7 @@ module Knockapi
12
12
  # @!attribute channel_data
13
13
  # A request to set channel data for a type of channel inline.
14
14
  #
15
- # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
15
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
16
16
  optional :channel_data,
17
17
  -> {
18
18
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -22,7 +22,7 @@ module Knockapi
22
22
  # @!attribute preferences
23
23
  # Inline set preferences for a recipient, where the key is the preference set id.
24
24
  #
25
- # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
25
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
26
26
  optional :preferences,
27
27
  -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
28
28
  nil?: true
@@ -30,7 +30,7 @@ module Knockapi
30
30
  # @!attribute settings
31
31
  # The settings for the tenant. Includes branding and preference set.
32
32
  #
33
- # @return [Knockapi::TenantRequest::Settings, nil]
33
+ # @return [Knockapi::Models::TenantRequest::Settings, nil]
34
34
  optional :settings, -> { Knockapi::TenantRequest::Settings }
35
35
 
36
36
  # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
@@ -39,34 +39,34 @@ module Knockapi
39
39
  #
40
40
  # @param id [String] The unique identifier for the tenant.
41
41
  #
42
- # @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.
42
+ # @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.
43
43
  #
44
- # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
44
+ # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
45
45
  #
46
- # @param settings [Knockapi::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
46
+ # @param settings [Knockapi::Models::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
47
47
 
48
- # @see Knockapi::TenantRequest#settings
48
+ # @see Knockapi::Models::TenantRequest#settings
49
49
  class Settings < Knockapi::Internal::Type::BaseModel
50
50
  # @!attribute branding
51
51
  # The branding for the tenant.
52
52
  #
53
- # @return [Knockapi::TenantRequest::Settings::Branding, nil]
53
+ # @return [Knockapi::Models::TenantRequest::Settings::Branding, nil]
54
54
  optional :branding, -> { Knockapi::TenantRequest::Settings::Branding }
55
55
 
56
56
  # @!attribute preference_set
57
57
  # A request to set a preference set for a recipient.
58
58
  #
59
- # @return [Knockapi::Recipients::PreferenceSetRequest, nil]
59
+ # @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
60
60
  optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
61
61
 
62
62
  # @!method initialize(branding: nil, preference_set: nil)
63
63
  # The settings for the tenant. Includes branding and preference set.
64
64
  #
65
- # @param branding [Knockapi::TenantRequest::Settings::Branding] The branding for the tenant.
65
+ # @param branding [Knockapi::Models::TenantRequest::Settings::Branding] The branding for the tenant.
66
66
  #
67
- # @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
67
+ # @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
68
68
 
69
- # @see Knockapi::TenantRequest::Settings#branding
69
+ # @see Knockapi::Models::TenantRequest::Settings#branding
70
70
  class Branding < Knockapi::Internal::Type::BaseModel
71
71
  # @!attribute icon_url
72
72
  # The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -96,7 +96,7 @@ module Knockapi
96
96
 
97
97
  # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
98
98
  # Some parameter documentations has been truncated, see
99
- # {Knockapi::TenantRequest::Settings::Branding} for more details.
99
+ # {Knockapi::Models::TenantRequest::Settings::Branding} for more details.
100
100
  #
101
101
  # The branding for the tenant.
102
102
  #