knockapi 1.12.0 → 1.13.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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/models/identify_user_request.rb +2 -2
  5. data/lib/knockapi/models/inline_identify_user_request.rb +2 -2
  6. data/lib/knockapi/models/inline_object_request.rb +2 -2
  7. data/lib/knockapi/models/object_set_params.rb +2 -2
  8. data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
  9. data/lib/knockapi/models/recipients/channel_data.rb +25 -3
  10. data/lib/knockapi/models/recipients/channel_data_request.rb +24 -3
  11. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +22 -1
  12. data/lib/knockapi/models/tenant_request.rb +2 -2
  13. data/lib/knockapi/models/tenant_set_params.rb +2 -2
  14. data/lib/knockapi/models/users/guide_get_channel_response.rb +9 -1
  15. data/lib/knockapi/resources/objects.rb +2 -2
  16. data/lib/knockapi/resources/tenants.rb +1 -1
  17. data/lib/knockapi/resources/users.rb +2 -2
  18. data/lib/knockapi/version.rb +1 -1
  19. data/rbi/knockapi/models/identify_user_request.rbi +3 -0
  20. data/rbi/knockapi/models/inline_identify_user_request.rbi +3 -0
  21. data/rbi/knockapi/models/inline_object_request.rbi +3 -0
  22. data/rbi/knockapi/models/object_set_params.rbi +4 -0
  23. data/rbi/knockapi/models/objects/bulk_set_params.rbi +3 -0
  24. data/rbi/knockapi/models/recipients/channel_data.rbi +39 -2
  25. data/rbi/knockapi/models/recipients/channel_data_request.rbi +34 -0
  26. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +31 -0
  27. data/rbi/knockapi/models/tenant_request.rbi +3 -0
  28. data/rbi/knockapi/models/tenant_set_params.rbi +3 -0
  29. data/rbi/knockapi/models/users/guide_get_channel_response.rbi +11 -0
  30. data/rbi/knockapi/resources/objects.rbi +2 -0
  31. data/rbi/knockapi/resources/tenants.rbi +1 -0
  32. data/rbi/knockapi/resources/users.rbi +2 -0
  33. data/sig/knockapi/models/recipients/channel_data.rbs +13 -0
  34. data/sig/knockapi/models/recipients/channel_data_request.rbs +11 -0
  35. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +11 -0
  36. data/sig/knockapi/models/users/guide_get_channel_response.rbs +7 -0
  37. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0f70bdc48166f046ccdf747cb8b1b5f0243f426fd44c1cb0a8755398de49ba15
4
- data.tar.gz: 56964c493eefa8d2074e731d555a8de08bf631203ca3fd0ed6e5b46e1844f9b4
3
+ metadata.gz: de4f4337ddae3ff013f23c8ab79b48785b5bbf34ed79d31dad83b5111a98330f
4
+ data.tar.gz: ea934f1d6c8128e2bdcb55d14e7904f8da88cfe73e7e0791dc293e5428f997f0
5
5
  SHA512:
6
- metadata.gz: 59aabd5b5cee769894c14541a886f3832d69970d91de6620965c910b1a3029252f259be7f527687b06c090d3ab13e01ad97b2b117fe0b2ee4fea0f5eb99f8b43
7
- data.tar.gz: c3f89f7634d3fa6026bce31e6be0ca6c3765a680fe47e74b4f60e73173b2ac18087feafe0d30b79e7f8991a5e3bb98176f0ffffd53b865d9b4211a5fa4389aa1
6
+ metadata.gz: 4599b2cbbdbdaeda625d4a5b383d19a28fec88c9fe6d33a279967c1f11fa8f96af8c6c20ee1c94c0041137a5c0916fc96ad5903e9ae7e636dd9f1435356d83a3
7
+ data.tar.gz: 290da7f20e22193ea4b6f0488c9c23cf05f017dada61b9742993b75472944e32d4ffc7cf9e4129299da40a6eef1a4aa3c35bd9c01529c9e81593519270c605e2
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.13.0 (2025-09-10)
4
+
5
+ Full Changelog: [v1.12.0...v1.13.0](https://github.com/knocklabs/knock-ruby/compare/v1.12.0...v1.13.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([1d41369](https://github.com/knocklabs/knock-ruby/commit/1d41369c045725172e6910a4fb4ee546218e55d3))
10
+ * **api:** api update ([4cbcd27](https://github.com/knocklabs/knock-ruby/commit/4cbcd27c56bf486d159ceefc0890014184aab50d))
11
+ * **api:** api update ([4cd0c7d](https://github.com/knocklabs/knock-ruby/commit/4cd0c7d4541e1da08e5489df81b4732ff995e8cb))
12
+ * **api:** api update ([2435936](https://github.com/knocklabs/knock-ruby/commit/243593653acf3381827206d7c3844350fb395fce))
13
+ * **api:** api update ([ed2ca0f](https://github.com/knocklabs/knock-ruby/commit/ed2ca0f0d3d587b2fca1ff4a0fb3dcfec7b67b75))
14
+
3
15
  ## 1.12.0 (2025-09-02)
4
16
 
5
17
  Full Changelog: [v1.11.2...v1.12.0](https://github.com/knocklabs/knock-ruby/compare/v1.11.2...v1.12.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.12.0"
20
+ gem "knockapi", "~> 1.13.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -12,7 +12,7 @@ module Knockapi
12
12
  # @!attribute channel_data
13
13
  # A request to set channel data for a type of channel inline.
14
14
  #
15
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
15
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
16
16
  optional :channel_data,
17
17
  -> {
18
18
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -79,7 +79,7 @@ module Knockapi
79
79
  #
80
80
  # @param avatar [String, nil] A URL for the avatar of the user.
81
81
  #
82
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
82
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
83
83
  #
84
84
  # @param created_at [Time, nil] The creation date of the user from your system.
85
85
  #
@@ -18,7 +18,7 @@ module Knockapi
18
18
  # @!attribute channel_data
19
19
  # A request to set channel data for a type of channel inline.
20
20
  #
21
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
22
22
  optional :channel_data,
23
23
  -> {
24
24
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -88,7 +88,7 @@ module Knockapi
88
88
  #
89
89
  # @param avatar [String, nil] A URL for the avatar of the user.
90
90
  #
91
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
91
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
92
92
  #
93
93
  # @param created_at [Time, nil] The creation date of the user from your system.
94
94
  #
@@ -18,7 +18,7 @@ module Knockapi
18
18
  # @!attribute channel_data
19
19
  # A request to set channel data for a type of channel inline.
20
20
  #
21
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
22
22
  optional :channel_data,
23
23
  -> {
24
24
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -51,7 +51,7 @@ module Knockapi
51
51
  #
52
52
  # @param collection [String] The collection this object belongs to.
53
53
  #
54
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
54
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
55
55
  #
56
56
  # @param created_at [Time, nil] Timestamp when the resource was created.
57
57
  #
@@ -10,7 +10,7 @@ module Knockapi
10
10
  # @!attribute channel_data
11
11
  # A request to set channel data for a type of channel inline.
12
12
  #
13
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
13
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
14
14
  optional :channel_data,
15
15
  -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] }
16
16
 
@@ -42,7 +42,7 @@ module Knockapi
42
42
  # Some parameter documentations has been truncated, see
43
43
  # {Knockapi::Models::ObjectSetParams} for more details.
44
44
  #
45
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
45
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
46
46
  #
47
47
  # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
48
48
  #
@@ -29,7 +29,7 @@ module Knockapi
29
29
  # @!attribute channel_data
30
30
  # A request to set channel data for a type of channel inline.
31
31
  #
32
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
32
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
33
33
  optional :channel_data,
34
34
  -> {
35
35
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -60,7 +60,7 @@ module Knockapi
60
60
  #
61
61
  # @param id [String] Unique identifier for the object.
62
62
  #
63
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
63
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
64
64
  #
65
65
  # @param created_at [Time, nil] Timestamp when the resource was created.
66
66
  #
@@ -19,7 +19,7 @@ module Knockapi
19
19
  # @!attribute data
20
20
  # Channel data for a given channel type.
21
21
  #
22
- # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData]
22
+ # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData]
23
23
  required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data }
24
24
 
25
25
  # @!attribute provider
@@ -35,7 +35,7 @@ module Knockapi
35
35
  #
36
36
  # @param channel_id [String] The unique identifier for the channel.
37
37
  #
38
- # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] Channel data for a given channel type.
38
+ # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] Channel data for a given channel type.
39
39
  #
40
40
  # @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider.
41
41
 
@@ -60,8 +60,29 @@ module Knockapi
60
60
  # OneSignal channel data.
61
61
  variant -> { Knockapi::Recipients::OneSignalChannelData }
62
62
 
63
+ # AWS SNS push channel data.
64
+ variant -> { Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData }
65
+
66
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
67
+ # @!attribute target_arns
68
+ # A list of platform endpoint ARNs. See
69
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
70
+ #
71
+ # @return [Array<String>]
72
+ required :target_arns, Knockapi::Internal::Type::ArrayOf[String]
73
+
74
+ # @!method initialize(target_arns:)
75
+ # Some parameter documentations has been truncated, see
76
+ # {Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData}
77
+ # for more details.
78
+ #
79
+ # AWS SNS push channel data.
80
+ #
81
+ # @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
82
+ end
83
+
63
84
  # @!method self.variants
64
- # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)]
85
+ # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData)]
65
86
  end
66
87
 
67
88
  # The type of provider.
@@ -72,6 +93,7 @@ module Knockapi
72
93
 
73
94
  PUSH_FCM = :push_fcm
74
95
  PUSH_APNS = :push_apns
96
+ PUSH_AWS_SNS = :push_aws_sns
75
97
  PUSH_EXPO = :push_expo
76
98
  PUSH_ONE_SIGNAL = :push_one_signal
77
99
  CHAT_SLACK = :chat_slack
@@ -7,13 +7,13 @@ module Knockapi
7
7
  # @!attribute data
8
8
  # Channel data for a given channel type.
9
9
  #
10
- # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
10
+ # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
11
11
  required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data }
12
12
 
13
13
  # @!method initialize(data:)
14
14
  # A request to set channel data for a type of channel.
15
15
  #
16
- # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
16
+ # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
17
17
 
18
18
  # Channel data for a given channel type.
19
19
  #
@@ -27,6 +27,9 @@ module Knockapi
27
27
  # OneSignal channel data.
28
28
  variant -> { Knockapi::Recipients::OneSignalChannelData }
29
29
 
30
+ # AWS SNS push channel data.
31
+ variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData }
32
+
30
33
  # Slack channel data.
31
34
  variant -> { Knockapi::Recipients::SlackChannelData }
32
35
 
@@ -36,8 +39,26 @@ module Knockapi
36
39
  # Discord channel data.
37
40
  variant -> { Knockapi::Recipients::DiscordChannelData }
38
41
 
42
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
43
+ # @!attribute target_arns
44
+ # A list of platform endpoint ARNs. See
45
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
46
+ #
47
+ # @return [Array<String>]
48
+ required :target_arns, Knockapi::Internal::Type::ArrayOf[String]
49
+
50
+ # @!method initialize(target_arns:)
51
+ # Some parameter documentations has been truncated, see
52
+ # {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData}
53
+ # for more details.
54
+ #
55
+ # AWS SNS push channel data.
56
+ #
57
+ # @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
58
+ end
59
+
39
60
  # @!method self.variants
40
- # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
61
+ # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
41
62
  end
42
63
  end
43
64
  end
@@ -13,6 +13,9 @@ module Knockapi
13
13
  # OneSignal channel data.
14
14
  variant -> { Knockapi::Recipients::OneSignalChannelData }
15
15
 
16
+ # AWS SNS push channel data.
17
+ variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData }
18
+
16
19
  # Slack channel data.
17
20
  variant -> { Knockapi::Recipients::SlackChannelData }
18
21
 
@@ -22,8 +25,26 @@ module Knockapi
22
25
  # Discord channel data.
23
26
  variant -> { Knockapi::Recipients::DiscordChannelData }
24
27
 
28
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
29
+ # @!attribute target_arns
30
+ # A list of platform endpoint ARNs. See
31
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
32
+ #
33
+ # @return [Array<String>]
34
+ required :target_arns, Knockapi::Internal::Type::ArrayOf[String]
35
+
36
+ # @!method initialize(target_arns:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData}
39
+ # for more details.
40
+ #
41
+ # AWS SNS push channel data.
42
+ #
43
+ # @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
44
+ end
45
+
25
46
  # @!method self.variants
26
- # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
47
+ # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
27
48
  end
28
49
 
29
50
  # @type [Knockapi::Internal::Type::Converter]
@@ -12,7 +12,7 @@ module Knockapi
12
12
  # @!attribute channel_data
13
13
  # A request to set channel data for a type of channel inline.
14
14
  #
15
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
15
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
16
16
  optional :channel_data,
17
17
  -> {
18
18
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -44,7 +44,7 @@ module Knockapi
44
44
  #
45
45
  # @param id [String] The unique identifier for the tenant.
46
46
  #
47
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
47
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
48
48
  #
49
49
  # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
50
50
  #
@@ -10,7 +10,7 @@ module Knockapi
10
10
  # @!attribute channel_data
11
11
  # A request to set channel data for a type of channel inline.
12
12
  #
13
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
13
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
14
14
  optional :channel_data,
15
15
  -> {
16
16
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -24,7 +24,7 @@ module Knockapi
24
24
  optional :settings, -> { Knockapi::TenantSetParams::Settings }
25
25
 
26
26
  # @!method initialize(channel_data: nil, settings: nil, request_options: {})
27
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
27
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
28
28
  #
29
29
  # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
30
30
  #
@@ -32,6 +32,12 @@ module Knockapi
32
32
  # @return [String, nil]
33
33
  optional :id, String
34
34
 
35
+ # @!attribute active
36
+ # Whether the guide is active.
37
+ #
38
+ # @return [Boolean, nil]
39
+ optional :active, Knockapi::Internal::Type::Boolean
40
+
35
41
  # @!attribute content
36
42
  # The content of the guide.
37
43
  #
@@ -50,9 +56,11 @@ module Knockapi
50
56
  # @return [String, nil]
51
57
  optional :title, String
52
58
 
53
- # @!method initialize(id: nil, content: nil, metadata: nil, title: nil)
59
+ # @!method initialize(id: nil, active: nil, content: nil, metadata: nil, title: nil)
54
60
  # @param id [String] The unique identifier for the guide.
55
61
  #
62
+ # @param active [Boolean] Whether the guide is active.
63
+ #
56
64
  # @param content [String] The content of the guide.
57
65
  #
58
66
  # @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
@@ -368,7 +368,7 @@ module Knockapi
368
368
  #
369
369
  # @param id [String] Unique identifier for the object.
370
370
  #
371
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
371
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
372
372
  #
373
373
  # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
374
374
  #
@@ -404,7 +404,7 @@ module Knockapi
404
404
  #
405
405
  # @param channel_id [String] The unique identifier for the channel.
406
406
  #
407
- # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
407
+ # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
408
408
  #
409
409
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
410
410
  #
@@ -84,7 +84,7 @@ module Knockapi
84
84
  #
85
85
  # @param id [String] The unique identifier for the tenant.
86
86
  #
87
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
87
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
88
88
  #
89
89
  # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
90
90
  #
@@ -25,7 +25,7 @@ module Knockapi
25
25
  #
26
26
  # @param avatar [String, nil] A URL for the avatar of the user.
27
27
  #
28
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
28
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
29
29
  #
30
30
  # @param created_at [Time, nil] The creation date of the user from your system.
31
31
  #
@@ -354,7 +354,7 @@ module Knockapi
354
354
  #
355
355
  # @param channel_id [String] The unique identifier for the channel.
356
356
  #
357
- # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
357
+ # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
358
358
  #
359
359
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
360
360
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Knockapi
4
- VERSION = "1.12.0"
4
+ VERSION = "1.13.0"
5
5
  end
@@ -21,6 +21,7 @@ module Knockapi
21
21
  T.any(
22
22
  Knockapi::Recipients::PushChannelData,
23
23
  Knockapi::Recipients::OneSignalChannelData,
24
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
24
25
  Knockapi::Recipients::SlackChannelData,
25
26
  Knockapi::Recipients::MsTeamsChannelData,
26
27
  Knockapi::Recipients::DiscordChannelData
@@ -82,6 +83,7 @@ module Knockapi
82
83
  T.any(
83
84
  Knockapi::Recipients::PushChannelData::OrHash,
84
85
  Knockapi::Recipients::OneSignalChannelData::OrHash,
86
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
85
87
  Knockapi::Recipients::SlackChannelData::OrHash,
86
88
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
87
89
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -142,6 +144,7 @@ module Knockapi
142
144
  T.any(
143
145
  Knockapi::Recipients::PushChannelData,
144
146
  Knockapi::Recipients::OneSignalChannelData,
147
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
145
148
  Knockapi::Recipients::SlackChannelData,
146
149
  Knockapi::Recipients::MsTeamsChannelData,
147
150
  Knockapi::Recipients::DiscordChannelData
@@ -28,6 +28,7 @@ module Knockapi
28
28
  T.any(
29
29
  Knockapi::Recipients::PushChannelData,
30
30
  Knockapi::Recipients::OneSignalChannelData,
31
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
31
32
  Knockapi::Recipients::SlackChannelData,
32
33
  Knockapi::Recipients::MsTeamsChannelData,
33
34
  Knockapi::Recipients::DiscordChannelData
@@ -91,6 +92,7 @@ module Knockapi
91
92
  T.any(
92
93
  Knockapi::Recipients::PushChannelData::OrHash,
93
94
  Knockapi::Recipients::OneSignalChannelData::OrHash,
95
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
94
96
  Knockapi::Recipients::SlackChannelData::OrHash,
95
97
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
96
98
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -154,6 +156,7 @@ module Knockapi
154
156
  T.any(
155
157
  Knockapi::Recipients::PushChannelData,
156
158
  Knockapi::Recipients::OneSignalChannelData,
159
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
157
160
  Knockapi::Recipients::SlackChannelData,
158
161
  Knockapi::Recipients::MsTeamsChannelData,
159
162
  Knockapi::Recipients::DiscordChannelData
@@ -25,6 +25,7 @@ module Knockapi
25
25
  T.any(
26
26
  Knockapi::Recipients::PushChannelData,
27
27
  Knockapi::Recipients::OneSignalChannelData,
28
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
28
29
  Knockapi::Recipients::SlackChannelData,
29
30
  Knockapi::Recipients::MsTeamsChannelData,
30
31
  Knockapi::Recipients::DiscordChannelData
@@ -61,6 +62,7 @@ module Knockapi
61
62
  T.any(
62
63
  Knockapi::Recipients::PushChannelData::OrHash,
63
64
  Knockapi::Recipients::OneSignalChannelData::OrHash,
65
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
64
66
  Knockapi::Recipients::SlackChannelData::OrHash,
65
67
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
66
68
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -105,6 +107,7 @@ module Knockapi
105
107
  T.any(
106
108
  Knockapi::Recipients::PushChannelData,
107
109
  Knockapi::Recipients::OneSignalChannelData,
110
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
108
111
  Knockapi::Recipients::SlackChannelData,
109
112
  Knockapi::Recipients::MsTeamsChannelData,
110
113
  Knockapi::Recipients::DiscordChannelData
@@ -20,6 +20,7 @@ module Knockapi
20
20
  T.any(
21
21
  Knockapi::Recipients::PushChannelData,
22
22
  Knockapi::Recipients::OneSignalChannelData,
23
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
23
24
  Knockapi::Recipients::SlackChannelData,
24
25
  Knockapi::Recipients::MsTeamsChannelData,
25
26
  Knockapi::Recipients::DiscordChannelData
@@ -38,6 +39,7 @@ module Knockapi
38
39
  T.any(
39
40
  Knockapi::Recipients::PushChannelData::OrHash,
40
41
  Knockapi::Recipients::OneSignalChannelData::OrHash,
42
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
41
43
  Knockapi::Recipients::SlackChannelData::OrHash,
42
44
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
43
45
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -85,6 +87,7 @@ module Knockapi
85
87
  T.any(
86
88
  Knockapi::Recipients::PushChannelData::OrHash,
87
89
  Knockapi::Recipients::OneSignalChannelData::OrHash,
90
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
88
91
  Knockapi::Recipients::SlackChannelData::OrHash,
89
92
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
90
93
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -125,6 +128,7 @@ module Knockapi
125
128
  T.any(
126
129
  Knockapi::Recipients::PushChannelData,
127
130
  Knockapi::Recipients::OneSignalChannelData,
131
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
128
132
  Knockapi::Recipients::SlackChannelData,
129
133
  Knockapi::Recipients::MsTeamsChannelData,
130
134
  Knockapi::Recipients::DiscordChannelData
@@ -62,6 +62,7 @@ module Knockapi
62
62
  T.any(
63
63
  Knockapi::Recipients::PushChannelData,
64
64
  Knockapi::Recipients::OneSignalChannelData,
65
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
65
66
  Knockapi::Recipients::SlackChannelData,
66
67
  Knockapi::Recipients::MsTeamsChannelData,
67
68
  Knockapi::Recipients::DiscordChannelData
@@ -99,6 +100,7 @@ module Knockapi
99
100
  T.any(
100
101
  Knockapi::Recipients::PushChannelData::OrHash,
101
102
  Knockapi::Recipients::OneSignalChannelData::OrHash,
103
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
102
104
  Knockapi::Recipients::SlackChannelData::OrHash,
103
105
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
104
106
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -140,6 +142,7 @@ module Knockapi
140
142
  T.any(
141
143
  Knockapi::Recipients::PushChannelData,
142
144
  Knockapi::Recipients::OneSignalChannelData,
145
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
143
146
  Knockapi::Recipients::SlackChannelData,
144
147
  Knockapi::Recipients::MsTeamsChannelData,
145
148
  Knockapi::Recipients::DiscordChannelData
@@ -55,7 +55,8 @@ module Knockapi
55
55
  Knockapi::Recipients::SlackChannelData::OrHash,
56
56
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
57
57
  Knockapi::Recipients::DiscordChannelData::OrHash,
58
- Knockapi::Recipients::OneSignalChannelData::OrHash
58
+ Knockapi::Recipients::OneSignalChannelData::OrHash,
59
+ Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData::OrHash
59
60
  ),
60
61
  provider:
61
62
  Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol
@@ -98,10 +99,41 @@ module Knockapi
98
99
  Knockapi::Recipients::SlackChannelData,
99
100
  Knockapi::Recipients::MsTeamsChannelData,
100
101
  Knockapi::Recipients::DiscordChannelData,
101
- Knockapi::Recipients::OneSignalChannelData
102
+ Knockapi::Recipients::OneSignalChannelData,
103
+ Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData
102
104
  )
103
105
  end
104
106
 
107
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
108
+ OrHash =
109
+ T.type_alias do
110
+ T.any(
111
+ Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData,
112
+ Knockapi::Internal::AnyHash
113
+ )
114
+ end
115
+
116
+ # A list of platform endpoint ARNs. See
117
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
118
+ sig { returns(T::Array[String]) }
119
+ attr_accessor :target_arns
120
+
121
+ # AWS SNS push channel data.
122
+ sig do
123
+ params(target_arns: T::Array[String]).returns(T.attached_class)
124
+ end
125
+ def self.new(
126
+ # A list of platform endpoint ARNs. See
127
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
128
+ target_arns:
129
+ )
130
+ end
131
+
132
+ sig { override.returns({ target_arns: T::Array[String] }) }
133
+ def to_hash
134
+ end
135
+ end
136
+
105
137
  sig do
106
138
  override.returns(
107
139
  T::Array[
@@ -136,6 +168,11 @@ module Knockapi
136
168
  :push_apns,
137
169
  Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
138
170
  )
171
+ PUSH_AWS_SNS =
172
+ T.let(
173
+ :push_aws_sns,
174
+ Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
175
+ )
139
176
  PUSH_EXPO =
140
177
  T.let(
141
178
  :push_expo,
@@ -18,6 +18,7 @@ module Knockapi
18
18
  T.any(
19
19
  Knockapi::Recipients::PushChannelData,
20
20
  Knockapi::Recipients::OneSignalChannelData,
21
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData,
21
22
  Knockapi::Recipients::SlackChannelData,
22
23
  Knockapi::Recipients::MsTeamsChannelData,
23
24
  Knockapi::Recipients::DiscordChannelData
@@ -33,6 +34,7 @@ module Knockapi
33
34
  T.any(
34
35
  Knockapi::Recipients::PushChannelData::OrHash,
35
36
  Knockapi::Recipients::OneSignalChannelData::OrHash,
37
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash,
36
38
  Knockapi::Recipients::SlackChannelData::OrHash,
37
39
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
38
40
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -52,6 +54,7 @@ module Knockapi
52
54
  T.any(
53
55
  Knockapi::Recipients::PushChannelData,
54
56
  Knockapi::Recipients::OneSignalChannelData,
57
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData,
55
58
  Knockapi::Recipients::SlackChannelData,
56
59
  Knockapi::Recipients::MsTeamsChannelData,
57
60
  Knockapi::Recipients::DiscordChannelData
@@ -71,12 +74,43 @@ module Knockapi
71
74
  T.any(
72
75
  Knockapi::Recipients::PushChannelData,
73
76
  Knockapi::Recipients::OneSignalChannelData,
77
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData,
74
78
  Knockapi::Recipients::SlackChannelData,
75
79
  Knockapi::Recipients::MsTeamsChannelData,
76
80
  Knockapi::Recipients::DiscordChannelData
77
81
  )
78
82
  end
79
83
 
84
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
85
+ OrHash =
86
+ T.type_alias do
87
+ T.any(
88
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData,
89
+ Knockapi::Internal::AnyHash
90
+ )
91
+ end
92
+
93
+ # A list of platform endpoint ARNs. See
94
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
95
+ sig { returns(T::Array[String]) }
96
+ attr_accessor :target_arns
97
+
98
+ # AWS SNS push channel data.
99
+ sig do
100
+ params(target_arns: T::Array[String]).returns(T.attached_class)
101
+ end
102
+ def self.new(
103
+ # A list of platform endpoint ARNs. See
104
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
105
+ target_arns:
106
+ )
107
+ end
108
+
109
+ sig { override.returns({ target_arns: T::Array[String] }) }
110
+ def to_hash
111
+ end
112
+ end
113
+
80
114
  sig do
81
115
  override.returns(
82
116
  T::Array[Knockapi::Recipients::ChannelDataRequest::Data::Variants]
@@ -12,12 +12,43 @@ module Knockapi
12
12
  T.any(
13
13
  Knockapi::Recipients::PushChannelData,
14
14
  Knockapi::Recipients::OneSignalChannelData,
15
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
15
16
  Knockapi::Recipients::SlackChannelData,
16
17
  Knockapi::Recipients::MsTeamsChannelData,
17
18
  Knockapi::Recipients::DiscordChannelData
18
19
  )
19
20
  end
20
21
 
22
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
23
+ OrHash =
24
+ T.type_alias do
25
+ T.any(
26
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
27
+ Knockapi::Internal::AnyHash
28
+ )
29
+ end
30
+
31
+ # A list of platform endpoint ARNs. See
32
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
33
+ sig { returns(T::Array[String]) }
34
+ attr_accessor :target_arns
35
+
36
+ # AWS SNS push channel data.
37
+ sig do
38
+ params(target_arns: T::Array[String]).returns(T.attached_class)
39
+ end
40
+ def self.new(
41
+ # A list of platform endpoint ARNs. See
42
+ # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
43
+ target_arns:
44
+ )
45
+ end
46
+
47
+ sig { override.returns({ target_arns: T::Array[String] }) }
48
+ def to_hash
49
+ end
50
+ end
51
+
21
52
  sig do
22
53
  override.returns(
23
54
  T::Array[
@@ -21,6 +21,7 @@ module Knockapi
21
21
  T.any(
22
22
  Knockapi::Recipients::PushChannelData,
23
23
  Knockapi::Recipients::OneSignalChannelData,
24
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
24
25
  Knockapi::Recipients::SlackChannelData,
25
26
  Knockapi::Recipients::MsTeamsChannelData,
26
27
  Knockapi::Recipients::DiscordChannelData
@@ -60,6 +61,7 @@ module Knockapi
60
61
  T.any(
61
62
  Knockapi::Recipients::PushChannelData::OrHash,
62
63
  Knockapi::Recipients::OneSignalChannelData::OrHash,
64
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
63
65
  Knockapi::Recipients::SlackChannelData::OrHash,
64
66
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
65
67
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -101,6 +103,7 @@ module Knockapi
101
103
  T.any(
102
104
  Knockapi::Recipients::PushChannelData,
103
105
  Knockapi::Recipients::OneSignalChannelData,
106
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
104
107
  Knockapi::Recipients::SlackChannelData,
105
108
  Knockapi::Recipients::MsTeamsChannelData,
106
109
  Knockapi::Recipients::DiscordChannelData
@@ -20,6 +20,7 @@ module Knockapi
20
20
  T.any(
21
21
  Knockapi::Recipients::PushChannelData,
22
22
  Knockapi::Recipients::OneSignalChannelData,
23
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
23
24
  Knockapi::Recipients::SlackChannelData,
24
25
  Knockapi::Recipients::MsTeamsChannelData,
25
26
  Knockapi::Recipients::DiscordChannelData
@@ -46,6 +47,7 @@ module Knockapi
46
47
  T.any(
47
48
  Knockapi::Recipients::PushChannelData::OrHash,
48
49
  Knockapi::Recipients::OneSignalChannelData::OrHash,
50
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
49
51
  Knockapi::Recipients::SlackChannelData::OrHash,
50
52
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
51
53
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -75,6 +77,7 @@ module Knockapi
75
77
  T.any(
76
78
  Knockapi::Recipients::PushChannelData,
77
79
  Knockapi::Recipients::OneSignalChannelData,
80
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
78
81
  Knockapi::Recipients::SlackChannelData,
79
82
  Knockapi::Recipients::MsTeamsChannelData,
80
83
  Knockapi::Recipients::DiscordChannelData
@@ -94,6 +94,13 @@ module Knockapi
94
94
  sig { params(id: String).void }
95
95
  attr_writer :id
96
96
 
97
+ # Whether the guide is active.
98
+ sig { returns(T.nilable(T::Boolean)) }
99
+ attr_reader :active
100
+
101
+ sig { params(active: T::Boolean).void }
102
+ attr_writer :active
103
+
97
104
  # The content of the guide.
98
105
  sig { returns(T.nilable(String)) }
99
106
  attr_reader :content
@@ -118,6 +125,7 @@ module Knockapi
118
125
  sig do
119
126
  params(
120
127
  id: String,
128
+ active: T::Boolean,
121
129
  content: String,
122
130
  metadata: T::Hash[Symbol, T.anything],
123
131
  title: String
@@ -126,6 +134,8 @@ module Knockapi
126
134
  def self.new(
127
135
  # The unique identifier for the guide.
128
136
  id: nil,
137
+ # Whether the guide is active.
138
+ active: nil,
129
139
  # The content of the guide.
130
140
  content: nil,
131
141
  # The metadata of the guide.
@@ -139,6 +149,7 @@ module Knockapi
139
149
  override.returns(
140
150
  {
141
151
  id: String,
152
+ active: T::Boolean,
142
153
  content: String,
143
154
  metadata: T::Hash[Symbol, T.anything],
144
155
  title: String
@@ -355,6 +355,7 @@ module Knockapi
355
355
  T.any(
356
356
  Knockapi::Recipients::PushChannelData::OrHash,
357
357
  Knockapi::Recipients::OneSignalChannelData::OrHash,
358
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
358
359
  Knockapi::Recipients::SlackChannelData::OrHash,
359
360
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
360
361
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -402,6 +403,7 @@ module Knockapi
402
403
  T.any(
403
404
  Knockapi::Recipients::PushChannelData::OrHash,
404
405
  Knockapi::Recipients::OneSignalChannelData::OrHash,
406
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash,
405
407
  Knockapi::Recipients::SlackChannelData::OrHash,
406
408
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
407
409
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -72,6 +72,7 @@ module Knockapi
72
72
  T.any(
73
73
  Knockapi::Recipients::PushChannelData::OrHash,
74
74
  Knockapi::Recipients::OneSignalChannelData::OrHash,
75
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
75
76
  Knockapi::Recipients::SlackChannelData::OrHash,
76
77
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
77
78
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -26,6 +26,7 @@ module Knockapi
26
26
  T.any(
27
27
  Knockapi::Recipients::PushChannelData::OrHash,
28
28
  Knockapi::Recipients::OneSignalChannelData::OrHash,
29
+ Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
29
30
  Knockapi::Recipients::SlackChannelData::OrHash,
30
31
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
31
32
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -344,6 +345,7 @@ module Knockapi
344
345
  T.any(
345
346
  Knockapi::Recipients::PushChannelData::OrHash,
346
347
  Knockapi::Recipients::OneSignalChannelData::OrHash,
348
+ Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash,
347
349
  Knockapi::Recipients::SlackChannelData::OrHash,
348
350
  Knockapi::Recipients::MsTeamsChannelData::OrHash,
349
351
  Knockapi::Recipients::DiscordChannelData::OrHash
@@ -42,16 +42,28 @@ module Knockapi
42
42
  | Knockapi::Recipients::MsTeamsChannelData
43
43
  | Knockapi::Recipients::DiscordChannelData
44
44
  | Knockapi::Recipients::OneSignalChannelData
45
+ | Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData
45
46
 
46
47
  module Data
47
48
  extend Knockapi::Internal::Type::Union
48
49
 
50
+ type aws_sns_push_channel_data = { target_arns: ::Array[String] }
51
+
52
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
53
+ attr_accessor target_arns: ::Array[String]
54
+
55
+ def initialize: (target_arns: ::Array[String]) -> void
56
+
57
+ def to_hash: -> { target_arns: ::Array[String] }
58
+ end
59
+
49
60
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::RecipientsChannelData::data]
50
61
  end
51
62
 
52
63
  type provider =
53
64
  :push_fcm
54
65
  | :push_apns
66
+ | :push_aws_sns
55
67
  | :push_expo
56
68
  | :push_one_signal
57
69
  | :chat_slack
@@ -64,6 +76,7 @@ module Knockapi
64
76
 
65
77
  PUSH_FCM: :push_fcm
66
78
  PUSH_APNS: :push_apns
79
+ PUSH_AWS_SNS: :push_aws_sns
67
80
  PUSH_EXPO: :push_expo
68
81
  PUSH_ONE_SIGNAL: :push_one_signal
69
82
  CHAT_SLACK: :chat_slack
@@ -18,6 +18,7 @@ module Knockapi
18
18
  type data =
19
19
  Knockapi::Recipients::PushChannelData
20
20
  | Knockapi::Recipients::OneSignalChannelData
21
+ | Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData
21
22
  | Knockapi::Recipients::SlackChannelData
22
23
  | Knockapi::Recipients::MsTeamsChannelData
23
24
  | Knockapi::Recipients::DiscordChannelData
@@ -25,6 +26,16 @@ module Knockapi
25
26
  module Data
26
27
  extend Knockapi::Internal::Type::Union
27
28
 
29
+ type aws_sns_push_channel_data = { target_arns: ::Array[String] }
30
+
31
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
32
+ attr_accessor target_arns: ::Array[String]
33
+
34
+ def initialize: (target_arns: ::Array[String]) -> void
35
+
36
+ def to_hash: -> { target_arns: ::Array[String] }
37
+ end
38
+
28
39
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::ChannelDataRequest::data]
29
40
  end
30
41
  end
@@ -4,6 +4,7 @@ module Knockapi
4
4
  type inline_channel_data_request_item =
5
5
  Knockapi::Recipients::PushChannelData
6
6
  | Knockapi::Recipients::OneSignalChannelData
7
+ | Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData
7
8
  | Knockapi::Recipients::SlackChannelData
8
9
  | Knockapi::Recipients::MsTeamsChannelData
9
10
  | Knockapi::Recipients::DiscordChannelData
@@ -11,6 +12,16 @@ module Knockapi
11
12
  module InlineChannelDataRequestItem
12
13
  extend Knockapi::Internal::Type::Union
13
14
 
15
+ type aws_sns_push_channel_data = { target_arns: ::Array[String] }
16
+
17
+ class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel
18
+ attr_accessor target_arns: ::Array[String]
19
+
20
+ def initialize: (target_arns: ::Array[String]) -> void
21
+
22
+ def to_hash: -> { target_arns: ::Array[String] }
23
+ end
24
+
14
25
  def self?.variants: -> ::Array[Knockapi::Models::Recipients::inline_channel_data_request_item]
15
26
  end
16
27
 
@@ -25,6 +25,7 @@ module Knockapi
25
25
  type guide =
26
26
  {
27
27
  id: String,
28
+ active: bool,
28
29
  content: String,
29
30
  metadata: ::Hash[Symbol, top],
30
31
  title: String
@@ -35,6 +36,10 @@ module Knockapi
35
36
 
36
37
  def id=: (String) -> String
37
38
 
39
+ attr_reader active: bool?
40
+
41
+ def active=: (bool) -> bool
42
+
38
43
  attr_reader content: String?
39
44
 
40
45
  def content=: (String) -> String
@@ -49,6 +54,7 @@ module Knockapi
49
54
 
50
55
  def initialize: (
51
56
  ?id: String,
57
+ ?active: bool,
52
58
  ?content: String,
53
59
  ?metadata: ::Hash[Symbol, top],
54
60
  ?title: String
@@ -56,6 +62,7 @@ module Knockapi
56
62
 
57
63
  def to_hash: -> {
58
64
  id: String,
65
+ active: bool,
59
66
  content: String,
60
67
  metadata: ::Hash[Symbol, top],
61
68
  title: String
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.12.0
4
+ version: 1.13.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-02 00:00:00.000000000 Z
11
+ date: 2025-09-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool