knockapi 1.18.0 → 1.19.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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/client.rb +12 -0
  5. data/lib/knockapi/internal/transport/base_client.rb +7 -1
  6. data/lib/knockapi/internal/transport/pooled_net_requester.rb +6 -2
  7. data/lib/knockapi/models/identify_user_request.rb +2 -2
  8. data/lib/knockapi/models/inline_identify_user_request.rb +2 -2
  9. data/lib/knockapi/models/inline_object_request.rb +11 -3
  10. data/lib/knockapi/models/object_set_params.rb +11 -3
  11. data/lib/knockapi/models/objects/bulk_set_params.rb +11 -3
  12. data/lib/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rb +63 -0
  13. data/lib/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rb +25 -0
  14. data/lib/knockapi/models/recipients/channel_data.rb +4 -17
  15. data/lib/knockapi/models/recipients/channel_data_request.rb +8 -162
  16. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +6 -160
  17. data/lib/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rb +20 -0
  18. data/lib/knockapi/models/recipients/preference_set.rb +12 -54
  19. data/lib/knockapi/models/recipients/preference_set_channel_setting.rb +21 -0
  20. data/lib/knockapi/models/recipients/preference_set_request.rb +12 -54
  21. data/lib/knockapi/models/recipients/push_channel_data_devices_only.rb +60 -0
  22. data/lib/knockapi/models/recipients/push_channel_data_tokens_only.rb +20 -0
  23. data/lib/knockapi/models/tenant_request.rb +11 -3
  24. data/lib/knockapi/models/tenant_set_params.rb +11 -3
  25. data/lib/knockapi/models/users/feed_list_items_params.rb +15 -1
  26. data/lib/knockapi/resources/objects.rb +6 -4
  27. data/lib/knockapi/resources/tenants.rb +4 -2
  28. data/lib/knockapi/resources/users/feeds.rb +6 -1
  29. data/lib/knockapi/resources/users.rb +3 -3
  30. data/lib/knockapi/version.rb +1 -1
  31. data/lib/knockapi.rb +7 -0
  32. data/manifest.yaml +1 -0
  33. data/rbi/knockapi/client.rbi +7 -0
  34. data/rbi/knockapi/internal/transport/base_client.rbi +5 -0
  35. data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +6 -2
  36. data/rbi/knockapi/internal/type/base_model.rbi +8 -4
  37. data/rbi/knockapi/models/identify_user_request.rbi +15 -15
  38. data/rbi/knockapi/models/inline_identify_user_request.rbi +15 -15
  39. data/rbi/knockapi/models/inline_object_request.rbi +23 -15
  40. data/rbi/knockapi/models/object_set_params.rbi +28 -20
  41. data/rbi/knockapi/models/objects/bulk_set_params.rbi +23 -15
  42. data/rbi/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbi +120 -0
  43. data/rbi/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbi +35 -0
  44. data/rbi/knockapi/models/recipients/channel_data.rbi +2 -30
  45. data/rbi/knockapi/models/recipients/channel_data_request.rbi +20 -326
  46. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +5 -309
  47. data/rbi/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbi +33 -0
  48. data/rbi/knockapi/models/recipients/preference_set.rbi +6 -109
  49. data/rbi/knockapi/models/recipients/preference_set_channel_setting.rbi +38 -0
  50. data/rbi/knockapi/models/recipients/preference_set_request.rbi +12 -115
  51. data/rbi/knockapi/models/recipients/push_channel_data_devices_only.rbi +114 -0
  52. data/rbi/knockapi/models/recipients/push_channel_data_tokens_only.rbi +33 -0
  53. data/rbi/knockapi/models/tenant_request.rbi +23 -15
  54. data/rbi/knockapi/models/tenant_set_params.rbi +23 -15
  55. data/rbi/knockapi/models/users/feed_list_items_params.rbi +17 -0
  56. data/rbi/knockapi/resources/objects.rbi +14 -11
  57. data/rbi/knockapi/resources/tenants.rbi +8 -5
  58. data/rbi/knockapi/resources/users/feeds.rbi +6 -0
  59. data/rbi/knockapi/resources/users.rbi +11 -11
  60. data/sig/knockapi/client.rbs +3 -0
  61. data/sig/knockapi/internal/transport/base_client.rbs +2 -0
  62. data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -1
  63. data/sig/knockapi/models/inline_object_request.rbs +5 -0
  64. data/sig/knockapi/models/object_set_params.rbs +5 -0
  65. data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
  66. data/sig/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbs +44 -0
  67. data/sig/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbs +16 -0
  68. data/sig/knockapi/models/recipients/channel_data.rbs +1 -12
  69. data/sig/knockapi/models/recipients/channel_data_request.rbs +5 -116
  70. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +5 -116
  71. data/sig/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbs +16 -0
  72. data/sig/knockapi/models/recipients/preference_set.rbs +3 -44
  73. data/sig/knockapi/models/recipients/preference_set_channel_setting.rbs +16 -0
  74. data/sig/knockapi/models/recipients/preference_set_request.rbs +3 -44
  75. data/sig/knockapi/models/recipients/push_channel_data_devices_only.rbs +40 -0
  76. data/sig/knockapi/models/recipients/push_channel_data_tokens_only.rbs +15 -0
  77. data/sig/knockapi/models/tenant_request.rbs +5 -0
  78. data/sig/knockapi/models/tenant_set_params.rbs +5 -0
  79. data/sig/knockapi/models/users/feed_list_items_params.rbs +7 -0
  80. data/sig/knockapi/resources/objects.rbs +1 -0
  81. data/sig/knockapi/resources/tenants.rbs +1 -0
  82. data/sig/knockapi/resources/users/feeds.rbs +1 -0
  83. metadata +20 -2
@@ -91,25 +91,11 @@ module Knockapi
91
91
  }
92
92
 
93
93
  type channel =
94
- bool
95
- | Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting
94
+ bool | Knockapi::Recipients::PreferenceSetChannelSetting
96
95
 
97
96
  module Channel
98
97
  extend Knockapi::Internal::Type::Union
99
98
 
100
- type preference_set_channel_setting =
101
- { conditions: ::Array[Knockapi::Condition] }
102
-
103
- class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
104
- attr_accessor conditions: ::Array[Knockapi::Condition]
105
-
106
- def initialize: (
107
- conditions: ::Array[Knockapi::Condition]
108
- ) -> void
109
-
110
- def to_hash: -> { conditions: ::Array[Knockapi::Condition] }
111
- end
112
-
113
99
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::channel]
114
100
  end
115
101
  end
@@ -117,24 +103,11 @@ module Knockapi
117
103
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::category]
118
104
  end
119
105
 
120
- type channel =
121
- bool
122
- | Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting
106
+ type channel = bool | Knockapi::Recipients::PreferenceSetChannelSetting
123
107
 
124
108
  module Channel
125
109
  extend Knockapi::Internal::Type::Union
126
110
 
127
- type preference_set_channel_setting =
128
- { conditions: ::Array[Knockapi::Condition] }
129
-
130
- class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
131
- attr_accessor conditions: ::Array[Knockapi::Condition]
132
-
133
- def initialize: (conditions: ::Array[Knockapi::Condition]) -> void
134
-
135
- def to_hash: -> { conditions: ::Array[Knockapi::Condition] }
136
- end
137
-
138
111
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::channel]
139
112
  end
140
113
 
@@ -172,25 +145,11 @@ module Knockapi
172
145
  }
173
146
 
174
147
  type channel =
175
- bool
176
- | Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting
148
+ bool | Knockapi::Recipients::PreferenceSetChannelSetting
177
149
 
178
150
  module Channel
179
151
  extend Knockapi::Internal::Type::Union
180
152
 
181
- type preference_set_channel_setting =
182
- { conditions: ::Array[Knockapi::Condition] }
183
-
184
- class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
185
- attr_accessor conditions: ::Array[Knockapi::Condition]
186
-
187
- def initialize: (
188
- conditions: ::Array[Knockapi::Condition]
189
- ) -> void
190
-
191
- def to_hash: -> { conditions: ::Array[Knockapi::Condition] }
192
- end
193
-
194
153
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::channel]
195
154
  end
196
155
  end
@@ -0,0 +1,40 @@
1
+ module Knockapi
2
+ module Models
3
+ module Recipients
4
+ type push_channel_data_devices_only =
5
+ {
6
+ devices: ::Array[Knockapi::Recipients::PushChannelDataDevicesOnly::Device]
7
+ }
8
+
9
+ class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
10
+ attr_accessor devices: ::Array[Knockapi::Recipients::PushChannelDataDevicesOnly::Device]
11
+
12
+ def initialize: (
13
+ devices: ::Array[Knockapi::Recipients::PushChannelDataDevicesOnly::Device]
14
+ ) -> void
15
+
16
+ def to_hash: -> {
17
+ devices: ::Array[Knockapi::Recipients::PushChannelDataDevicesOnly::Device]
18
+ }
19
+
20
+ type device = { token: String, locale: String?, timezone: String? }
21
+
22
+ class Device < Knockapi::Internal::Type::BaseModel
23
+ attr_accessor token: String
24
+
25
+ attr_accessor locale: String?
26
+
27
+ attr_accessor timezone: String?
28
+
29
+ def initialize: (
30
+ token: String,
31
+ ?locale: String?,
32
+ ?timezone: String?
33
+ ) -> void
34
+
35
+ def to_hash: -> { token: String, locale: String?, timezone: String? }
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,15 @@
1
+ module Knockapi
2
+ module Models
3
+ module Recipients
4
+ type push_channel_data_tokens_only = { tokens: ::Array[String] }
5
+
6
+ class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
7
+ attr_accessor tokens: ::Array[String]
8
+
9
+ def initialize: (tokens: ::Array[String]) -> void
10
+
11
+ def to_hash: -> { tokens: ::Array[String] }
12
+ end
13
+ end
14
+ end
15
+ end
@@ -4,6 +4,7 @@ module Knockapi
4
4
  {
5
5
  id: String,
6
6
  channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
7
+ name: String?,
7
8
  preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
8
9
  settings: Knockapi::TenantRequest::Settings
9
10
  }
@@ -13,6 +14,8 @@ module Knockapi
13
14
 
14
15
  attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
15
16
 
17
+ attr_accessor name: String?
18
+
16
19
  attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
17
20
 
18
21
  attr_reader settings: Knockapi::TenantRequest::Settings?
@@ -24,6 +27,7 @@ module Knockapi
24
27
  def initialize: (
25
28
  id: String,
26
29
  ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
30
+ ?name: String?,
27
31
  ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
28
32
  ?settings: Knockapi::TenantRequest::Settings
29
33
  ) -> void
@@ -31,6 +35,7 @@ module Knockapi
31
35
  def to_hash: -> {
32
36
  id: String,
33
37
  channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
38
+ name: String?,
34
39
  preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
35
40
  settings: Knockapi::TenantRequest::Settings
36
41
  }
@@ -3,6 +3,7 @@ module Knockapi
3
3
  type tenant_set_params =
4
4
  {
5
5
  channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
6
+ name: String?,
6
7
  settings: Knockapi::TenantSetParams::Settings
7
8
  }
8
9
  & Knockapi::Internal::Type::request_parameters
@@ -13,6 +14,8 @@ module Knockapi
13
14
 
14
15
  attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
15
16
 
17
+ attr_accessor name: String?
18
+
16
19
  attr_reader settings: Knockapi::TenantSetParams::Settings?
17
20
 
18
21
  def settings=: (
@@ -21,12 +24,14 @@ module Knockapi
21
24
 
22
25
  def initialize: (
23
26
  ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
27
+ ?name: String?,
24
28
  ?settings: Knockapi::TenantSetParams::Settings,
25
29
  ?request_options: Knockapi::request_opts
26
30
  ) -> void
27
31
 
28
32
  def to_hash: -> {
29
33
  channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
34
+ name: String?,
30
35
  settings: Knockapi::TenantSetParams::Settings,
31
36
  request_options: Knockapi::RequestOptions
32
37
  }
@@ -7,6 +7,7 @@ module Knockapi
7
7
  archived: Knockapi::Models::Users::FeedListItemsParams::archived,
8
8
  before: String,
9
9
  has_tenant: bool,
10
+ locale: String,
10
11
  page_size: Integer,
11
12
  source: String,
12
13
  status: Knockapi::Models::Users::FeedListItemsParams::status,
@@ -38,6 +39,10 @@ module Knockapi
38
39
 
39
40
  def has_tenant=: (bool) -> bool
40
41
 
42
+ attr_reader locale: String?
43
+
44
+ def locale=: (String) -> String
45
+
41
46
  attr_reader page_size: Integer?
42
47
 
43
48
  def page_size=: (Integer) -> Integer
@@ -69,6 +74,7 @@ module Knockapi
69
74
  ?archived: Knockapi::Models::Users::FeedListItemsParams::archived,
70
75
  ?before: String,
71
76
  ?has_tenant: bool,
77
+ ?locale: String,
72
78
  ?page_size: Integer,
73
79
  ?source: String,
74
80
  ?status: Knockapi::Models::Users::FeedListItemsParams::status,
@@ -83,6 +89,7 @@ module Knockapi
83
89
  archived: Knockapi::Models::Users::FeedListItemsParams::archived,
84
90
  before: String,
85
91
  has_tenant: bool,
92
+ locale: String,
86
93
  page_size: Integer,
87
94
  source: String,
88
95
  status: Knockapi::Models::Users::FeedListItemsParams::status,
@@ -108,6 +108,7 @@ module Knockapi
108
108
  String id,
109
109
  ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request,
110
110
  ?locale: String?,
111
+ ?name: String?,
111
112
  ?preferences: Knockapi::Models::Recipients::inline_preference_set_request,
112
113
  ?timezone: String?,
113
114
  ?request_options: Knockapi::request_opts
@@ -22,6 +22,7 @@ module Knockapi
22
22
  def set: (
23
23
  String id,
24
24
  ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
25
+ ?name: String?,
25
26
  ?settings: Knockapi::TenantSetParams::Settings,
26
27
  ?request_options: Knockapi::request_opts
27
28
  ) -> Knockapi::Tenant
@@ -15,6 +15,7 @@ module Knockapi
15
15
  ?archived: Knockapi::Models::Users::FeedListItemsParams::archived,
16
16
  ?before: String,
17
17
  ?has_tenant: bool,
18
+ ?locale: String,
18
19
  ?page_size: Integer,
19
20
  ?source: String,
20
21
  ?status: Knockapi::Models::Users::FeedListItemsParams::status,
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.18.0
4
+ version: 1.19.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-10-28 00:00:00.000000000 Z
11
+ date: 2025-11-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool
@@ -150,16 +150,22 @@ files:
150
150
  - lib/knockapi/models/recipient.rb
151
151
  - lib/knockapi/models/recipient_reference.rb
152
152
  - lib/knockapi/models/recipient_request.rb
153
+ - lib/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rb
154
+ - lib/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rb
153
155
  - lib/knockapi/models/recipients/channel_data.rb
154
156
  - lib/knockapi/models/recipients/channel_data_request.rb
155
157
  - lib/knockapi/models/recipients/discord_channel_data.rb
156
158
  - lib/knockapi/models/recipients/inline_channel_data_request.rb
157
159
  - lib/knockapi/models/recipients/inline_preference_set_request.rb
158
160
  - lib/knockapi/models/recipients/ms_teams_channel_data.rb
161
+ - lib/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rb
159
162
  - lib/knockapi/models/recipients/preference_set.rb
163
+ - lib/knockapi/models/recipients/preference_set_channel_setting.rb
160
164
  - lib/knockapi/models/recipients/preference_set_channel_type_setting.rb
161
165
  - lib/knockapi/models/recipients/preference_set_channel_types.rb
162
166
  - lib/knockapi/models/recipients/preference_set_request.rb
167
+ - lib/knockapi/models/recipients/push_channel_data_devices_only.rb
168
+ - lib/knockapi/models/recipients/push_channel_data_tokens_only.rb
163
169
  - lib/knockapi/models/recipients/slack_channel_data.rb
164
170
  - lib/knockapi/models/recipients/subscription.rb
165
171
  - lib/knockapi/models/schedule.rb
@@ -358,16 +364,22 @@ files:
358
364
  - rbi/knockapi/models/recipient.rbi
359
365
  - rbi/knockapi/models/recipient_reference.rbi
360
366
  - rbi/knockapi/models/recipient_request.rbi
367
+ - rbi/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbi
368
+ - rbi/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbi
361
369
  - rbi/knockapi/models/recipients/channel_data.rbi
362
370
  - rbi/knockapi/models/recipients/channel_data_request.rbi
363
371
  - rbi/knockapi/models/recipients/discord_channel_data.rbi
364
372
  - rbi/knockapi/models/recipients/inline_channel_data_request.rbi
365
373
  - rbi/knockapi/models/recipients/inline_preference_set_request.rbi
366
374
  - rbi/knockapi/models/recipients/ms_teams_channel_data.rbi
375
+ - rbi/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbi
367
376
  - rbi/knockapi/models/recipients/preference_set.rbi
377
+ - rbi/knockapi/models/recipients/preference_set_channel_setting.rbi
368
378
  - rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi
369
379
  - rbi/knockapi/models/recipients/preference_set_channel_types.rbi
370
380
  - rbi/knockapi/models/recipients/preference_set_request.rbi
381
+ - rbi/knockapi/models/recipients/push_channel_data_devices_only.rbi
382
+ - rbi/knockapi/models/recipients/push_channel_data_tokens_only.rbi
371
383
  - rbi/knockapi/models/recipients/slack_channel_data.rbi
372
384
  - rbi/knockapi/models/recipients/subscription.rbi
373
385
  - rbi/knockapi/models/schedule.rbi
@@ -565,16 +577,22 @@ files:
565
577
  - sig/knockapi/models/recipient.rbs
566
578
  - sig/knockapi/models/recipient_reference.rbs
567
579
  - sig/knockapi/models/recipient_request.rbs
580
+ - sig/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbs
581
+ - sig/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbs
568
582
  - sig/knockapi/models/recipients/channel_data.rbs
569
583
  - sig/knockapi/models/recipients/channel_data_request.rbs
570
584
  - sig/knockapi/models/recipients/discord_channel_data.rbs
571
585
  - sig/knockapi/models/recipients/inline_channel_data_request.rbs
572
586
  - sig/knockapi/models/recipients/inline_preference_set_request.rbs
573
587
  - sig/knockapi/models/recipients/ms_teams_channel_data.rbs
588
+ - sig/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbs
574
589
  - sig/knockapi/models/recipients/preference_set.rbs
590
+ - sig/knockapi/models/recipients/preference_set_channel_setting.rbs
575
591
  - sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs
576
592
  - sig/knockapi/models/recipients/preference_set_channel_types.rbs
577
593
  - sig/knockapi/models/recipients/preference_set_request.rbs
594
+ - sig/knockapi/models/recipients/push_channel_data_devices_only.rbs
595
+ - sig/knockapi/models/recipients/push_channel_data_tokens_only.rbs
578
596
  - sig/knockapi/models/recipients/slack_channel_data.rbs
579
597
  - sig/knockapi/models/recipients/subscription.rbs
580
598
  - sig/knockapi/models/schedule.rbs