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