knockapi 1.33.0 → 1.34.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 (209) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/models/audience_add_members_params.rb +8 -1
  5. data/lib/knockapi/models/audience_list_members_params.rb +7 -1
  6. data/lib/knockapi/models/audience_remove_members_params.rb +8 -1
  7. data/lib/knockapi/models/bulk_operation_get_params.rb +7 -1
  8. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +15 -1
  9. data/lib/knockapi/models/condition.rb +1 -0
  10. data/lib/knockapi/models/message_archive_params.rb +7 -1
  11. data/lib/knockapi/models/message_get_content_params.rb +7 -1
  12. data/lib/knockapi/models/message_get_params.rb +7 -1
  13. data/lib/knockapi/models/message_list_activities_params.rb +8 -1
  14. data/lib/knockapi/models/message_list_delivery_logs_params.rb +8 -1
  15. data/lib/knockapi/models/message_list_events_params.rb +8 -1
  16. data/lib/knockapi/models/message_mark_as_interacted_params.rb +8 -1
  17. data/lib/knockapi/models/message_mark_as_read_params.rb +7 -1
  18. data/lib/knockapi/models/message_mark_as_seen_params.rb +7 -1
  19. data/lib/knockapi/models/message_mark_as_unread_params.rb +7 -1
  20. data/lib/knockapi/models/message_mark_as_unseen_params.rb +7 -1
  21. data/lib/knockapi/models/message_unarchive_params.rb +7 -1
  22. data/lib/knockapi/models/object_add_subscriptions_params.rb +15 -1
  23. data/lib/knockapi/models/object_delete_params.rb +13 -1
  24. data/lib/knockapi/models/object_delete_subscriptions_params.rb +15 -1
  25. data/lib/knockapi/models/object_get_channel_data_params.rb +19 -1
  26. data/lib/knockapi/models/object_get_params.rb +13 -1
  27. data/lib/knockapi/models/object_get_preferences_params.rb +19 -1
  28. data/lib/knockapi/models/object_list_messages_params.rb +15 -1
  29. data/lib/knockapi/models/object_list_params.rb +8 -1
  30. data/lib/knockapi/models/object_list_preferences_params.rb +13 -1
  31. data/lib/knockapi/models/object_list_schedules_params.rb +15 -1
  32. data/lib/knockapi/models/object_list_subscriptions_params.rb +15 -1
  33. data/lib/knockapi/models/object_set_channel_data_params.rb +19 -1
  34. data/lib/knockapi/models/object_set_params.rb +15 -1
  35. data/lib/knockapi/models/object_set_preferences_params.rb +19 -1
  36. data/lib/knockapi/models/object_unset_channel_data_params.rb +19 -1
  37. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +8 -1
  38. data/lib/knockapi/models/objects/bulk_delete_params.rb +8 -1
  39. data/lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb +8 -1
  40. data/lib/knockapi/models/objects/bulk_set_params.rb +8 -1
  41. data/lib/knockapi/models/providers/ms_team_check_auth_params.rb +8 -1
  42. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +8 -1
  43. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +8 -1
  44. data/lib/knockapi/models/providers/ms_team_revoke_access_params.rb +8 -1
  45. data/lib/knockapi/models/providers/slack_check_auth_params.rb +8 -1
  46. data/lib/knockapi/models/providers/slack_list_channels_params.rb +8 -1
  47. data/lib/knockapi/models/providers/slack_revoke_access_params.rb +8 -1
  48. data/lib/knockapi/models/tenant_delete_params.rb +7 -1
  49. data/lib/knockapi/models/tenant_get_params.rb +8 -1
  50. data/lib/knockapi/models/tenant_set_params.rb +8 -1
  51. data/lib/knockapi/models/user_delete_params.rb +7 -1
  52. data/lib/knockapi/models/user_get_channel_data_params.rb +13 -1
  53. data/lib/knockapi/models/user_get_params.rb +7 -1
  54. data/lib/knockapi/models/user_get_preferences_params.rb +15 -1
  55. data/lib/knockapi/models/user_list_messages_params.rb +8 -1
  56. data/lib/knockapi/models/user_list_preferences_params.rb +7 -1
  57. data/lib/knockapi/models/user_list_schedules_params.rb +8 -1
  58. data/lib/knockapi/models/user_list_subscriptions_params.rb +8 -1
  59. data/lib/knockapi/models/user_merge_params.rb +8 -1
  60. data/lib/knockapi/models/user_set_channel_data_params.rb +13 -1
  61. data/lib/knockapi/models/user_set_preferences_params.rb +13 -1
  62. data/lib/knockapi/models/user_unset_channel_data_params.rb +13 -1
  63. data/lib/knockapi/models/user_update_params.rb +7 -1
  64. data/lib/knockapi/models/users/feed_get_settings_params.rb +13 -1
  65. data/lib/knockapi/models/users/feed_list_items_params.rb +15 -1
  66. data/lib/knockapi/models/users/guide_get_channel_params.rb +15 -1
  67. data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +15 -1
  68. data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +15 -1
  69. data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +15 -1
  70. data/lib/knockapi/models/workflow_cancel_params.rb +8 -1
  71. data/lib/knockapi/models/workflow_trigger_params.rb +8 -1
  72. data/lib/knockapi/version.rb +1 -1
  73. data/rbi/knockapi/models/audience_add_members_params.rbi +6 -0
  74. data/rbi/knockapi/models/audience_list_members_params.rbi +13 -5
  75. data/rbi/knockapi/models/audience_remove_members_params.rbi +6 -0
  76. data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
  77. data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +18 -0
  78. data/rbi/knockapi/models/condition.rbi +2 -0
  79. data/rbi/knockapi/models/message_archive_params.rbi +13 -5
  80. data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
  81. data/rbi/knockapi/models/message_get_params.rbi +13 -5
  82. data/rbi/knockapi/models/message_list_activities_params.rbi +6 -0
  83. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +6 -0
  84. data/rbi/knockapi/models/message_list_events_params.rbi +6 -0
  85. data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +6 -0
  86. data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
  87. data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
  88. data/rbi/knockapi/models/message_mark_as_unread_params.rbi +13 -5
  89. data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +13 -5
  90. data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
  91. data/rbi/knockapi/models/object_add_subscriptions_params.rbi +12 -0
  92. data/rbi/knockapi/models/object_delete_params.rbi +21 -5
  93. data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +12 -0
  94. data/rbi/knockapi/models/object_get_channel_data_params.rbi +26 -5
  95. data/rbi/knockapi/models/object_get_params.rbi +21 -5
  96. data/rbi/knockapi/models/object_get_preferences_params.rbi +26 -5
  97. data/rbi/knockapi/models/object_list_messages_params.rbi +12 -0
  98. data/rbi/knockapi/models/object_list_params.rbi +6 -0
  99. data/rbi/knockapi/models/object_list_preferences_params.rbi +21 -5
  100. data/rbi/knockapi/models/object_list_schedules_params.rbi +12 -0
  101. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +12 -0
  102. data/rbi/knockapi/models/object_set_channel_data_params.rbi +26 -5
  103. data/rbi/knockapi/models/object_set_params.rbi +12 -0
  104. data/rbi/knockapi/models/object_set_preferences_params.rbi +26 -5
  105. data/rbi/knockapi/models/object_unset_channel_data_params.rbi +26 -5
  106. data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +6 -0
  107. data/rbi/knockapi/models/objects/bulk_delete_params.rbi +6 -0
  108. data/rbi/knockapi/models/objects/bulk_delete_subscriptions_params.rbi +6 -0
  109. data/rbi/knockapi/models/objects/bulk_set_params.rbi +6 -0
  110. data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +6 -0
  111. data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +6 -0
  112. data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +6 -0
  113. data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +6 -0
  114. data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +6 -0
  115. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +6 -0
  116. data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +6 -0
  117. data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
  118. data/rbi/knockapi/models/tenant_get_params.rbi +6 -0
  119. data/rbi/knockapi/models/tenant_set_params.rbi +6 -0
  120. data/rbi/knockapi/models/user_delete_params.rbi +13 -5
  121. data/rbi/knockapi/models/user_get_channel_data_params.rbi +21 -5
  122. data/rbi/knockapi/models/user_get_params.rbi +13 -5
  123. data/rbi/knockapi/models/user_get_preferences_params.rbi +16 -1
  124. data/rbi/knockapi/models/user_list_messages_params.rbi +6 -0
  125. data/rbi/knockapi/models/user_list_preferences_params.rbi +13 -5
  126. data/rbi/knockapi/models/user_list_schedules_params.rbi +6 -0
  127. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +6 -0
  128. data/rbi/knockapi/models/user_merge_params.rbi +10 -1
  129. data/rbi/knockapi/models/user_set_channel_data_params.rbi +21 -5
  130. data/rbi/knockapi/models/user_set_preferences_params.rbi +21 -5
  131. data/rbi/knockapi/models/user_unset_channel_data_params.rbi +21 -5
  132. data/rbi/knockapi/models/user_update_params.rbi +13 -5
  133. data/rbi/knockapi/models/users/feed_get_settings_params.rbi +21 -5
  134. data/rbi/knockapi/models/users/feed_list_items_params.rbi +12 -0
  135. data/rbi/knockapi/models/users/guide_get_channel_params.rbi +12 -0
  136. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +12 -0
  137. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +12 -0
  138. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +12 -0
  139. data/rbi/knockapi/models/workflow_cancel_params.rbi +6 -0
  140. data/rbi/knockapi/models/workflow_trigger_params.rbi +6 -0
  141. data/sig/knockapi/models/audience_add_members_params.rbs +5 -0
  142. data/sig/knockapi/models/audience_list_members_params.rbs +8 -3
  143. data/sig/knockapi/models/audience_remove_members_params.rbs +8 -1
  144. data/sig/knockapi/models/bulk_operation_get_params.rbs +8 -3
  145. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +10 -0
  146. data/sig/knockapi/models/condition.rbs +2 -0
  147. data/sig/knockapi/models/message_archive_params.rbs +11 -3
  148. data/sig/knockapi/models/message_get_content_params.rbs +11 -3
  149. data/sig/knockapi/models/message_get_params.rbs +11 -3
  150. data/sig/knockapi/models/message_list_activities_params.rbs +5 -0
  151. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +5 -1
  152. data/sig/knockapi/models/message_list_events_params.rbs +5 -1
  153. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -1
  154. data/sig/knockapi/models/message_mark_as_read_params.rbs +11 -3
  155. data/sig/knockapi/models/message_mark_as_seen_params.rbs +11 -3
  156. data/sig/knockapi/models/message_mark_as_unread_params.rbs +11 -3
  157. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +11 -3
  158. data/sig/knockapi/models/message_unarchive_params.rbs +11 -3
  159. data/sig/knockapi/models/object_add_subscriptions_params.rbs +10 -0
  160. data/sig/knockapi/models/object_delete_params.rbs +16 -3
  161. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +13 -1
  162. data/sig/knockapi/models/object_get_channel_data_params.rbs +20 -3
  163. data/sig/knockapi/models/object_get_params.rbs +17 -3
  164. data/sig/knockapi/models/object_get_preferences_params.rbs +20 -3
  165. data/sig/knockapi/models/object_list_messages_params.rbs +10 -0
  166. data/sig/knockapi/models/object_list_params.rbs +5 -0
  167. data/sig/knockapi/models/object_list_preferences_params.rbs +16 -3
  168. data/sig/knockapi/models/object_list_schedules_params.rbs +10 -0
  169. data/sig/knockapi/models/object_list_subscriptions_params.rbs +10 -0
  170. data/sig/knockapi/models/object_set_channel_data_params.rbs +26 -3
  171. data/sig/knockapi/models/object_set_params.rbs +10 -0
  172. data/sig/knockapi/models/object_set_preferences_params.rbs +26 -3
  173. data/sig/knockapi/models/object_unset_channel_data_params.rbs +20 -3
  174. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +5 -0
  175. data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -1
  176. data/sig/knockapi/models/objects/bulk_delete_subscriptions_params.rbs +5 -0
  177. data/sig/knockapi/models/objects/bulk_set_params.rbs +8 -1
  178. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -1
  179. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -0
  180. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -0
  181. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -1
  182. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -1
  183. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -0
  184. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -1
  185. data/sig/knockapi/models/tenant_delete_params.rbs +8 -3
  186. data/sig/knockapi/models/tenant_get_params.rbs +5 -1
  187. data/sig/knockapi/models/tenant_set_params.rbs +5 -0
  188. data/sig/knockapi/models/user_delete_params.rbs +11 -3
  189. data/sig/knockapi/models/user_get_channel_data_params.rbs +16 -3
  190. data/sig/knockapi/models/user_get_params.rbs +12 -3
  191. data/sig/knockapi/models/user_get_preferences_params.rbs +10 -1
  192. data/sig/knockapi/models/user_list_messages_params.rbs +5 -0
  193. data/sig/knockapi/models/user_list_preferences_params.rbs +11 -3
  194. data/sig/knockapi/models/user_list_schedules_params.rbs +5 -0
  195. data/sig/knockapi/models/user_list_subscriptions_params.rbs +5 -0
  196. data/sig/knockapi/models/user_merge_params.rbs +6 -1
  197. data/sig/knockapi/models/user_set_channel_data_params.rbs +20 -3
  198. data/sig/knockapi/models/user_set_preferences_params.rbs +20 -3
  199. data/sig/knockapi/models/user_unset_channel_data_params.rbs +16 -3
  200. data/sig/knockapi/models/user_update_params.rbs +13 -3
  201. data/sig/knockapi/models/users/feed_get_settings_params.rbs +16 -3
  202. data/sig/knockapi/models/users/feed_list_items_params.rbs +10 -0
  203. data/sig/knockapi/models/users/guide_get_channel_params.rbs +15 -1
  204. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +10 -0
  205. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +10 -0
  206. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +10 -0
  207. data/sig/knockapi/models/workflow_cancel_params.rbs +5 -0
  208. data/sig/knockapi/models/workflow_trigger_params.rbs +5 -0
  209. metadata +2 -2
@@ -7,6 +7,16 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute id
16
+ #
17
+ # @return [String]
18
+ required :id, String
19
+
10
20
  # @!attribute after
11
21
  # The cursor to fetch entries after.
12
22
  #
@@ -37,7 +47,11 @@ module Knockapi
37
47
  # @return [String, nil]
38
48
  optional :workflow, String
39
49
 
40
- # @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
50
+ # @!method initialize(collection:, id:, after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
51
+ # @param collection [String]
52
+ #
53
+ # @param id [String]
54
+ #
41
55
  # @param after [String] The cursor to fetch entries after.
42
56
  #
43
57
  # @param before [String] The cursor to fetch entries before.
@@ -7,6 +7,16 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
10
20
  # @!attribute after
11
21
  # The cursor to fetch entries after.
12
22
  #
@@ -53,10 +63,14 @@ module Knockapi
53
63
  # @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
54
64
  optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
55
65
 
56
- # @!method initialize(after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
66
+ # @!method initialize(collection:, object_id_:, after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
57
67
  # Some parameter documentations has been truncated, see
58
68
  # {Knockapi::Models::ObjectListSubscriptionsParams} for more details.
59
69
  #
70
+ # @param collection [String]
71
+ #
72
+ # @param object_id_ [String]
73
+ #
60
74
  # @param after [String] The cursor to fetch entries after.
61
75
  #
62
76
  # @param before [String] The cursor to fetch entries before.
@@ -7,7 +7,25 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
20
+ # @!attribute channel_id
21
+ #
22
+ # @return [String]
23
+ required :channel_id, String
24
+
25
+ # @!method initialize(collection:, object_id_:, channel_id:, request_options: {})
26
+ # @param collection [String]
27
+ # @param object_id_ [String]
28
+ # @param channel_id [String]
11
29
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
30
  end
13
31
  end
@@ -7,6 +7,16 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute id
16
+ #
17
+ # @return [String]
18
+ required :id, String
19
+
10
20
  # @!attribute channel_data
11
21
  # A request to set channel data for a type of channel inline.
12
22
  #
@@ -44,10 +54,14 @@ module Knockapi
44
54
  # @return [String, nil]
45
55
  optional :timezone, String, nil?: true
46
56
 
47
- # @!method initialize(channel_data: nil, locale: nil, name: nil, preferences: nil, timezone: nil, request_options: {})
57
+ # @!method initialize(collection:, id:, channel_data: nil, locale: nil, name: nil, preferences: nil, timezone: nil, request_options: {})
48
58
  # Some parameter documentations has been truncated, see
49
59
  # {Knockapi::Models::ObjectSetParams} for more details.
50
60
  #
61
+ # @param collection [String]
62
+ #
63
+ # @param id [String]
64
+ #
51
65
  # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
52
66
  #
53
67
  # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
@@ -7,7 +7,25 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
20
+ # @!attribute id
21
+ #
22
+ # @return [String]
23
+ required :id, String
24
+
25
+ # @!method initialize(collection:, object_id_:, id:, request_options: {})
26
+ # @param collection [String]
27
+ # @param object_id_ [String]
28
+ # @param id [String]
11
29
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
30
  end
13
31
  end
@@ -7,7 +7,25 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
20
+ # @!attribute channel_id
21
+ #
22
+ # @return [String]
23
+ required :channel_id, String
24
+
25
+ # @!method initialize(collection:, object_id_:, channel_id:, request_options: {})
26
+ # @param collection [String]
27
+ # @param object_id_ [String]
28
+ # @param channel_id [String]
11
29
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
30
  end
13
31
  end
@@ -8,6 +8,11 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute collection
12
+ #
13
+ # @return [String]
14
+ required :collection, String
15
+
11
16
  # @!attribute subscriptions
12
17
  # A nested list of subscriptions.
13
18
  #
@@ -15,7 +20,9 @@ module Knockapi
15
20
  required :subscriptions,
16
21
  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription] }
17
22
 
18
- # @!method initialize(subscriptions:, request_options: {})
23
+ # @!method initialize(collection:, subscriptions:, request_options: {})
24
+ # @param collection [String]
25
+ #
19
26
  # @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A nested list of subscriptions.
20
27
  #
21
28
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute collection
12
+ #
13
+ # @return [String]
14
+ required :collection, String
15
+
11
16
  # @!attribute object_ids
12
17
  # List of object IDs to delete.
13
18
  #
14
19
  # @return [Array<String>]
15
20
  required :object_ids, Knockapi::Internal::Type::ArrayOf[String]
16
21
 
17
- # @!method initialize(object_ids:, request_options: {})
22
+ # @!method initialize(collection:, object_ids:, request_options: {})
23
+ # @param collection [String]
24
+ #
18
25
  # @param object_ids [Array<String>] List of object IDs to delete.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,6 +8,11 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute collection
12
+ #
13
+ # @return [String]
14
+ required :collection, String
15
+
11
16
  # @!attribute subscriptions
12
17
  # A nested list of subscriptions.
13
18
  #
@@ -15,7 +20,9 @@ module Knockapi
15
20
  required :subscriptions,
16
21
  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkDeleteSubscriptionsParams::Subscription] }
17
22
 
18
- # @!method initialize(subscriptions:, request_options: {})
23
+ # @!method initialize(collection:, subscriptions:, request_options: {})
24
+ # @param collection [String]
25
+ #
19
26
  # @param subscriptions [Array<Knockapi::Models::Objects::BulkDeleteSubscriptionsParams::Subscription>] A nested list of subscriptions.
20
27
  #
21
28
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute collection
12
+ #
13
+ # @return [String]
14
+ required :collection, String
15
+
11
16
  # @!attribute objects
12
17
  # A list of objects.
13
18
  #
14
19
  # @return [Array<Knockapi::Models::Objects::BulkSetParams::Object>]
15
20
  required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkSetParams::Object] }
16
21
 
17
- # @!method initialize(objects:, request_options: {})
22
+ # @!method initialize(collection:, objects:, request_options: {})
23
+ # @param collection [String]
24
+ #
18
25
  # @param objects [Array<Knockapi::Models::Objects::BulkSetParams::Object>] A list of objects.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute ms_teams_tenant_object
12
17
  # A JSON encoded string containing the Microsoft Teams tenant object reference.
13
18
  #
14
19
  # @return [String]
15
20
  required :ms_teams_tenant_object, String
16
21
 
17
- # @!method initialize(ms_teams_tenant_object:, request_options: {})
22
+ # @!method initialize(channel_id:, ms_teams_tenant_object:, request_options: {})
23
+ # @param channel_id [String]
24
+ #
18
25
  # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,6 +8,11 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute ms_teams_tenant_object
12
17
  # A JSON encoded string containing the Microsoft Teams tenant object reference.
13
18
  #
@@ -25,7 +30,9 @@ module Knockapi
25
30
  # @return [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, nil]
26
31
  optional :query_options, -> { Knockapi::Providers::MsTeamListChannelsParams::QueryOptions }
27
32
 
28
- # @!method initialize(ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
33
+ # @!method initialize(channel_id:, ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
34
+ # @param channel_id [String]
35
+ #
29
36
  # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
30
37
  #
31
38
  # @param team_id [String] Microsoft Teams team ID.
@@ -8,6 +8,11 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute ms_teams_tenant_object
12
17
  # A JSON encoded string containing the Microsoft Teams tenant object reference.
13
18
  #
@@ -19,7 +24,9 @@ module Knockapi
19
24
  # @return [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions, nil]
20
25
  optional :query_options, -> { Knockapi::Providers::MsTeamListTeamsParams::QueryOptions }
21
26
 
22
- # @!method initialize(ms_teams_tenant_object:, query_options: nil, request_options: {})
27
+ # @!method initialize(channel_id:, ms_teams_tenant_object:, query_options: nil, request_options: {})
28
+ # @param channel_id [String]
29
+ #
23
30
  # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
24
31
  #
25
32
  # @param query_options [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute ms_teams_tenant_object
12
17
  # A JSON encoded string containing the Microsoft Teams tenant object reference.
13
18
  #
14
19
  # @return [String]
15
20
  required :ms_teams_tenant_object, String
16
21
 
17
- # @!method initialize(ms_teams_tenant_object:, request_options: {})
22
+ # @!method initialize(channel_id:, ms_teams_tenant_object:, request_options: {})
23
+ # @param channel_id [String]
24
+ #
18
25
  # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute access_token_object
12
17
  # A JSON encoded string containing the access token object reference.
13
18
  #
14
19
  # @return [String]
15
20
  required :access_token_object, String
16
21
 
17
- # @!method initialize(access_token_object:, request_options: {})
22
+ # @!method initialize(channel_id:, access_token_object:, request_options: {})
23
+ # @param channel_id [String]
24
+ #
18
25
  # @param access_token_object [String] A JSON encoded string containing the access token object reference.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -8,6 +8,11 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute access_token_object
12
17
  # A JSON encoded string containing the access token object reference.
13
18
  #
@@ -19,7 +24,9 @@ module Knockapi
19
24
  # @return [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions, nil]
20
25
  optional :query_options, -> { Knockapi::Providers::SlackListChannelsParams::QueryOptions }
21
26
 
22
- # @!method initialize(access_token_object:, query_options: nil, request_options: {})
27
+ # @!method initialize(channel_id:, access_token_object:, query_options: nil, request_options: {})
28
+ # @param channel_id [String]
29
+ #
23
30
  # @param access_token_object [String] A JSON encoded string containing the access token object reference.
24
31
  #
25
32
  # @param query_options [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions]
@@ -8,13 +8,20 @@ module Knockapi
8
8
  extend Knockapi::Internal::Type::RequestParameters::Converter
9
9
  include Knockapi::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute channel_id
12
+ #
13
+ # @return [String]
14
+ required :channel_id, String
15
+
11
16
  # @!attribute access_token_object
12
17
  # A JSON encoded string containing the access token object reference.
13
18
  #
14
19
  # @return [String]
15
20
  required :access_token_object, String
16
21
 
17
- # @!method initialize(access_token_object:, request_options: {})
22
+ # @!method initialize(channel_id:, access_token_object:, request_options: {})
23
+ # @param channel_id [String]
24
+ #
18
25
  # @param access_token_object [String] A JSON encoded string containing the access token object reference.
19
26
  #
20
27
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -7,7 +7,13 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute resolve_full_preference_settings
11
16
  # When true, merges environment-level default preferences into the tenant's
12
17
  # `settings.preference_set` field before returning the response. Defaults to
@@ -15,10 +20,12 @@ module Knockapi
15
20
  # @return [Boolean, nil]
16
21
  optional :resolve_full_preference_settings, Knockapi::Internal::Type::Boolean
17
22
 
18
- # @!method initialize(resolve_full_preference_settings: nil, request_options: {})
23
+ # @!method initialize(id:, resolve_full_preference_settings: nil, request_options: {})
19
24
  # Some parameter documentations has been truncated, see
20
25
  # {Knockapi::Models::TenantGetParams} for more details.
21
26
  #
27
+ # @param id [String]
28
+ #
22
29
  # @param resolve_full_preference_settings [Boolean] When true, merges environment-level default preferences into the tenant's `setti
23
30
  #
24
31
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -7,6 +7,11 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute resolve_full_preference_settings
11
16
  # When true, merges environment-level default preferences into the tenant's
12
17
  # `settings.preference_set` field before returning the response. Defaults to
@@ -37,10 +42,12 @@ module Knockapi
37
42
  # @return [Knockapi::Models::TenantSetParams::Settings, nil]
38
43
  optional :settings, -> { Knockapi::TenantSetParams::Settings }
39
44
 
40
- # @!method initialize(resolve_full_preference_settings: nil, channel_data: nil, name: nil, settings: nil, request_options: {})
45
+ # @!method initialize(id:, resolve_full_preference_settings: nil, channel_data: nil, name: nil, settings: nil, request_options: {})
41
46
  # Some parameter documentations has been truncated, see
42
47
  # {Knockapi::Models::TenantSetParams} for more details.
43
48
  #
49
+ # @param id [String]
50
+ #
44
51
  # @param resolve_full_preference_settings [Boolean] When true, merges environment-level default preferences into the tenant's `setti
45
52
  #
46
53
  # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, 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.
@@ -7,7 +7,13 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
15
+ # @!method initialize(user_id:, request_options: {})
16
+ # @param user_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,19 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
15
+ # @!attribute channel_id
16
+ #
17
+ # @return [String]
18
+ required :channel_id, String
19
+
20
+ # @!method initialize(user_id:, channel_id:, request_options: {})
21
+ # @param user_id [String]
22
+ # @param channel_id [String]
11
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
24
  end
13
25
  end
@@ -7,7 +7,13 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
15
+ # @!method initialize(user_id:, request_options: {})
16
+ # @param user_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,13 +7,27 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
15
+ # @!attribute id
16
+ #
17
+ # @return [String]
18
+ required :id, String
19
+
10
20
  # @!attribute tenant
11
21
  # The unique identifier for the tenant.
12
22
  #
13
23
  # @return [String, nil]
14
24
  optional :tenant, String
15
25
 
16
- # @!method initialize(tenant: nil, request_options: {})
26
+ # @!method initialize(user_id:, id:, tenant: nil, request_options: {})
27
+ # @param user_id [String]
28
+ #
29
+ # @param id [String]
30
+ #
17
31
  # @param tenant [String] The unique identifier for the tenant.
18
32
  #
19
33
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -7,6 +7,11 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -95,10 +100,12 @@ module Knockapi
95
100
  # @return [String, nil]
96
101
  optional :workflow_run_id, String
97
102
 
98
- # @!method initialize(after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
103
+ # @!method initialize(user_id:, after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
99
104
  # Some parameter documentations has been truncated, see
100
105
  # {Knockapi::Models::UserListMessagesParams} for more details.
101
106
  #
107
+ # @param user_id [String]
108
+ #
102
109
  # @param after [String] The cursor to fetch entries after.
103
110
  #
104
111
  # @param before [String] The cursor to fetch entries before.
@@ -7,7 +7,13 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
15
+ # @!method initialize(user_id:, request_options: {})
16
+ # @param user_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute user_id
11
+ #
12
+ # @return [String]
13
+ required :user_id, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -37,7 +42,9 @@ module Knockapi
37
42
  # @return [String, nil]
38
43
  optional :workflow, String
39
44
 
40
- # @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
45
+ # @!method initialize(user_id:, after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
46
+ # @param user_id [String]
47
+ #
41
48
  # @param after [String] The cursor to fetch entries after.
42
49
  #
43
50
  # @param before [String] The cursor to fetch entries before.