knockapi 1.17.0 → 1.18.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/README.md +1 -1
- data/lib/knockapi/models/identify_user_request.rb +2 -2
- data/lib/knockapi/models/inline_identify_user_request.rb +2 -2
- data/lib/knockapi/models/inline_object_request.rb +2 -2
- data/lib/knockapi/models/object_set_params.rb +2 -2
- data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
- data/lib/knockapi/models/recipients/channel_data_request.rb +119 -3
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +117 -1
- data/lib/knockapi/models/tenant_request.rb +2 -2
- data/lib/knockapi/models/tenant_set_params.rb +2 -2
- data/lib/knockapi/resources/objects.rb +2 -2
- data/lib/knockapi/resources/tenants.rb +1 -1
- data/lib/knockapi/resources/users.rb +2 -2
- data/lib/knockapi/version.rb +1 -1
- data/rbi/knockapi/models/identify_user_request.rbi +6 -0
- data/rbi/knockapi/models/inline_identify_user_request.rbi +6 -0
- data/rbi/knockapi/models/inline_object_request.rbi +6 -0
- data/rbi/knockapi/models/object_set_params.rbi +8 -0
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +6 -0
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +230 -0
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +224 -0
- data/rbi/knockapi/models/tenant_request.rbi +6 -0
- data/rbi/knockapi/models/tenant_set_params.rbi +6 -0
- data/rbi/knockapi/resources/objects.rbi +4 -0
- data/rbi/knockapi/resources/tenants.rbi +2 -0
- data/rbi/knockapi/resources/users.rbi +4 -0
- data/sig/knockapi/models/recipients/channel_data_request.rbs +81 -0
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +81 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f4edf766ef7fea30511bafeaf37ca5ec9a230e92f40e9b47f020d735c397ae2d
|
|
4
|
+
data.tar.gz: 49f17bf1e3915debccfba88de22152aa00f53d14ff3189d549104343173c8d40
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 503af7c4bee2cab95fb77aef066afd8c6703bb3f9db4b8a05483709b6eb6fa4822d301a60f755d61fe2ffdb2b8b9e072f148fd95f0f2e6c92ed217f15d06cc33
|
|
7
|
+
data.tar.gz: c074a2d2dce553547360e3b7a9a34a6fec7965a9eaa2fa7fc3ab6065d1e3d2bf138f1a219a5a9e7df22ee3e5a16d08da00500ad57fcae5a9753e73aacff5e89e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.18.0 (2025-10-28)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.17.0...v1.18.0](https://github.com/knocklabs/knock-ruby/compare/v1.17.0...v1.18.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([276ab1a](https://github.com/knocklabs/knock-ruby/commit/276ab1acb42bffaf4e23bf2af3a752200d2a3b22))
|
|
10
|
+
* **api:** api update ([32ea1e5](https://github.com/knocklabs/knock-ruby/commit/32ea1e552eeeb0e4fabb7074c5d8c4e52cc02ff1))
|
|
11
|
+
* **api:** api update ([4d00bd1](https://github.com/knocklabs/knock-ruby/commit/4d00bd1384ab9303995cb23adf1791647265d049))
|
|
12
|
+
|
|
3
13
|
## 1.17.0 (2025-10-24)
|
|
4
14
|
|
|
5
15
|
Full Changelog: [v1.16.0...v1.17.0](https://github.com/knocklabs/knock-ruby/compare/v1.16.0...v1.17.0)
|
data/README.md
CHANGED
|
@@ -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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
15
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
32
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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
|
#
|
|
@@ -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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
|
|
10
|
+
# @return [Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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
|
#
|
|
@@ -24,9 +24,15 @@ module Knockapi
|
|
|
24
24
|
# Push channel data.
|
|
25
25
|
variant -> { Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly }
|
|
26
26
|
|
|
27
|
+
# Push channel data.
|
|
28
|
+
variant -> { Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly }
|
|
29
|
+
|
|
27
30
|
# AWS SNS push channel data.
|
|
28
31
|
variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly }
|
|
29
32
|
|
|
33
|
+
# AWS SNS push channel data.
|
|
34
|
+
variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly }
|
|
35
|
+
|
|
30
36
|
# OneSignal channel data.
|
|
31
37
|
variant -> { Knockapi::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly }
|
|
32
38
|
|
|
@@ -52,6 +58,60 @@ module Knockapi
|
|
|
52
58
|
# @param tokens [Array<String>] A list of push channel tokens.
|
|
53
59
|
end
|
|
54
60
|
|
|
61
|
+
class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
|
|
62
|
+
# @!attribute devices
|
|
63
|
+
# A list of devices. Each device contains a token, and optionally a locale and
|
|
64
|
+
# timezone.
|
|
65
|
+
#
|
|
66
|
+
# @return [Array<Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly::Device>]
|
|
67
|
+
required :devices,
|
|
68
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly::Device] }
|
|
69
|
+
|
|
70
|
+
# @!method initialize(devices:)
|
|
71
|
+
# Some parameter documentations has been truncated, see
|
|
72
|
+
# {Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly}
|
|
73
|
+
# for more details.
|
|
74
|
+
#
|
|
75
|
+
# Push channel data.
|
|
76
|
+
#
|
|
77
|
+
# @param devices [Array<Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a token, and optionally a locale and tim
|
|
78
|
+
|
|
79
|
+
class Device < Knockapi::Internal::Type::BaseModel
|
|
80
|
+
# @!attribute token
|
|
81
|
+
# The device token to send the push notification to.
|
|
82
|
+
#
|
|
83
|
+
# @return [String]
|
|
84
|
+
required :token, String
|
|
85
|
+
|
|
86
|
+
# @!attribute locale
|
|
87
|
+
# The locale of the object. Used for
|
|
88
|
+
# [message localization](/concepts/translations).
|
|
89
|
+
#
|
|
90
|
+
# @return [String, nil]
|
|
91
|
+
optional :locale, String, nil?: true
|
|
92
|
+
|
|
93
|
+
# @!attribute timezone
|
|
94
|
+
# The timezone of the object. Must be a
|
|
95
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
96
|
+
# Used
|
|
97
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
optional :timezone, String, nil?: true
|
|
101
|
+
|
|
102
|
+
# @!method initialize(token:, locale: nil, timezone: nil)
|
|
103
|
+
# Some parameter documentations has been truncated, see
|
|
104
|
+
# {Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly::Device}
|
|
105
|
+
# for more details.
|
|
106
|
+
#
|
|
107
|
+
# @param token [String] The device token to send the push notification to.
|
|
108
|
+
#
|
|
109
|
+
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
|
110
|
+
#
|
|
111
|
+
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
|
|
55
115
|
class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
|
|
56
116
|
# @!attribute target_arns
|
|
57
117
|
# A list of platform endpoint ARNs. See
|
|
@@ -70,6 +130,62 @@ module Knockapi
|
|
|
70
130
|
# @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
|
|
71
131
|
end
|
|
72
132
|
|
|
133
|
+
class AwssnsPushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
|
|
134
|
+
# @!attribute devices
|
|
135
|
+
# A list of devices. Each device contains a target_arn, and optionally a locale
|
|
136
|
+
# and timezone.
|
|
137
|
+
#
|
|
138
|
+
# @return [Array<Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly::Device>]
|
|
139
|
+
required :devices,
|
|
140
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly::Device] }
|
|
141
|
+
|
|
142
|
+
# @!method initialize(devices:)
|
|
143
|
+
# Some parameter documentations has been truncated, see
|
|
144
|
+
# {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly}
|
|
145
|
+
# for more details.
|
|
146
|
+
#
|
|
147
|
+
# AWS SNS push channel data.
|
|
148
|
+
#
|
|
149
|
+
# @param devices [Array<Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a target_arn, and optionally a locale an
|
|
150
|
+
|
|
151
|
+
class Device < Knockapi::Internal::Type::BaseModel
|
|
152
|
+
# @!attribute target_arn
|
|
153
|
+
# The ARN of a platform endpoint associated with a platform application and a
|
|
154
|
+
# device token. See
|
|
155
|
+
# [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
|
|
156
|
+
#
|
|
157
|
+
# @return [String]
|
|
158
|
+
required :target_arn, String
|
|
159
|
+
|
|
160
|
+
# @!attribute locale
|
|
161
|
+
# The locale of the object. Used for
|
|
162
|
+
# [message localization](/concepts/translations).
|
|
163
|
+
#
|
|
164
|
+
# @return [String, nil]
|
|
165
|
+
optional :locale, String, nil?: true
|
|
166
|
+
|
|
167
|
+
# @!attribute timezone
|
|
168
|
+
# The timezone of the object. Must be a
|
|
169
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
170
|
+
# Used
|
|
171
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
172
|
+
#
|
|
173
|
+
# @return [String, nil]
|
|
174
|
+
optional :timezone, String, nil?: true
|
|
175
|
+
|
|
176
|
+
# @!method initialize(target_arn:, locale: nil, timezone: nil)
|
|
177
|
+
# Some parameter documentations has been truncated, see
|
|
178
|
+
# {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly::Device}
|
|
179
|
+
# for more details.
|
|
180
|
+
#
|
|
181
|
+
# @param target_arn [String] The ARN of a platform endpoint associated with a platform application and a devi
|
|
182
|
+
#
|
|
183
|
+
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
|
184
|
+
#
|
|
185
|
+
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
|
186
|
+
end
|
|
187
|
+
end
|
|
188
|
+
|
|
73
189
|
class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
|
|
74
190
|
# @!attribute player_ids
|
|
75
191
|
# A list of OneSignal player IDs.
|
|
@@ -84,7 +200,7 @@ module Knockapi
|
|
|
84
200
|
end
|
|
85
201
|
|
|
86
202
|
# @!method self.variants
|
|
87
|
-
# @return [Array(Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
|
203
|
+
# @return [Array(Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
|
88
204
|
end
|
|
89
205
|
end
|
|
90
206
|
end
|
|
@@ -10,9 +10,15 @@ module Knockapi
|
|
|
10
10
|
# Push channel data.
|
|
11
11
|
variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly }
|
|
12
12
|
|
|
13
|
+
# Push channel data.
|
|
14
|
+
variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly }
|
|
15
|
+
|
|
13
16
|
# AWS SNS push channel data.
|
|
14
17
|
variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly }
|
|
15
18
|
|
|
19
|
+
# AWS SNS push channel data.
|
|
20
|
+
variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly }
|
|
21
|
+
|
|
16
22
|
# OneSignal channel data.
|
|
17
23
|
variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly }
|
|
18
24
|
|
|
@@ -38,6 +44,60 @@ module Knockapi
|
|
|
38
44
|
# @param tokens [Array<String>] A list of push channel tokens.
|
|
39
45
|
end
|
|
40
46
|
|
|
47
|
+
class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
|
|
48
|
+
# @!attribute devices
|
|
49
|
+
# A list of devices. Each device contains a token, and optionally a locale and
|
|
50
|
+
# timezone.
|
|
51
|
+
#
|
|
52
|
+
# @return [Array<Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device>]
|
|
53
|
+
required :devices,
|
|
54
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device] }
|
|
55
|
+
|
|
56
|
+
# @!method initialize(devices:)
|
|
57
|
+
# Some parameter documentations has been truncated, see
|
|
58
|
+
# {Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly}
|
|
59
|
+
# for more details.
|
|
60
|
+
#
|
|
61
|
+
# Push channel data.
|
|
62
|
+
#
|
|
63
|
+
# @param devices [Array<Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a token, and optionally a locale and tim
|
|
64
|
+
|
|
65
|
+
class Device < Knockapi::Internal::Type::BaseModel
|
|
66
|
+
# @!attribute token
|
|
67
|
+
# The device token to send the push notification to.
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
required :token, String
|
|
71
|
+
|
|
72
|
+
# @!attribute locale
|
|
73
|
+
# The locale of the object. Used for
|
|
74
|
+
# [message localization](/concepts/translations).
|
|
75
|
+
#
|
|
76
|
+
# @return [String, nil]
|
|
77
|
+
optional :locale, String, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!attribute timezone
|
|
80
|
+
# The timezone of the object. Must be a
|
|
81
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
82
|
+
# Used
|
|
83
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
84
|
+
#
|
|
85
|
+
# @return [String, nil]
|
|
86
|
+
optional :timezone, String, nil?: true
|
|
87
|
+
|
|
88
|
+
# @!method initialize(token:, locale: nil, timezone: nil)
|
|
89
|
+
# Some parameter documentations has been truncated, see
|
|
90
|
+
# {Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::Device}
|
|
91
|
+
# for more details.
|
|
92
|
+
#
|
|
93
|
+
# @param token [String] The device token to send the push notification to.
|
|
94
|
+
#
|
|
95
|
+
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
|
96
|
+
#
|
|
97
|
+
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
41
101
|
class AwssnsPushChannelDataTargetArNsOnly < Knockapi::Internal::Type::BaseModel
|
|
42
102
|
# @!attribute target_arns
|
|
43
103
|
# A list of platform endpoint ARNs. See
|
|
@@ -56,6 +116,62 @@ module Knockapi
|
|
|
56
116
|
# @param target_arns [Array<String>] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin
|
|
57
117
|
end
|
|
58
118
|
|
|
119
|
+
class AwssnsPushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
|
|
120
|
+
# @!attribute devices
|
|
121
|
+
# A list of devices. Each device contains a target_arn, and optionally a locale
|
|
122
|
+
# and timezone.
|
|
123
|
+
#
|
|
124
|
+
# @return [Array<Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device>]
|
|
125
|
+
required :devices,
|
|
126
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device] }
|
|
127
|
+
|
|
128
|
+
# @!method initialize(devices:)
|
|
129
|
+
# Some parameter documentations has been truncated, see
|
|
130
|
+
# {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly}
|
|
131
|
+
# for more details.
|
|
132
|
+
#
|
|
133
|
+
# AWS SNS push channel data.
|
|
134
|
+
#
|
|
135
|
+
# @param devices [Array<Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device>] A list of devices. Each device contains a target_arn, and optionally a locale an
|
|
136
|
+
|
|
137
|
+
class Device < Knockapi::Internal::Type::BaseModel
|
|
138
|
+
# @!attribute target_arn
|
|
139
|
+
# The ARN of a platform endpoint associated with a platform application and a
|
|
140
|
+
# device token. See
|
|
141
|
+
# [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
|
|
142
|
+
#
|
|
143
|
+
# @return [String]
|
|
144
|
+
required :target_arn, String
|
|
145
|
+
|
|
146
|
+
# @!attribute locale
|
|
147
|
+
# The locale of the object. Used for
|
|
148
|
+
# [message localization](/concepts/translations).
|
|
149
|
+
#
|
|
150
|
+
# @return [String, nil]
|
|
151
|
+
optional :locale, String, nil?: true
|
|
152
|
+
|
|
153
|
+
# @!attribute timezone
|
|
154
|
+
# The timezone of the object. Must be a
|
|
155
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
156
|
+
# Used
|
|
157
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
158
|
+
#
|
|
159
|
+
# @return [String, nil]
|
|
160
|
+
optional :timezone, String, nil?: true
|
|
161
|
+
|
|
162
|
+
# @!method initialize(target_arn:, locale: nil, timezone: nil)
|
|
163
|
+
# Some parameter documentations has been truncated, see
|
|
164
|
+
# {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::Device}
|
|
165
|
+
# for more details.
|
|
166
|
+
#
|
|
167
|
+
# @param target_arn [String] The ARN of a platform endpoint associated with a platform application and a devi
|
|
168
|
+
#
|
|
169
|
+
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
|
170
|
+
#
|
|
171
|
+
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
|
|
59
175
|
class OneSignalChannelDataPlayerIDsOnly < Knockapi::Internal::Type::BaseModel
|
|
60
176
|
# @!attribute player_ids
|
|
61
177
|
# A list of OneSignal player IDs.
|
|
@@ -70,7 +186,7 @@ module Knockapi
|
|
|
70
186
|
end
|
|
71
187
|
|
|
72
188
|
# @!method self.variants
|
|
73
|
-
# @return [Array(Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
|
189
|
+
# @return [Array(Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
|
74
190
|
end
|
|
75
191
|
|
|
76
192
|
# @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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
15
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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
|
#
|
|
@@ -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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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
|
#
|
data/lib/knockapi/version.rb
CHANGED
|
@@ -20,7 +20,9 @@ module Knockapi
|
|
|
20
20
|
Symbol,
|
|
21
21
|
T.any(
|
|
22
22
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
|
|
23
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
|
|
23
24
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
|
|
25
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
|
|
24
26
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
|
|
25
27
|
Knockapi::Recipients::SlackChannelData,
|
|
26
28
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
@@ -82,7 +84,9 @@ module Knockapi
|
|
|
82
84
|
Symbol,
|
|
83
85
|
T.any(
|
|
84
86
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
|
|
87
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::OrHash,
|
|
85
88
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
|
|
89
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::OrHash,
|
|
86
90
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
87
91
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
88
92
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
@@ -143,7 +147,9 @@ module Knockapi
|
|
|
143
147
|
Symbol,
|
|
144
148
|
T.any(
|
|
145
149
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
|
|
150
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
|
|
146
151
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
|
|
152
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
|
|
147
153
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
|
|
148
154
|
Knockapi::Recipients::SlackChannelData,
|
|
149
155
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
@@ -27,7 +27,9 @@ module Knockapi
|
|
|
27
27
|
Symbol,
|
|
28
28
|
T.any(
|
|
29
29
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
|
|
30
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
|
|
30
31
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
|
|
32
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
|
|
31
33
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
|
|
32
34
|
Knockapi::Recipients::SlackChannelData,
|
|
33
35
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
@@ -91,7 +93,9 @@ module Knockapi
|
|
|
91
93
|
Symbol,
|
|
92
94
|
T.any(
|
|
93
95
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
|
|
96
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::OrHash,
|
|
94
97
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
|
|
98
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::OrHash,
|
|
95
99
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
96
100
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
97
101
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
@@ -155,7 +159,9 @@ module Knockapi
|
|
|
155
159
|
Symbol,
|
|
156
160
|
T.any(
|
|
157
161
|
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
|
|
162
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
|
|
158
163
|
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
|
|
164
|
+
Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
|
|
159
165
|
Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
|
|
160
166
|
Knockapi::Recipients::SlackChannelData,
|
|
161
167
|
Knockapi::Recipients::MsTeamsChannelData,
|