knockapi 1.11.2 → 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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -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/message.rb +65 -65
- 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.rb +25 -3
- data/lib/knockapi/models/recipients/channel_data_request.rb +24 -3
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +22 -1
- data/lib/knockapi/models/tenant_request.rb +2 -2
- data/lib/knockapi/models/tenant_set_params.rb +2 -2
- data/lib/knockapi/models/users/guide_get_channel_response.rb +9 -1
- 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 +3 -0
- data/rbi/knockapi/models/inline_identify_user_request.rbi +3 -0
- data/rbi/knockapi/models/inline_object_request.rbi +3 -0
- data/rbi/knockapi/models/message.rbi +76 -112
- data/rbi/knockapi/models/object_set_params.rbi +4 -0
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +3 -0
- data/rbi/knockapi/models/recipients/channel_data.rbi +39 -2
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +34 -0
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +31 -0
- data/rbi/knockapi/models/tenant_request.rbi +3 -0
- data/rbi/knockapi/models/tenant_set_params.rbi +3 -0
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +11 -0
- data/rbi/knockapi/resources/objects.rbi +2 -0
- data/rbi/knockapi/resources/tenants.rbi +1 -0
- data/rbi/knockapi/resources/users.rbi +2 -0
- data/sig/knockapi/models/message.rbs +37 -61
- data/sig/knockapi/models/recipients/channel_data.rbs +13 -0
- data/sig/knockapi/models/recipients/channel_data_request.rbs +11 -0
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +11 -0
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +7 -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: de4f4337ddae3ff013f23c8ab79b48785b5bbf34ed79d31dad83b5111a98330f
|
4
|
+
data.tar.gz: ea934f1d6c8128e2bdcb55d14e7904f8da88cfe73e7e0791dc293e5428f997f0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4599b2cbbdbdaeda625d4a5b383d19a28fec88c9fe6d33a279967c1f11fa8f96af8c6c20ee1c94c0041137a5c0916fc96ad5903e9ae7e636dd9f1435356d83a3
|
7
|
+
data.tar.gz: 290da7f20e22193ea4b6f0488c9c23cf05f017dada61b9742993b75472944e32d4ffc7cf9e4129299da40a6eef1a4aa3c35bd9c01529c9e81593519270c605e2
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,28 @@
|
|
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
|
+
|
15
|
+
## 1.12.0 (2025-09-02)
|
16
|
+
|
17
|
+
Full Changelog: [v1.11.2...v1.12.0](https://github.com/knocklabs/knock-ruby/compare/v1.11.2...v1.12.0)
|
18
|
+
|
19
|
+
### Features
|
20
|
+
|
21
|
+
* **api:** api update ([eb5bc19](https://github.com/knocklabs/knock-ruby/commit/eb5bc19f01bd3967f65d9a1f744198e670c8648a))
|
22
|
+
* **api:** api update ([6e8b935](https://github.com/knocklabs/knock-ruby/commit/6e8b93592161426bc6bd262ede1c88708a34d399))
|
23
|
+
* **api:** api update ([96f3d1b](https://github.com/knocklabs/knock-ruby/commit/96f3d1b4edb8123888e44f16b55179fcd0d91c87))
|
24
|
+
* **api:** api update ([1cd8e5b](https://github.com/knocklabs/knock-ruby/commit/1cd8e5b87e259796d04e9a64292e41c905ce8a0f))
|
25
|
+
|
3
26
|
## 1.11.2 (2025-08-24)
|
4
27
|
|
5
28
|
Full Changelog: [v1.11.1...v1.11.2](https://github.com/knocklabs/knock-ruby/compare/v1.11.1...v1.11.2)
|
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::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
|
#
|
@@ -7,14 +7,58 @@ module Knockapi
|
|
7
7
|
# @!attribute id
|
8
8
|
# The unique identifier for the message.
|
9
9
|
#
|
10
|
-
# @return [String
|
11
|
-
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
12
|
|
13
13
|
# @!attribute _typename
|
14
14
|
# The typename of the schema.
|
15
15
|
#
|
16
|
-
# @return [String
|
17
|
-
|
16
|
+
# @return [String]
|
17
|
+
required :_typename, String, api_name: :__typename
|
18
|
+
|
19
|
+
# @!attribute channel_id
|
20
|
+
# The ID for the channel the message was sent through.
|
21
|
+
#
|
22
|
+
# @return [String]
|
23
|
+
required :channel_id, String
|
24
|
+
|
25
|
+
# @!attribute engagement_statuses
|
26
|
+
# A list of engagement statuses.
|
27
|
+
#
|
28
|
+
# @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>]
|
29
|
+
required :engagement_statuses,
|
30
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
|
31
|
+
|
32
|
+
# @!attribute inserted_at
|
33
|
+
# Timestamp when the resource was created.
|
34
|
+
#
|
35
|
+
# @return [Time]
|
36
|
+
required :inserted_at, Time
|
37
|
+
|
38
|
+
# @!attribute recipient
|
39
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
40
|
+
# reference (ID, collection).
|
41
|
+
#
|
42
|
+
# @return [String, Knockapi::Models::RecipientReference::ObjectReference]
|
43
|
+
required :recipient, union: -> { Knockapi::RecipientReference }
|
44
|
+
|
45
|
+
# @!attribute source
|
46
|
+
# The workflow that triggered the message.
|
47
|
+
#
|
48
|
+
# @return [Knockapi::Models::Message::Source]
|
49
|
+
required :source, -> { Knockapi::Message::Source }
|
50
|
+
|
51
|
+
# @!attribute status
|
52
|
+
# The message delivery status.
|
53
|
+
#
|
54
|
+
# @return [Symbol, Knockapi::Models::Message::Status]
|
55
|
+
required :status, enum: -> { Knockapi::Message::Status }
|
56
|
+
|
57
|
+
# @!attribute updated_at
|
58
|
+
# The timestamp when the resource was last updated.
|
59
|
+
#
|
60
|
+
# @return [Time]
|
61
|
+
required :updated_at, Time
|
18
62
|
|
19
63
|
# @!attribute actors
|
20
64
|
# One or more actors that are associated with this message. Note: this is a list
|
@@ -30,12 +74,6 @@ module Knockapi
|
|
30
74
|
# @return [Time, nil]
|
31
75
|
optional :archived_at, Time, nil?: true
|
32
76
|
|
33
|
-
# @!attribute channel_id
|
34
|
-
# The ID for the channel the message was sent through.
|
35
|
-
#
|
36
|
-
# @return [String, nil]
|
37
|
-
optional :channel_id, String
|
38
|
-
|
39
77
|
# @!attribute clicked_at
|
40
78
|
# Timestamp when the message was clicked.
|
41
79
|
#
|
@@ -52,19 +90,6 @@ module Knockapi
|
|
52
90
|
# @return [Hash{Symbol=>Object}, nil]
|
53
91
|
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
|
54
92
|
|
55
|
-
# @!attribute engagement_statuses
|
56
|
-
# A list of engagement statuses.
|
57
|
-
#
|
58
|
-
# @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>, nil]
|
59
|
-
optional :engagement_statuses,
|
60
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
|
61
|
-
|
62
|
-
# @!attribute inserted_at
|
63
|
-
# Timestamp when the resource was created.
|
64
|
-
#
|
65
|
-
# @return [Time, nil]
|
66
|
-
optional :inserted_at, Time
|
67
|
-
|
68
93
|
# @!attribute interacted_at
|
69
94
|
# Timestamp when the message was interacted with.
|
70
95
|
#
|
@@ -89,13 +114,6 @@ module Knockapi
|
|
89
114
|
# @return [Time, nil]
|
90
115
|
optional :read_at, Time, nil?: true
|
91
116
|
|
92
|
-
# @!attribute recipient
|
93
|
-
# A reference to a recipient, either a user identifier (string) or an object
|
94
|
-
# reference (ID, collection).
|
95
|
-
#
|
96
|
-
# @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
|
97
|
-
optional :recipient, union: -> { Knockapi::RecipientReference }
|
98
|
-
|
99
117
|
# @!attribute scheduled_at
|
100
118
|
# Timestamp when the message was scheduled to be sent.
|
101
119
|
#
|
@@ -108,18 +126,6 @@ module Knockapi
|
|
108
126
|
# @return [Time, nil]
|
109
127
|
optional :seen_at, Time, nil?: true
|
110
128
|
|
111
|
-
# @!attribute source
|
112
|
-
# The workflow that triggered the message.
|
113
|
-
#
|
114
|
-
# @return [Knockapi::Models::Message::Source, nil]
|
115
|
-
optional :source, -> { Knockapi::Message::Source }
|
116
|
-
|
117
|
-
# @!attribute status
|
118
|
-
# The message delivery status.
|
119
|
-
#
|
120
|
-
# @return [Symbol, Knockapi::Models::Message::Status, nil]
|
121
|
-
optional :status, enum: -> { Knockapi::Message::Status }
|
122
|
-
|
123
129
|
# @!attribute tenant
|
124
130
|
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
125
131
|
# is provided on a workflow trigger request.
|
@@ -127,12 +133,6 @@ module Knockapi
|
|
127
133
|
# @return [String, nil]
|
128
134
|
optional :tenant, String, nil?: true
|
129
135
|
|
130
|
-
# @!attribute updated_at
|
131
|
-
# The timestamp when the resource was last updated.
|
132
|
-
#
|
133
|
-
# @return [Time, nil]
|
134
|
-
optional :updated_at, Time
|
135
|
-
|
136
136
|
# @!attribute workflow
|
137
137
|
# @deprecated
|
138
138
|
#
|
@@ -141,7 +141,7 @@ module Knockapi
|
|
141
141
|
# @return [String, nil]
|
142
142
|
optional :workflow, String, nil?: true
|
143
143
|
|
144
|
-
# @!method initialize(id
|
144
|
+
# @!method initialize(id:, _typename:, channel_id:, engagement_statuses:, inserted_at:, recipient:, source:, status:, updated_at:, actors: nil, archived_at: nil, clicked_at: nil, data: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, scheduled_at: nil, seen_at: nil, tenant: nil, workflow: nil)
|
145
145
|
# Some parameter documentations has been truncated, see
|
146
146
|
# {Knockapi::Models::Message} for more details.
|
147
147
|
#
|
@@ -152,20 +152,28 @@ module Knockapi
|
|
152
152
|
#
|
153
153
|
# @param _typename [String] The typename of the schema.
|
154
154
|
#
|
155
|
+
# @param channel_id [String] The ID for the channel the message was sent through.
|
156
|
+
#
|
157
|
+
# @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
|
158
|
+
#
|
159
|
+
# @param inserted_at [Time] Timestamp when the resource was created.
|
160
|
+
#
|
161
|
+
# @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
162
|
+
#
|
163
|
+
# @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
|
164
|
+
#
|
165
|
+
# @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
|
166
|
+
#
|
167
|
+
# @param updated_at [Time] The timestamp when the resource was last updated.
|
168
|
+
#
|
155
169
|
# @param actors [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
|
156
170
|
#
|
157
171
|
# @param archived_at [Time, nil] Timestamp when the message was archived.
|
158
172
|
#
|
159
|
-
# @param channel_id [String] The ID for the channel the message was sent through.
|
160
|
-
#
|
161
173
|
# @param clicked_at [Time, nil] Timestamp when the message was clicked.
|
162
174
|
#
|
163
175
|
# @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
|
164
176
|
#
|
165
|
-
# @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
|
166
|
-
#
|
167
|
-
# @param inserted_at [Time] Timestamp when the resource was created.
|
168
|
-
#
|
169
177
|
# @param interacted_at [Time, nil] Timestamp when the message was interacted with.
|
170
178
|
#
|
171
179
|
# @param link_clicked_at [Time, nil] Timestamp when a link in the message was clicked.
|
@@ -174,20 +182,12 @@ module Knockapi
|
|
174
182
|
#
|
175
183
|
# @param read_at [Time, nil] Timestamp when the message was read.
|
176
184
|
#
|
177
|
-
# @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
178
|
-
#
|
179
185
|
# @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
|
180
186
|
#
|
181
187
|
# @param seen_at [Time, nil] Timestamp when the message was seen.
|
182
188
|
#
|
183
|
-
# @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
|
184
|
-
#
|
185
|
-
# @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
|
186
|
-
#
|
187
189
|
# @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
|
188
190
|
#
|
189
|
-
# @param updated_at [Time] The timestamp when the resource was last updated.
|
190
|
-
#
|
191
191
|
# @param workflow [String, nil] The key of the workflow that generated the message.
|
192
192
|
|
193
193
|
# An engagement status for a message. Can be one of: read, seen, interacted,
|
@@ -231,7 +231,7 @@ module Knockapi
|
|
231
231
|
required :version_id, String
|
232
232
|
|
233
233
|
# @!attribute step_ref
|
234
|
-
# The step reference for the step in the workflow that generated the message
|
234
|
+
# The step reference for the step in the workflow that generated the message.
|
235
235
|
#
|
236
236
|
# @return [String, nil]
|
237
237
|
optional :step_ref, String, nil?: true
|
@@ -247,7 +247,7 @@ module Knockapi
|
|
247
247
|
#
|
248
248
|
# @param version_id [String] The ID of the version of the workflow that triggered the message.
|
249
249
|
#
|
250
|
-
# @param step_ref [String, nil] The step reference for the step in the workflow that generated the message
|
250
|
+
# @param step_ref [String, nil] The step reference for the step in the workflow that generated the message.
|
251
251
|
end
|
252
252
|
|
253
253
|
# The message delivery status.
|
@@ -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
|
#
|