knockapi 1.14.0 → 1.15.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 (50) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/client.rb +6 -2
  5. data/lib/knockapi/resources/audiences.rb +4 -4
  6. data/lib/knockapi/resources/objects.rb +4 -4
  7. data/lib/knockapi/resources/tenants.rb +2 -2
  8. data/lib/knockapi/resources/users/guides.rb +3 -3
  9. data/lib/knockapi/resources/users.rb +4 -4
  10. data/lib/knockapi/resources/workflows.rb +2 -2
  11. data/lib/knockapi/version.rb +1 -1
  12. data/lib/knockapi.rb +0 -8
  13. data/rbi/knockapi/client.rbi +4 -2
  14. data/rbi/knockapi/resources/audiences.rbi +2 -2
  15. data/rbi/knockapi/resources/objects.rbi +2 -2
  16. data/rbi/knockapi/resources/tenants.rbi +1 -1
  17. data/rbi/knockapi/resources/users/guides.rbi +0 -3
  18. data/rbi/knockapi/resources/users.rbi +2 -2
  19. data/rbi/knockapi/resources/workflows.rbi +1 -1
  20. data/sig/knockapi/client.rbs +2 -1
  21. data/sig/knockapi/resources/audiences.rbs +2 -2
  22. data/sig/knockapi/resources/objects.rbs +2 -2
  23. data/sig/knockapi/resources/tenants.rbs +1 -4
  24. data/sig/knockapi/resources/users.rbs +2 -2
  25. data/sig/knockapi/resources/workflows.rbs +1 -1
  26. metadata +2 -26
  27. data/lib/knockapi/models/audience_add_members_response.rb +0 -7
  28. data/lib/knockapi/models/audience_remove_members_response.rb +0 -7
  29. data/lib/knockapi/models/object_delete_response.rb +0 -7
  30. data/lib/knockapi/models/object_unset_channel_data_response.rb +0 -7
  31. data/lib/knockapi/models/tenant_delete_response.rb +0 -7
  32. data/lib/knockapi/models/user_delete_response.rb +0 -7
  33. data/lib/knockapi/models/user_unset_channel_data_response.rb +0 -7
  34. data/lib/knockapi/models/workflow_cancel_response.rb +0 -7
  35. data/rbi/knockapi/models/audience_add_members_response.rbi +0 -7
  36. data/rbi/knockapi/models/audience_remove_members_response.rbi +0 -7
  37. data/rbi/knockapi/models/object_delete_response.rbi +0 -7
  38. data/rbi/knockapi/models/object_unset_channel_data_response.rbi +0 -7
  39. data/rbi/knockapi/models/tenant_delete_response.rbi +0 -7
  40. data/rbi/knockapi/models/user_delete_response.rbi +0 -7
  41. data/rbi/knockapi/models/user_unset_channel_data_response.rbi +0 -7
  42. data/rbi/knockapi/models/workflow_cancel_response.rbi +0 -7
  43. data/sig/knockapi/models/audience_add_members_response.rbs +0 -5
  44. data/sig/knockapi/models/audience_remove_members_response.rbs +0 -5
  45. data/sig/knockapi/models/object_delete_response.rbs +0 -5
  46. data/sig/knockapi/models/object_unset_channel_data_response.rbs +0 -5
  47. data/sig/knockapi/models/tenant_delete_response.rbs +0 -5
  48. data/sig/knockapi/models/user_delete_response.rbs +0 -5
  49. data/sig/knockapi/models/user_unset_channel_data_response.rbs +0 -5
  50. data/sig/knockapi/models/workflow_cancel_response.rbs +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 705d1a2dcdf780d7381bfe2afd9f8fbcfeef3d3cf9d1de25c59e66312c99d240
4
- data.tar.gz: 4a3dc9e5f4099f91844cd93c557fccae11febdc4f1cfd54c4c024deff6e064f1
3
+ metadata.gz: 8d72e806e4aa7f07a86c10e93b8e6060c1da2860ab3d8af247e6c20e83bedacf
4
+ data.tar.gz: 49d2bd4bfe5cc74233d8549938819497bf410f7b2d5686cb8c2096c6f86d40db
5
5
  SHA512:
6
- metadata.gz: e48a5a4811a24450b63764ac62b67faf0c9ee514a9bc7d5911ec10ef46be833ba0667dcf5cf1369f72e10eb0663bdcda4794a007f2514496ff4de81184cb4180
7
- data.tar.gz: 30be4f558089c7e211ec922a4ffb75a53d7ad5bf851cafff8f628aff4cb0b1ffbe0732cf99363e971bd45218773c42d22469dcc3d397ec98b5570ec9871f0aa6
6
+ metadata.gz: 18b9a4fcab27e4ed869e66b8f189f3ddd780dbe6636eba4a29b143d1cc5362a4069812f55a65041b92b5a1820fe8be29b0b08dd16bfb791504b9e1b163d9cb00
7
+ data.tar.gz: 2c8f5226db4d52750c0905dfc38de19ba144cc771e4b4d9316972f7395641f22a09eebae4e0f63315d4d1450172d490502eed29a13e4959888a932529bfefa35
data/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.15.0 (2025-09-23)
4
+
5
+ Full Changelog: [v1.14.0...v1.15.0](https://github.com/knocklabs/knock-ruby/compare/v1.14.0...v1.15.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([9e20ef7](https://github.com/knocklabs/knock-ruby/commit/9e20ef78f55bd98a4a44ad32a85c63d5b0f7da97))
10
+ * **api:** api update ([f6a598f](https://github.com/knocklabs/knock-ruby/commit/f6a598f8caab8d8fadc652efa12ebbbc62a5d3dc))
11
+ * **api:** set idempotency key header by default ([14e4fac](https://github.com/knocklabs/knock-ruby/commit/14e4face034def9abbb45120d5c1af1cb415b689))
12
+
13
+
14
+ ### Chores
15
+
16
+ * improve example values ([3745058](https://github.com/knocklabs/knock-ruby/commit/37450588f7a937fec2ab49ab04c7142493c7d646))
17
+
3
18
  ## 1.14.0 (2025-09-19)
4
19
 
5
20
  Full Changelog: [v1.13.0...v1.14.0](https://github.com/knocklabs/knock-ruby/compare/v1.13.0...v1.14.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.14.0"
20
+ gem "knockapi", "~> 1.15.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -80,13 +80,16 @@ module Knockapi
80
80
  # @param initial_retry_delay [Float]
81
81
  #
82
82
  # @param max_retry_delay [Float]
83
+ #
84
+ # @param idempotency_header [String]
83
85
  def initialize(
84
86
  api_key: ENV["KNOCK_API_KEY"],
85
87
  base_url: ENV["KNOCK_BASE_URL"],
86
88
  max_retries: self.class::DEFAULT_MAX_RETRIES,
87
89
  timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
88
90
  initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
89
- max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
91
+ max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY,
92
+ idempotency_header: "Idempotency-Key"
90
93
  )
91
94
  base_url ||= "https://api.knock.app"
92
95
 
@@ -101,7 +104,8 @@ module Knockapi
101
104
  timeout: timeout,
102
105
  max_retries: max_retries,
103
106
  initial_retry_delay: initial_retry_delay,
104
- max_retry_delay: max_retry_delay
107
+ max_retry_delay: max_retry_delay,
108
+ idempotency_header: idempotency_header
105
109
  )
106
110
 
107
111
  @shared = Knockapi::Resources::Shared.new(client: self)
@@ -13,7 +13,7 @@ module Knockapi
13
13
  #
14
14
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
15
15
  #
16
- # @return [String]
16
+ # @return [nil]
17
17
  #
18
18
  # @see Knockapi::Models::AudienceAddMembersParams
19
19
  def add_members(key, params)
@@ -22,7 +22,7 @@ module Knockapi
22
22
  method: :post,
23
23
  path: ["v1/audiences/%1$s/members", key],
24
24
  body: parsed,
25
- model: String,
25
+ model: NilClass,
26
26
  options: options
27
27
  )
28
28
  end
@@ -57,7 +57,7 @@ module Knockapi
57
57
  #
58
58
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
59
59
  #
60
- # @return [String]
60
+ # @return [nil]
61
61
  #
62
62
  # @see Knockapi::Models::AudienceRemoveMembersParams
63
63
  def remove_members(key, params)
@@ -66,7 +66,7 @@ module Knockapi
66
66
  method: :delete,
67
67
  path: ["v1/audiences/%1$s/members", key],
68
68
  body: parsed,
69
- model: String,
69
+ model: NilClass,
70
70
  options: options
71
71
  )
72
72
  end
@@ -49,14 +49,14 @@ module Knockapi
49
49
  #
50
50
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
51
51
  #
52
- # @return [String]
52
+ # @return [nil]
53
53
  #
54
54
  # @see Knockapi::Models::ObjectDeleteParams
55
55
  def delete(collection, id, params = {})
56
56
  @client.request(
57
57
  method: :delete,
58
58
  path: ["v1/objects/%1$s/%2$s", collection, id],
59
- model: String,
59
+ model: NilClass,
60
60
  options: params[:request_options]
61
61
  )
62
62
  end
@@ -478,14 +478,14 @@ module Knockapi
478
478
  #
479
479
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
480
480
  #
481
- # @return [String]
481
+ # @return [nil]
482
482
  #
483
483
  # @see Knockapi::Models::ObjectUnsetChannelDataParams
484
484
  def unset_channel_data(collection, object_id_, channel_id, params = {})
485
485
  @client.request(
486
486
  method: :delete,
487
487
  path: ["v1/objects/%1$s/%2$s/channel_data/%3$s", collection, object_id_, channel_id],
488
- model: String,
488
+ model: NilClass,
489
489
  options: params[:request_options]
490
490
  )
491
491
  end
@@ -45,14 +45,14 @@ module Knockapi
45
45
  #
46
46
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
47
47
  #
48
- # @return [String]
48
+ # @return [nil]
49
49
  #
50
50
  # @see Knockapi::Models::TenantDeleteParams
51
51
  def delete(id, params = {})
52
52
  @client.request(
53
53
  method: :delete,
54
54
  path: ["v1/tenants/%1$s", id],
55
- model: String,
55
+ model: NilClass,
56
56
  options: params[:request_options]
57
57
  )
58
58
  end
@@ -41,7 +41,7 @@ module Knockapi
41
41
  #
42
42
  # @param user_id [String] The unique identifier of the user.
43
43
  #
44
- # @param message_id [String] The unique identifier for the message.
44
+ # @param message_id [String]
45
45
  #
46
46
  # @param channel_id [String] The unique identifier for the channel.
47
47
  #
@@ -84,7 +84,7 @@ module Knockapi
84
84
  #
85
85
  # @param user_id [String] The unique identifier of the user.
86
86
  #
87
- # @param message_id [String] The unique identifier for the message.
87
+ # @param message_id [String]
88
88
  #
89
89
  # @param channel_id [String] The unique identifier for the channel.
90
90
  #
@@ -127,7 +127,7 @@ module Knockapi
127
127
  #
128
128
  # @param user_id [String] The unique identifier of the user.
129
129
  #
130
- # @param message_id [String] The unique identifier for the message.
130
+ # @param message_id [String]
131
131
  #
132
132
  # @param channel_id [String] The unique identifier for the channel.
133
133
  #
@@ -95,14 +95,14 @@ module Knockapi
95
95
  #
96
96
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
97
97
  #
98
- # @return [String]
98
+ # @return [nil]
99
99
  #
100
100
  # @see Knockapi::Models::UserDeleteParams
101
101
  def delete(user_id, params = {})
102
102
  @client.request(
103
103
  method: :delete,
104
104
  path: ["v1/users/%1$s", user_id],
105
- model: String,
105
+ model: NilClass,
106
106
  options: params[:request_options]
107
107
  )
108
108
  end
@@ -420,14 +420,14 @@ module Knockapi
420
420
  #
421
421
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
422
422
  #
423
- # @return [String]
423
+ # @return [nil]
424
424
  #
425
425
  # @see Knockapi::Models::UserUnsetChannelDataParams
426
426
  def unset_channel_data(user_id, channel_id, params = {})
427
427
  @client.request(
428
428
  method: :delete,
429
429
  path: ["v1/users/%1$s/channel_data/%2$s", user_id, channel_id],
430
- model: String,
430
+ model: NilClass,
431
431
  options: params[:request_options]
432
432
  )
433
433
  end
@@ -20,7 +20,7 @@ module Knockapi
20
20
  #
21
21
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
22
22
  #
23
- # @return [String]
23
+ # @return [nil]
24
24
  #
25
25
  # @see Knockapi::Models::WorkflowCancelParams
26
26
  def cancel(key, params)
@@ -29,7 +29,7 @@ module Knockapi
29
29
  method: :post,
30
30
  path: ["v1/workflows/%1$s/cancel", key],
31
31
  body: parsed,
32
- model: String,
32
+ model: NilClass,
33
33
  options: options
34
34
  )
35
35
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Knockapi
4
- VERSION = "1.14.0"
4
+ VERSION = "1.15.0"
5
5
  end
data/lib/knockapi.rb CHANGED
@@ -59,12 +59,10 @@ require_relative "knockapi/models/recipients/preference_set_request"
59
59
  require_relative "knockapi/models/identify_user_request"
60
60
  require_relative "knockapi/models/activity"
61
61
  require_relative "knockapi/models/audience_add_members_params"
62
- require_relative "knockapi/models/audience_add_members_response"
63
62
  require_relative "knockapi/models/audience_list_members_params"
64
63
  require_relative "knockapi/models/audience_list_members_response"
65
64
  require_relative "knockapi/models/audience_member"
66
65
  require_relative "knockapi/models/audience_remove_members_params"
67
- require_relative "knockapi/models/audience_remove_members_response"
68
66
  require_relative "knockapi/models/bulk_operation"
69
67
  require_relative "knockapi/models/bulk_operation_get_params"
70
68
  require_relative "knockapi/models/channels/bulk_update_message_status_params"
@@ -113,7 +111,6 @@ require_relative "knockapi/models/object"
113
111
  require_relative "knockapi/models/object_add_subscriptions_params"
114
112
  require_relative "knockapi/models/object_add_subscriptions_response"
115
113
  require_relative "knockapi/models/object_delete_params"
116
- require_relative "knockapi/models/object_delete_response"
117
114
  require_relative "knockapi/models/object_delete_subscriptions_params"
118
115
  require_relative "knockapi/models/object_delete_subscriptions_response"
119
116
  require_relative "knockapi/models/object_get_channel_data_params"
@@ -132,7 +129,6 @@ require_relative "knockapi/models/object_set_channel_data_params"
132
129
  require_relative "knockapi/models/object_set_params"
133
130
  require_relative "knockapi/models/object_set_preferences_params"
134
131
  require_relative "knockapi/models/object_unset_channel_data_params"
135
- require_relative "knockapi/models/object_unset_channel_data_response"
136
132
  require_relative "knockapi/models/page_info"
137
133
  require_relative "knockapi/models/providers/ms_team_check_auth_params"
138
134
  require_relative "knockapi/models/providers/ms_team_check_auth_response"
@@ -175,7 +171,6 @@ require_relative "knockapi/models/schedule_update_params"
175
171
  require_relative "knockapi/models/schedule_update_response"
176
172
  require_relative "knockapi/models/tenant"
177
173
  require_relative "knockapi/models/tenant_delete_params"
178
- require_relative "knockapi/models/tenant_delete_response"
179
174
  require_relative "knockapi/models/tenant_get_params"
180
175
  require_relative "knockapi/models/tenant_list_params"
181
176
  require_relative "knockapi/models/tenant_request"
@@ -184,7 +179,6 @@ require_relative "knockapi/models/tenants/bulk_set_params"
184
179
  require_relative "knockapi/models/tenant_set_params"
185
180
  require_relative "knockapi/models/user"
186
181
  require_relative "knockapi/models/user_delete_params"
187
- require_relative "knockapi/models/user_delete_response"
188
182
  require_relative "knockapi/models/user_get_channel_data_params"
189
183
  require_relative "knockapi/models/user_get_params"
190
184
  require_relative "knockapi/models/user_get_preferences_params"
@@ -213,10 +207,8 @@ require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
213
207
  require_relative "knockapi/models/user_set_channel_data_params"
214
208
  require_relative "knockapi/models/user_set_preferences_params"
215
209
  require_relative "knockapi/models/user_unset_channel_data_params"
216
- require_relative "knockapi/models/user_unset_channel_data_response"
217
210
  require_relative "knockapi/models/user_update_params"
218
211
  require_relative "knockapi/models/workflow_cancel_params"
219
- require_relative "knockapi/models/workflow_cancel_response"
220
212
  require_relative "knockapi/models/workflow_trigger_params"
221
213
  require_relative "knockapi/models/workflow_trigger_response"
222
214
  require_relative "knockapi/models"
@@ -65,7 +65,8 @@ module Knockapi
65
65
  max_retries: Integer,
66
66
  timeout: Float,
67
67
  initial_retry_delay: Float,
68
- max_retry_delay: Float
68
+ max_retry_delay: Float,
69
+ idempotency_header: String
69
70
  ).returns(T.attached_class)
70
71
  end
71
72
  def self.new(
@@ -78,7 +79,8 @@ module Knockapi
78
79
  max_retries: Knockapi::Client::DEFAULT_MAX_RETRIES,
79
80
  timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
80
81
  initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
81
- max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
82
+ max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY,
83
+ idempotency_header: "Idempotency-Key"
82
84
  )
83
85
  end
84
86
  end
@@ -9,7 +9,7 @@ module Knockapi
9
9
  key: String,
10
10
  members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
11
11
  request_options: Knockapi::RequestOptions::OrHash
12
- ).returns(String)
12
+ ).void
13
13
  end
14
14
  def add_members(
15
15
  # The key of the audience.
@@ -41,7 +41,7 @@ module Knockapi
41
41
  members:
42
42
  T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
43
43
  request_options: Knockapi::RequestOptions::OrHash
44
- ).returns(String)
44
+ ).void
45
45
  end
46
46
  def remove_members(
47
47
  # The key of the audience.
@@ -40,7 +40,7 @@ module Knockapi
40
40
  collection: String,
41
41
  id: String,
42
42
  request_options: Knockapi::RequestOptions::OrHash
43
- ).returns(String)
43
+ ).void
44
44
  end
45
45
  def delete(
46
46
  # The collection this object belongs to.
@@ -493,7 +493,7 @@ module Knockapi
493
493
  object_id_: String,
494
494
  channel_id: String,
495
495
  request_options: Knockapi::RequestOptions::OrHash
496
- ).returns(String)
496
+ ).void
497
497
  end
498
498
  def unset_channel_data(
499
499
  # The collection this object belongs to.
@@ -37,7 +37,7 @@ module Knockapi
37
37
  params(
38
38
  id: String,
39
39
  request_options: Knockapi::RequestOptions::OrHash
40
- ).returns(String)
40
+ ).void
41
41
  end
42
42
  def delete(
43
43
  # The unique identifier for the tenant.
@@ -51,7 +51,6 @@ module Knockapi
51
51
  def mark_message_as_archived(
52
52
  # The unique identifier of the user.
53
53
  user_id,
54
- # The unique identifier for the message.
55
54
  message_id,
56
55
  # The unique identifier for the channel.
57
56
  channel_id:,
@@ -98,7 +97,6 @@ module Knockapi
98
97
  def mark_message_as_interacted(
99
98
  # The unique identifier of the user.
100
99
  user_id,
101
- # The unique identifier for the message.
102
100
  message_id,
103
101
  # The unique identifier for the channel.
104
102
  channel_id:,
@@ -143,7 +141,6 @@ module Knockapi
143
141
  def mark_message_as_seen(
144
142
  # The unique identifier of the user.
145
143
  user_id,
146
- # The unique identifier for the message.
147
144
  message_id,
148
145
  # The unique identifier for the channel.
149
146
  channel_id:,
@@ -109,7 +109,7 @@ module Knockapi
109
109
  params(
110
110
  user_id: String,
111
111
  request_options: Knockapi::RequestOptions::OrHash
112
- ).returns(String)
112
+ ).void
113
113
  end
114
114
  def delete(
115
115
  # The ID of the user to delete.
@@ -425,7 +425,7 @@ module Knockapi
425
425
  user_id: String,
426
426
  channel_id: String,
427
427
  request_options: Knockapi::RequestOptions::OrHash
428
- ).returns(String)
428
+ ).void
429
429
  end
430
430
  def unset_channel_data(
431
431
  # The unique identifier of the user.
@@ -20,7 +20,7 @@ module Knockapi
20
20
  ]
21
21
  ),
22
22
  request_options: Knockapi::RequestOptions::OrHash
23
- ).returns(String)
23
+ ).void
24
24
  end
25
25
  def cancel(
26
26
  # The key of the workflow to cancel.
@@ -44,7 +44,8 @@ module Knockapi
44
44
  ?max_retries: Integer,
45
45
  ?timeout: Float,
46
46
  ?initial_retry_delay: Float,
47
- ?max_retry_delay: Float
47
+ ?max_retry_delay: Float,
48
+ ?idempotency_header: String
48
49
  ) -> void
49
50
  end
50
51
  end
@@ -5,7 +5,7 @@ module Knockapi
5
5
  String key,
6
6
  members: ::Array[Knockapi::AudienceAddMembersParams::Member],
7
7
  ?request_options: Knockapi::request_opts
8
- ) -> String
8
+ ) -> nil
9
9
 
10
10
  def list_members: (
11
11
  String key,
@@ -16,7 +16,7 @@ module Knockapi
16
16
  String key,
17
17
  members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
18
18
  ?request_options: Knockapi::request_opts
19
- ) -> String
19
+ ) -> nil
20
20
 
21
21
  def initialize: (client: Knockapi::Client) -> void
22
22
  end
@@ -16,7 +16,7 @@ module Knockapi
16
16
  String collection,
17
17
  String id,
18
18
  ?request_options: Knockapi::request_opts
19
- ) -> String
19
+ ) -> nil
20
20
 
21
21
  def add_subscriptions: (
22
22
  String collection,
@@ -137,7 +137,7 @@ module Knockapi
137
137
  String object_id_,
138
138
  String channel_id,
139
139
  ?request_options: Knockapi::request_opts
140
- ) -> String
140
+ ) -> nil
141
141
 
142
142
  def initialize: (client: Knockapi::Client) -> void
143
143
  end
@@ -12,10 +12,7 @@ module Knockapi
12
12
  ?request_options: Knockapi::request_opts
13
13
  ) -> Knockapi::Internal::EntriesCursor[Knockapi::Tenant]
14
14
 
15
- def delete: (
16
- String id,
17
- ?request_options: Knockapi::request_opts
18
- ) -> String
15
+ def delete: (String id, ?request_options: Knockapi::request_opts) -> nil
19
16
 
20
17
  def get: (
21
18
  String id,
@@ -32,7 +32,7 @@ module Knockapi
32
32
  def delete: (
33
33
  String user_id,
34
34
  ?request_options: Knockapi::request_opts
35
- ) -> String
35
+ ) -> nil
36
36
 
37
37
  def get: (
38
38
  String user_id,
@@ -123,7 +123,7 @@ module Knockapi
123
123
  String user_id,
124
124
  String channel_id,
125
125
  ?request_options: Knockapi::request_opts
126
- ) -> String
126
+ ) -> nil
127
127
 
128
128
  def initialize: (client: Knockapi::Client) -> void
129
129
  end
@@ -6,7 +6,7 @@ module Knockapi
6
6
  cancellation_key: String,
7
7
  ?recipients: ::Array[Knockapi::Models::recipient_reference]?,
8
8
  ?request_options: Knockapi::request_opts
9
- ) -> String
9
+ ) -> nil
10
10
 
11
11
  def trigger: (
12
12
  String key,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: knockapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.14.0
4
+ version: 1.15.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Knock
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-09-19 00:00:00.000000000 Z
11
+ date: 2025-09-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool
@@ -61,12 +61,10 @@ files:
61
61
  - lib/knockapi/models.rb
62
62
  - lib/knockapi/models/activity.rb
63
63
  - lib/knockapi/models/audience_add_members_params.rb
64
- - lib/knockapi/models/audience_add_members_response.rb
65
64
  - lib/knockapi/models/audience_list_members_params.rb
66
65
  - lib/knockapi/models/audience_list_members_response.rb
67
66
  - lib/knockapi/models/audience_member.rb
68
67
  - lib/knockapi/models/audience_remove_members_params.rb
69
- - lib/knockapi/models/audience_remove_members_response.rb
70
68
  - lib/knockapi/models/bulk_operation.rb
71
69
  - lib/knockapi/models/bulk_operation_get_params.rb
72
70
  - lib/knockapi/models/channels/bulk_update_message_status_params.rb
@@ -116,7 +114,6 @@ files:
116
114
  - lib/knockapi/models/object_add_subscriptions_params.rb
117
115
  - lib/knockapi/models/object_add_subscriptions_response.rb
118
116
  - lib/knockapi/models/object_delete_params.rb
119
- - lib/knockapi/models/object_delete_response.rb
120
117
  - lib/knockapi/models/object_delete_subscriptions_params.rb
121
118
  - lib/knockapi/models/object_delete_subscriptions_response.rb
122
119
  - lib/knockapi/models/object_get_channel_data_params.rb
@@ -132,7 +129,6 @@ files:
132
129
  - lib/knockapi/models/object_set_params.rb
133
130
  - lib/knockapi/models/object_set_preferences_params.rb
134
131
  - lib/knockapi/models/object_unset_channel_data_params.rb
135
- - lib/knockapi/models/object_unset_channel_data_response.rb
136
132
  - lib/knockapi/models/objects/bulk_add_subscriptions_params.rb
137
133
  - lib/knockapi/models/objects/bulk_delete_params.rb
138
134
  - lib/knockapi/models/objects/bulk_set_params.rb
@@ -180,7 +176,6 @@ files:
180
176
  - lib/knockapi/models/schedules/bulk_create_params.rb
181
177
  - lib/knockapi/models/tenant.rb
182
178
  - lib/knockapi/models/tenant_delete_params.rb
183
- - lib/knockapi/models/tenant_delete_response.rb
184
179
  - lib/knockapi/models/tenant_get_params.rb
185
180
  - lib/knockapi/models/tenant_list_params.rb
186
181
  - lib/knockapi/models/tenant_request.rb
@@ -189,7 +184,6 @@ files:
189
184
  - lib/knockapi/models/tenants/bulk_set_params.rb
190
185
  - lib/knockapi/models/user.rb
191
186
  - lib/knockapi/models/user_delete_params.rb
192
- - lib/knockapi/models/user_delete_response.rb
193
187
  - lib/knockapi/models/user_get_channel_data_params.rb
194
188
  - lib/knockapi/models/user_get_params.rb
195
189
  - lib/knockapi/models/user_get_preferences_params.rb
@@ -203,7 +197,6 @@ files:
203
197
  - lib/knockapi/models/user_set_channel_data_params.rb
204
198
  - lib/knockapi/models/user_set_preferences_params.rb
205
199
  - lib/knockapi/models/user_unset_channel_data_params.rb
206
- - lib/knockapi/models/user_unset_channel_data_response.rb
207
200
  - lib/knockapi/models/user_update_params.rb
208
201
  - lib/knockapi/models/users/bulk_delete_params.rb
209
202
  - lib/knockapi/models/users/bulk_identify_params.rb
@@ -221,7 +214,6 @@ files:
221
214
  - lib/knockapi/models/users/guide_mark_message_as_seen_params.rb
222
215
  - lib/knockapi/models/users/guide_mark_message_as_seen_response.rb
223
216
  - lib/knockapi/models/workflow_cancel_params.rb
224
- - lib/knockapi/models/workflow_cancel_response.rb
225
217
  - lib/knockapi/models/workflow_trigger_params.rb
226
218
  - lib/knockapi/models/workflow_trigger_response.rb
227
219
  - lib/knockapi/request_options.rb
@@ -280,12 +272,10 @@ files:
280
272
  - rbi/knockapi/models.rbi
281
273
  - rbi/knockapi/models/activity.rbi
282
274
  - rbi/knockapi/models/audience_add_members_params.rbi
283
- - rbi/knockapi/models/audience_add_members_response.rbi
284
275
  - rbi/knockapi/models/audience_list_members_params.rbi
285
276
  - rbi/knockapi/models/audience_list_members_response.rbi
286
277
  - rbi/knockapi/models/audience_member.rbi
287
278
  - rbi/knockapi/models/audience_remove_members_params.rbi
288
- - rbi/knockapi/models/audience_remove_members_response.rbi
289
279
  - rbi/knockapi/models/bulk_operation.rbi
290
280
  - rbi/knockapi/models/bulk_operation_get_params.rbi
291
281
  - rbi/knockapi/models/channels/bulk_update_message_status_params.rbi
@@ -335,7 +325,6 @@ files:
335
325
  - rbi/knockapi/models/object_add_subscriptions_params.rbi
336
326
  - rbi/knockapi/models/object_add_subscriptions_response.rbi
337
327
  - rbi/knockapi/models/object_delete_params.rbi
338
- - rbi/knockapi/models/object_delete_response.rbi
339
328
  - rbi/knockapi/models/object_delete_subscriptions_params.rbi
340
329
  - rbi/knockapi/models/object_delete_subscriptions_response.rbi
341
330
  - rbi/knockapi/models/object_get_channel_data_params.rbi
@@ -351,7 +340,6 @@ files:
351
340
  - rbi/knockapi/models/object_set_params.rbi
352
341
  - rbi/knockapi/models/object_set_preferences_params.rbi
353
342
  - rbi/knockapi/models/object_unset_channel_data_params.rbi
354
- - rbi/knockapi/models/object_unset_channel_data_response.rbi
355
343
  - rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi
356
344
  - rbi/knockapi/models/objects/bulk_delete_params.rbi
357
345
  - rbi/knockapi/models/objects/bulk_set_params.rbi
@@ -399,7 +387,6 @@ files:
399
387
  - rbi/knockapi/models/schedules/bulk_create_params.rbi
400
388
  - rbi/knockapi/models/tenant.rbi
401
389
  - rbi/knockapi/models/tenant_delete_params.rbi
402
- - rbi/knockapi/models/tenant_delete_response.rbi
403
390
  - rbi/knockapi/models/tenant_get_params.rbi
404
391
  - rbi/knockapi/models/tenant_list_params.rbi
405
392
  - rbi/knockapi/models/tenant_request.rbi
@@ -408,7 +395,6 @@ files:
408
395
  - rbi/knockapi/models/tenants/bulk_set_params.rbi
409
396
  - rbi/knockapi/models/user.rbi
410
397
  - rbi/knockapi/models/user_delete_params.rbi
411
- - rbi/knockapi/models/user_delete_response.rbi
412
398
  - rbi/knockapi/models/user_get_channel_data_params.rbi
413
399
  - rbi/knockapi/models/user_get_params.rbi
414
400
  - rbi/knockapi/models/user_get_preferences_params.rbi
@@ -422,7 +408,6 @@ files:
422
408
  - rbi/knockapi/models/user_set_channel_data_params.rbi
423
409
  - rbi/knockapi/models/user_set_preferences_params.rbi
424
410
  - rbi/knockapi/models/user_unset_channel_data_params.rbi
425
- - rbi/knockapi/models/user_unset_channel_data_response.rbi
426
411
  - rbi/knockapi/models/user_update_params.rbi
427
412
  - rbi/knockapi/models/users/bulk_delete_params.rbi
428
413
  - rbi/knockapi/models/users/bulk_identify_params.rbi
@@ -440,7 +425,6 @@ files:
440
425
  - rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi
441
426
  - rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi
442
427
  - rbi/knockapi/models/workflow_cancel_params.rbi
443
- - rbi/knockapi/models/workflow_cancel_response.rbi
444
428
  - rbi/knockapi/models/workflow_trigger_params.rbi
445
429
  - rbi/knockapi/models/workflow_trigger_response.rbi
446
430
  - rbi/knockapi/request_options.rbi
@@ -498,12 +482,10 @@ files:
498
482
  - sig/knockapi/models.rbs
499
483
  - sig/knockapi/models/activity.rbs
500
484
  - sig/knockapi/models/audience_add_members_params.rbs
501
- - sig/knockapi/models/audience_add_members_response.rbs
502
485
  - sig/knockapi/models/audience_list_members_params.rbs
503
486
  - sig/knockapi/models/audience_list_members_response.rbs
504
487
  - sig/knockapi/models/audience_member.rbs
505
488
  - sig/knockapi/models/audience_remove_members_params.rbs
506
- - sig/knockapi/models/audience_remove_members_response.rbs
507
489
  - sig/knockapi/models/bulk_operation.rbs
508
490
  - sig/knockapi/models/bulk_operation_get_params.rbs
509
491
  - sig/knockapi/models/channels/bulk_update_message_status_params.rbs
@@ -553,7 +535,6 @@ files:
553
535
  - sig/knockapi/models/object_add_subscriptions_params.rbs
554
536
  - sig/knockapi/models/object_add_subscriptions_response.rbs
555
537
  - sig/knockapi/models/object_delete_params.rbs
556
- - sig/knockapi/models/object_delete_response.rbs
557
538
  - sig/knockapi/models/object_delete_subscriptions_params.rbs
558
539
  - sig/knockapi/models/object_delete_subscriptions_response.rbs
559
540
  - sig/knockapi/models/object_get_channel_data_params.rbs
@@ -569,7 +550,6 @@ files:
569
550
  - sig/knockapi/models/object_set_params.rbs
570
551
  - sig/knockapi/models/object_set_preferences_params.rbs
571
552
  - sig/knockapi/models/object_unset_channel_data_params.rbs
572
- - sig/knockapi/models/object_unset_channel_data_response.rbs
573
553
  - sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs
574
554
  - sig/knockapi/models/objects/bulk_delete_params.rbs
575
555
  - sig/knockapi/models/objects/bulk_set_params.rbs
@@ -617,7 +597,6 @@ files:
617
597
  - sig/knockapi/models/schedules/bulk_create_params.rbs
618
598
  - sig/knockapi/models/tenant.rbs
619
599
  - sig/knockapi/models/tenant_delete_params.rbs
620
- - sig/knockapi/models/tenant_delete_response.rbs
621
600
  - sig/knockapi/models/tenant_get_params.rbs
622
601
  - sig/knockapi/models/tenant_list_params.rbs
623
602
  - sig/knockapi/models/tenant_request.rbs
@@ -626,7 +605,6 @@ files:
626
605
  - sig/knockapi/models/tenants/bulk_set_params.rbs
627
606
  - sig/knockapi/models/user.rbs
628
607
  - sig/knockapi/models/user_delete_params.rbs
629
- - sig/knockapi/models/user_delete_response.rbs
630
608
  - sig/knockapi/models/user_get_channel_data_params.rbs
631
609
  - sig/knockapi/models/user_get_params.rbs
632
610
  - sig/knockapi/models/user_get_preferences_params.rbs
@@ -640,7 +618,6 @@ files:
640
618
  - sig/knockapi/models/user_set_channel_data_params.rbs
641
619
  - sig/knockapi/models/user_set_preferences_params.rbs
642
620
  - sig/knockapi/models/user_unset_channel_data_params.rbs
643
- - sig/knockapi/models/user_unset_channel_data_response.rbs
644
621
  - sig/knockapi/models/user_update_params.rbs
645
622
  - sig/knockapi/models/users/bulk_delete_params.rbs
646
623
  - sig/knockapi/models/users/bulk_identify_params.rbs
@@ -658,7 +635,6 @@ files:
658
635
  - sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs
659
636
  - sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs
660
637
  - sig/knockapi/models/workflow_cancel_params.rbs
661
- - sig/knockapi/models/workflow_cancel_response.rbs
662
638
  - sig/knockapi/models/workflow_trigger_params.rbs
663
639
  - sig/knockapi/models/workflow_trigger_response.rbs
664
640
  - sig/knockapi/request_options.rbs
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- AudienceAddMembersResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- AudienceRemoveMembersResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- ObjectDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- ObjectUnsetChannelDataResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- TenantDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- UserDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- UserUnsetChannelDataResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Knockapi
4
- module Models
5
- WorkflowCancelResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- AudienceAddMembersResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- AudienceRemoveMembersResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- ObjectDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- ObjectUnsetChannelDataResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- TenantDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- UserDeleteResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- UserUnsetChannelDataResponse = String
6
- end
7
- end
@@ -1,7 +0,0 @@
1
- # typed: strong
2
-
3
- module Knockapi
4
- module Models
5
- WorkflowCancelResponse = String
6
- end
7
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class AudienceAddMembersResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class AudienceRemoveMembersResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class ObjectDeleteResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class ObjectUnsetChannelDataResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class TenantDeleteResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class UserDeleteResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class UserUnsetChannelDataResponse = String
4
- end
5
- end
@@ -1,5 +0,0 @@
1
- module Knockapi
2
- module Models
3
- class WorkflowCancelResponse = String
4
- end
5
- end