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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fdf258bbe7e17f9d95456fd503712fa051dcd85fa28d8dd9e308cc3e33b5ffa3
4
- data.tar.gz: 435914a90c65531ac4dcafdb5af0ea1ef4ba6febfa948865bb60458c99ae3c9e
3
+ metadata.gz: fb5f76000d121d8c600814efe156b7cf2f4b4462a226fecbb21b4748a9b65e18
4
+ data.tar.gz: cae6459c8ef79cce6dea2a81cd25493a526511316d89fdb0a92e85f10759cf3e
5
5
  SHA512:
6
- metadata.gz: 39584fbdff4b91e0630c6c7d8e05b7ac73c57de5e442945aa31bb3883fa3cfc3b9a705f074ac9cc4cc0e0f464ee6e19b431d6cb81b8e63e0ef332bad4bd808e3
7
- data.tar.gz: 47c33e8c167fb90c047a78fb3831266fa720f5d96b89763411dd2c75ffd5cfdbe956b6fd10c58af6bee121be65b919ef51c51ab9f55bef584c5927aac854a2bb
6
+ metadata.gz: 9469436d0f22fdcac4390c410b9d3611c498d5406657fa0b4c0c117d05c11dfcc3f9c17bfabcf1187a03041d370f09e6b468f81ee67f0dd7b57cffb9f4c98411
7
+ data.tar.gz: 431e2d390a4bfbdbc12f5a6efa1e0e6446ef51a64628da70e8a852399e9477b1179ed1545498b307ebf4a60413d34fbc6f2e3ae17dafc5e0a5c61184c8b0402d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.34.0 (2026-03-16)
4
+
5
+ Full Changelog: [v1.33.0...v1.34.0](https://github.com/knocklabs/knock-ruby/compare/v1.33.0...v1.34.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([8f572c6](https://github.com/knocklabs/knock-ruby/commit/8f572c6bb0d7deb1d20a1abe3924f1e95f21ca2d))
10
+ * **api:** api update ([5232e1e](https://github.com/knocklabs/knock-ruby/commit/5232e1edcd1da902db9b04aff3fbb0cfae0bed90))
11
+ * **api:** api update ([765390c](https://github.com/knocklabs/knock-ruby/commit/765390cceb4a9137a3faaa4604c9f8ab5ce78a20))
12
+ * **api:** api update ([e83aaa6](https://github.com/knocklabs/knock-ruby/commit/e83aaa66f6fdee79b306af01052869185625d468))
13
+ * **api:** api update ([8cfb413](https://github.com/knocklabs/knock-ruby/commit/8cfb4139f35be6b9c98e9544deda42736253c40f))
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * **client:** add types for path params, and update structure of unions nested in params ([dafc84b](https://github.com/knocklabs/knock-ruby/commit/dafc84b3aa4176307137891ac55f41d025e32ffc))
19
+
20
+
21
+ ### Chores
22
+
23
+ * **ci:** skip uploading artifacts on stainless-internal branches ([62439f6](https://github.com/knocklabs/knock-ruby/commit/62439f62236289d132c653ee23fc832a1a78b13b))
24
+ * **internal:** tweak CI branches ([319abd4](https://github.com/knocklabs/knock-ruby/commit/319abd497feab9f1a4a12be7ef58e6f9ea513b8c))
25
+ * **test:** do not count install time for mock server timeout ([f6dd487](https://github.com/knocklabs/knock-ruby/commit/f6dd487a2952bf560de7373eed043173debc2529))
26
+
3
27
  ## 1.33.0 (2026-03-03)
4
28
 
5
29
  Full Changelog: [v1.32.1...v1.33.0](https://github.com/knocklabs/knock-ruby/compare/v1.32.1...v1.33.0)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "knockapi", "~> 1.33.0"
20
+ gem "knockapi", "~> 1.34.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-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 key
11
+ #
12
+ # @return [String]
13
+ required :key, String
14
+
10
15
  # @!attribute members
11
16
  # A list of audience members to add. You can add up to 1,000 members per request.
12
17
  #
@@ -19,7 +24,9 @@ module Knockapi
19
24
  # @return [Boolean, nil]
20
25
  optional :create_audience, Knockapi::Internal::Type::Boolean
21
26
 
22
- # @!method initialize(members:, create_audience: nil, request_options: {})
27
+ # @!method initialize(key:, members:, create_audience: nil, request_options: {})
28
+ # @param key [String]
29
+ #
23
30
  # @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add. You can add up to 1,000 members per request.
24
31
  #
25
32
  # @param create_audience [Boolean] Create the audience if it does not exist.
@@ -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 key
11
+ #
12
+ # @return [String]
13
+ required :key, String
14
+
15
+ # @!method initialize(key:, request_options: {})
16
+ # @param key [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 key
11
+ #
12
+ # @return [String]
13
+ required :key, String
14
+
10
15
  # @!attribute members
11
16
  # A list of audience members to remove. You can remove up to 1,000 members per
12
17
  # request.
@@ -14,10 +19,12 @@ module Knockapi
14
19
  # @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
15
20
  required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member] }
16
21
 
17
- # @!method initialize(members:, request_options: {})
22
+ # @!method initialize(key:, members:, request_options: {})
18
23
  # Some parameter documentations has been truncated, see
19
24
  # {Knockapi::Models::AudienceRemoveMembersParams} for more details.
20
25
  #
26
+ # @param key [String]
27
+ #
21
28
  # @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove. You can remove up to 1,000 members per req
22
29
  #
23
30
  # @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
@@ -8,6 +8,16 @@ 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
+
16
+ # @!attribute action
17
+ #
18
+ # @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action]
19
+ required :action, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Action }
20
+
11
21
  # @!attribute archived
12
22
  # Limits the results to messages with the given archived status.
13
23
  #
@@ -71,10 +81,14 @@ module Knockapi
71
81
  # @return [Array<String>, nil]
72
82
  optional :workflows, Knockapi::Internal::Type::ArrayOf[String]
73
83
 
74
- # @!method initialize(archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
84
+ # @!method initialize(channel_id:, action:, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
75
85
  # Some parameter documentations has been truncated, see
76
86
  # {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
77
87
  #
88
+ # @param channel_id [String]
89
+ #
90
+ # @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action]
91
+ #
78
92
  # @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
79
93
  #
80
94
  # @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
@@ -56,6 +56,7 @@ module Knockapi
56
56
  IS_TIMESTAMP_ON_OR_AFTER_DATE = :is_timestamp_on_or_after_date
57
57
  IS_TIMESTAMP_BEFORE_DATE = :is_timestamp_before_date
58
58
  IS_TIMESTAMP_BETWEEN = :is_timestamp_between
59
+ IS_BETWEEN = :is_between
59
60
  IS_AUDIENCE_MEMBER = :is_audience_member
60
61
  IS_NOT_AUDIENCE_MEMBER = :is_not_audience_member
61
62
 
@@ -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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -31,7 +36,9 @@ module Knockapi
31
36
  # @return [String, nil]
32
37
  optional :trigger_data, String
33
38
 
34
- # @!method initialize(after: nil, before: nil, page_size: nil, trigger_data: nil, request_options: {})
39
+ # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, trigger_data: nil, request_options: {})
40
+ # @param message_id [String]
41
+ #
35
42
  # @param after [String] The cursor to fetch entries after.
36
43
  #
37
44
  # @param before [String] The cursor to fetch entries before.
@@ -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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -25,7 +30,9 @@ module Knockapi
25
30
  # @return [Integer, nil]
26
31
  optional :page_size, Integer
27
32
 
28
- # @!method initialize(after: nil, before: nil, page_size: nil, request_options: {})
33
+ # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, request_options: {})
34
+ # @param message_id [String]
35
+ #
29
36
  # @param after [String] The cursor to fetch entries after.
30
37
  #
31
38
  # @param before [String] The cursor to fetch entries before.
@@ -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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -25,7 +30,9 @@ module Knockapi
25
30
  # @return [Integer, nil]
26
31
  optional :page_size, Integer
27
32
 
28
- # @!method initialize(after: nil, before: nil, page_size: nil, request_options: {})
33
+ # @!method initialize(message_id:, after: nil, before: nil, page_size: nil, request_options: {})
34
+ # @param message_id [String]
35
+ #
29
36
  # @param after [String] The cursor to fetch entries after.
30
37
  #
31
38
  # @param before [String] The cursor to fetch entries before.
@@ -7,13 +7,20 @@ module Knockapi
7
7
  extend Knockapi::Internal::Type::RequestParameters::Converter
8
8
  include Knockapi::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
10
15
  # @!attribute metadata
11
16
  # Metadata about the interaction.
12
17
  #
13
18
  # @return [Hash{Symbol=>Object}, nil]
14
19
  optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
15
20
 
16
- # @!method initialize(metadata: nil, request_options: {})
21
+ # @!method initialize(message_id:, metadata: nil, request_options: {})
22
+ # @param message_id [String]
23
+ #
17
24
  # @param metadata [Hash{Symbol=>Object}] Metadata about the interaction.
18
25
  #
19
26
  # @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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 message_id
11
+ #
12
+ # @return [String]
13
+ required :message_id, String
14
+
15
+ # @!method initialize(message_id:, request_options: {})
16
+ # @param message_id [String]
11
17
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  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 object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
10
20
  # @!attribute recipients
11
21
  # The recipients of the subscription. You can subscribe up to 100 recipients to an
12
22
  # object at a time.
@@ -20,10 +30,14 @@ module Knockapi
20
30
  # @return [Hash{Symbol=>Object}, nil]
21
31
  optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
22
32
 
23
- # @!method initialize(recipients:, properties: nil, request_options: {})
33
+ # @!method initialize(collection:, object_id_:, recipients:, properties: nil, request_options: {})
24
34
  # Some parameter documentations has been truncated, see
25
35
  # {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
26
36
  #
37
+ # @param collection [String]
38
+ #
39
+ # @param object_id_ [String]
40
+ #
27
41
  # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
28
42
  #
29
43
  # @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
@@ -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 collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute id
16
+ #
17
+ # @return [String]
18
+ required :id, String
19
+
20
+ # @!method initialize(collection:, id:, request_options: {})
21
+ # @param collection [String]
22
+ # @param id [String]
11
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
24
  end
13
25
  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 object_id_
16
+ #
17
+ # @return [String]
18
+ required :object_id_, String
19
+
10
20
  # @!attribute recipients
11
21
  # The recipients of the subscription. You can subscribe up to 100 recipients to an
12
22
  # object at a time.
@@ -14,10 +24,14 @@ module Knockapi
14
24
  # @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
15
25
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
16
26
 
17
- # @!method initialize(recipients:, request_options: {})
27
+ # @!method initialize(collection:, object_id_:, recipients:, request_options: {})
18
28
  # Some parameter documentations has been truncated, see
19
29
  # {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
20
30
  #
31
+ # @param collection [String]
32
+ #
33
+ # @param object_id_ [String]
34
+ #
21
35
  # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
22
36
  #
23
37
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
@@ -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,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 collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
15
+ # @!attribute id
16
+ #
17
+ # @return [String]
18
+ required :id, String
19
+
20
+ # @!method initialize(collection:, id:, request_options: {})
21
+ # @param collection [String]
22
+ # @param id [String]
11
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
24
  end
13
25
  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 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,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
  #
@@ -96,10 +106,14 @@ module Knockapi
96
106
  # @return [String, nil]
97
107
  optional :workflow_run_id, String
98
108
 
99
- # @!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: {})
109
+ # @!method initialize(collection:, 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: {})
100
110
  # Some parameter documentations has been truncated, see
101
111
  # {Knockapi::Models::ObjectListMessagesParams} for more details.
102
112
  #
113
+ # @param collection [String]
114
+ #
115
+ # @param id [String]
116
+ #
103
117
  # @param after [String] The cursor to fetch entries after.
104
118
  #
105
119
  # @param before [String] The cursor to fetch entries before.
@@ -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 collection
11
+ #
12
+ # @return [String]
13
+ required :collection, String
14
+
10
15
  # @!attribute after
11
16
  # The cursor to fetch entries after.
12
17
  #
@@ -31,7 +36,9 @@ module Knockapi
31
36
  # @return [Integer, nil]
32
37
  optional :page_size, Integer
33
38
 
34
- # @!method initialize(after: nil, before: nil, include: nil, page_size: nil, request_options: {})
39
+ # @!method initialize(collection:, after: nil, before: nil, include: nil, page_size: nil, request_options: {})
40
+ # @param collection [String]
41
+ #
35
42
  # @param after [String] The cursor to fetch entries after.
36
43
  #
37
44
  # @param before [String] The cursor to fetch entries before.
@@ -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 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
+ # @!method initialize(collection:, object_id_:, request_options: {})
21
+ # @param collection [String]
22
+ # @param object_id_ [String]
11
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
12
24
  end
13
25
  end