knockapi 1.11.1 → 1.12.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 +19 -0
- data/README.md +1 -1
- data/lib/knockapi/models/message.rb +65 -65
- data/lib/knockapi/version.rb +1 -1
- data/rbi/knockapi/models/message.rbi +76 -112
- data/sig/knockapi/models/message.rbs +37 -61
- 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: 0f70bdc48166f046ccdf747cb8b1b5f0243f426fd44c1cb0a8755398de49ba15
|
4
|
+
data.tar.gz: 56964c493eefa8d2074e731d555a8de08bf631203ca3fd0ed6e5b46e1844f9b4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 59aabd5b5cee769894c14541a886f3832d69970d91de6620965c910b1a3029252f259be7f527687b06c090d3ab13e01ad97b2b117fe0b2ee4fea0f5eb99f8b43
|
7
|
+
data.tar.gz: c3f89f7634d3fa6026bce31e6be0ca6c3765a680fe47e74b4f60e73173b2ac18087feafe0d30b79e7f8991a5e3bb98176f0ffffd53b865d9b4211a5fa4389aa1
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,24 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.12.0 (2025-09-02)
|
4
|
+
|
5
|
+
Full Changelog: [v1.11.2...v1.12.0](https://github.com/knocklabs/knock-ruby/compare/v1.11.2...v1.12.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([eb5bc19](https://github.com/knocklabs/knock-ruby/commit/eb5bc19f01bd3967f65d9a1f744198e670c8648a))
|
10
|
+
* **api:** api update ([6e8b935](https://github.com/knocklabs/knock-ruby/commit/6e8b93592161426bc6bd262ede1c88708a34d399))
|
11
|
+
* **api:** api update ([96f3d1b](https://github.com/knocklabs/knock-ruby/commit/96f3d1b4edb8123888e44f16b55179fcd0d91c87))
|
12
|
+
* **api:** api update ([1cd8e5b](https://github.com/knocklabs/knock-ruby/commit/1cd8e5b87e259796d04e9a64292e41c905ce8a0f))
|
13
|
+
|
14
|
+
## 1.11.2 (2025-08-24)
|
15
|
+
|
16
|
+
Full Changelog: [v1.11.1...v1.11.2](https://github.com/knocklabs/knock-ruby/compare/v1.11.1...v1.11.2)
|
17
|
+
|
18
|
+
### Chores
|
19
|
+
|
20
|
+
* add json schema comment for rubocop.yml ([83abcfa](https://github.com/knocklabs/knock-ruby/commit/83abcfa2c17d0495243044a3868ed3e26120c1c3))
|
21
|
+
|
3
22
|
## 1.11.1 (2025-08-19)
|
4
23
|
|
5
24
|
Full Changelog: [v1.11.0...v1.11.1](https://github.com/knocklabs/knock-ruby/compare/v1.11.0...v1.11.1)
|
data/README.md
CHANGED
@@ -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.
|
data/lib/knockapi/version.rb
CHANGED
@@ -7,18 +7,46 @@ module Knockapi
|
|
7
7
|
T.type_alias { T.any(Knockapi::Message, Knockapi::Internal::AnyHash) }
|
8
8
|
|
9
9
|
# The unique identifier for the message.
|
10
|
-
sig { returns(
|
11
|
-
|
12
|
-
|
13
|
-
sig { params(id: String).void }
|
14
|
-
attr_writer :id
|
10
|
+
sig { returns(String) }
|
11
|
+
attr_accessor :id
|
15
12
|
|
16
13
|
# The typename of the schema.
|
17
|
-
sig { returns(
|
18
|
-
|
14
|
+
sig { returns(String) }
|
15
|
+
attr_accessor :_typename
|
16
|
+
|
17
|
+
# The ID for the channel the message was sent through.
|
18
|
+
sig { returns(String) }
|
19
|
+
attr_accessor :channel_id
|
20
|
+
|
21
|
+
# A list of engagement statuses.
|
22
|
+
sig do
|
23
|
+
returns(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol])
|
24
|
+
end
|
25
|
+
attr_accessor :engagement_statuses
|
26
|
+
|
27
|
+
# Timestamp when the resource was created.
|
28
|
+
sig { returns(Time) }
|
29
|
+
attr_accessor :inserted_at
|
30
|
+
|
31
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
32
|
+
# reference (ID, collection).
|
33
|
+
sig { returns(Knockapi::RecipientReference::Variants) }
|
34
|
+
attr_accessor :recipient
|
35
|
+
|
36
|
+
# The workflow that triggered the message.
|
37
|
+
sig { returns(Knockapi::Message::Source) }
|
38
|
+
attr_reader :source
|
39
|
+
|
40
|
+
sig { params(source: Knockapi::Message::Source::OrHash).void }
|
41
|
+
attr_writer :source
|
42
|
+
|
43
|
+
# The message delivery status.
|
44
|
+
sig { returns(Knockapi::Message::Status::TaggedSymbol) }
|
45
|
+
attr_accessor :status
|
19
46
|
|
20
|
-
|
21
|
-
|
47
|
+
# The timestamp when the resource was last updated.
|
48
|
+
sig { returns(Time) }
|
49
|
+
attr_accessor :updated_at
|
22
50
|
|
23
51
|
# One or more actors that are associated with this message. Note: this is a list
|
24
52
|
# that can contain up to 10 actors if the message is produced from a
|
@@ -45,13 +73,6 @@ module Knockapi
|
|
45
73
|
sig { returns(T.nilable(Time)) }
|
46
74
|
attr_accessor :archived_at
|
47
75
|
|
48
|
-
# The ID for the channel the message was sent through.
|
49
|
-
sig { returns(T.nilable(String)) }
|
50
|
-
attr_reader :channel_id
|
51
|
-
|
52
|
-
sig { params(channel_id: String).void }
|
53
|
-
attr_writer :channel_id
|
54
|
-
|
55
76
|
# Timestamp when the message was clicked.
|
56
77
|
sig { returns(T.nilable(Time)) }
|
57
78
|
attr_accessor :clicked_at
|
@@ -64,29 +85,6 @@ module Knockapi
|
|
64
85
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
65
86
|
attr_accessor :data
|
66
87
|
|
67
|
-
# A list of engagement statuses.
|
68
|
-
sig do
|
69
|
-
returns(
|
70
|
-
T.nilable(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol])
|
71
|
-
)
|
72
|
-
end
|
73
|
-
attr_reader :engagement_statuses
|
74
|
-
|
75
|
-
sig do
|
76
|
-
params(
|
77
|
-
engagement_statuses:
|
78
|
-
T::Array[Knockapi::Message::EngagementStatus::OrSymbol]
|
79
|
-
).void
|
80
|
-
end
|
81
|
-
attr_writer :engagement_statuses
|
82
|
-
|
83
|
-
# Timestamp when the resource was created.
|
84
|
-
sig { returns(T.nilable(Time)) }
|
85
|
-
attr_reader :inserted_at
|
86
|
-
|
87
|
-
sig { params(inserted_at: Time).void }
|
88
|
-
attr_writer :inserted_at
|
89
|
-
|
90
88
|
# Timestamp when the message was interacted with.
|
91
89
|
sig { returns(T.nilable(Time)) }
|
92
90
|
attr_accessor :interacted_at
|
@@ -103,19 +101,6 @@ module Knockapi
|
|
103
101
|
sig { returns(T.nilable(Time)) }
|
104
102
|
attr_accessor :read_at
|
105
103
|
|
106
|
-
# A reference to a recipient, either a user identifier (string) or an object
|
107
|
-
# reference (ID, collection).
|
108
|
-
sig { returns(T.nilable(Knockapi::RecipientReference::Variants)) }
|
109
|
-
attr_reader :recipient
|
110
|
-
|
111
|
-
sig do
|
112
|
-
params(
|
113
|
-
recipient:
|
114
|
-
T.any(String, Knockapi::RecipientReference::ObjectReference::OrHash)
|
115
|
-
).void
|
116
|
-
end
|
117
|
-
attr_writer :recipient
|
118
|
-
|
119
104
|
# Timestamp when the message was scheduled to be sent.
|
120
105
|
sig { returns(T.nilable(Time)) }
|
121
106
|
attr_accessor :scheduled_at
|
@@ -124,32 +109,11 @@ module Knockapi
|
|
124
109
|
sig { returns(T.nilable(Time)) }
|
125
110
|
attr_accessor :seen_at
|
126
111
|
|
127
|
-
# The workflow that triggered the message.
|
128
|
-
sig { returns(T.nilable(Knockapi::Message::Source)) }
|
129
|
-
attr_reader :source
|
130
|
-
|
131
|
-
sig { params(source: Knockapi::Message::Source::OrHash).void }
|
132
|
-
attr_writer :source
|
133
|
-
|
134
|
-
# The message delivery status.
|
135
|
-
sig { returns(T.nilable(Knockapi::Message::Status::TaggedSymbol)) }
|
136
|
-
attr_reader :status
|
137
|
-
|
138
|
-
sig { params(status: Knockapi::Message::Status::OrSymbol).void }
|
139
|
-
attr_writer :status
|
140
|
-
|
141
112
|
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
142
113
|
# is provided on a workflow trigger request.
|
143
114
|
sig { returns(T.nilable(String)) }
|
144
115
|
attr_accessor :tenant
|
145
116
|
|
146
|
-
# The timestamp when the resource was last updated.
|
147
|
-
sig { returns(T.nilable(Time)) }
|
148
|
-
attr_reader :updated_at
|
149
|
-
|
150
|
-
sig { params(updated_at: Time).void }
|
151
|
-
attr_writer :updated_at
|
152
|
-
|
153
117
|
# The key of the workflow that generated the message.
|
154
118
|
sig { returns(T.nilable(String)) }
|
155
119
|
attr_accessor :workflow
|
@@ -160,6 +124,18 @@ module Knockapi
|
|
160
124
|
params(
|
161
125
|
id: String,
|
162
126
|
_typename: String,
|
127
|
+
channel_id: String,
|
128
|
+
engagement_statuses:
|
129
|
+
T::Array[Knockapi::Message::EngagementStatus::OrSymbol],
|
130
|
+
inserted_at: Time,
|
131
|
+
recipient:
|
132
|
+
T.any(
|
133
|
+
String,
|
134
|
+
Knockapi::RecipientReference::ObjectReference::OrHash
|
135
|
+
),
|
136
|
+
source: Knockapi::Message::Source::OrHash,
|
137
|
+
status: Knockapi::Message::Status::OrSymbol,
|
138
|
+
updated_at: Time,
|
163
139
|
actors:
|
164
140
|
T::Array[
|
165
141
|
T.any(
|
@@ -168,43 +144,44 @@ module Knockapi
|
|
168
144
|
)
|
169
145
|
],
|
170
146
|
archived_at: T.nilable(Time),
|
171
|
-
channel_id: String,
|
172
147
|
clicked_at: T.nilable(Time),
|
173
148
|
data: T.nilable(T::Hash[Symbol, T.anything]),
|
174
|
-
engagement_statuses:
|
175
|
-
T::Array[Knockapi::Message::EngagementStatus::OrSymbol],
|
176
|
-
inserted_at: Time,
|
177
149
|
interacted_at: T.nilable(Time),
|
178
150
|
link_clicked_at: T.nilable(Time),
|
179
151
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
180
152
|
read_at: T.nilable(Time),
|
181
|
-
recipient:
|
182
|
-
T.any(
|
183
|
-
String,
|
184
|
-
Knockapi::RecipientReference::ObjectReference::OrHash
|
185
|
-
),
|
186
153
|
scheduled_at: T.nilable(Time),
|
187
154
|
seen_at: T.nilable(Time),
|
188
|
-
source: Knockapi::Message::Source::OrHash,
|
189
|
-
status: Knockapi::Message::Status::OrSymbol,
|
190
155
|
tenant: T.nilable(String),
|
191
|
-
updated_at: Time,
|
192
156
|
workflow: T.nilable(String)
|
193
157
|
).returns(T.attached_class)
|
194
158
|
end
|
195
159
|
def self.new(
|
196
160
|
# The unique identifier for the message.
|
197
|
-
id
|
161
|
+
id:,
|
198
162
|
# The typename of the schema.
|
199
|
-
_typename
|
163
|
+
_typename:,
|
164
|
+
# The ID for the channel the message was sent through.
|
165
|
+
channel_id:,
|
166
|
+
# A list of engagement statuses.
|
167
|
+
engagement_statuses:,
|
168
|
+
# Timestamp when the resource was created.
|
169
|
+
inserted_at:,
|
170
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
171
|
+
# reference (ID, collection).
|
172
|
+
recipient:,
|
173
|
+
# The workflow that triggered the message.
|
174
|
+
source:,
|
175
|
+
# The message delivery status.
|
176
|
+
status:,
|
177
|
+
# The timestamp when the resource was last updated.
|
178
|
+
updated_at:,
|
200
179
|
# One or more actors that are associated with this message. Note: this is a list
|
201
180
|
# that can contain up to 10 actors if the message is produced from a
|
202
181
|
# [batch](/designing-workflows/batch-function).
|
203
182
|
actors: nil,
|
204
183
|
# Timestamp when the message was archived.
|
205
184
|
archived_at: nil,
|
206
|
-
# The ID for the channel the message was sent through.
|
207
|
-
channel_id: nil,
|
208
185
|
# Timestamp when the message was clicked.
|
209
186
|
clicked_at: nil,
|
210
187
|
# Data associated with the message’s workflow run. Includes the workflow trigger
|
@@ -213,10 +190,6 @@ module Knockapi
|
|
213
190
|
# after a [batch step](/designing-workflows/batch-function), includes the payload
|
214
191
|
# `data` from the most-recent trigger request (the final `activity` in the batch).
|
215
192
|
data: nil,
|
216
|
-
# A list of engagement statuses.
|
217
|
-
engagement_statuses: nil,
|
218
|
-
# Timestamp when the resource was created.
|
219
|
-
inserted_at: nil,
|
220
193
|
# Timestamp when the message was interacted with.
|
221
194
|
interacted_at: nil,
|
222
195
|
# Timestamp when a link in the message was clicked.
|
@@ -225,22 +198,13 @@ module Knockapi
|
|
225
198
|
metadata: nil,
|
226
199
|
# Timestamp when the message was read.
|
227
200
|
read_at: nil,
|
228
|
-
# A reference to a recipient, either a user identifier (string) or an object
|
229
|
-
# reference (ID, collection).
|
230
|
-
recipient: nil,
|
231
201
|
# Timestamp when the message was scheduled to be sent.
|
232
202
|
scheduled_at: nil,
|
233
203
|
# Timestamp when the message was seen.
|
234
204
|
seen_at: nil,
|
235
|
-
# The workflow that triggered the message.
|
236
|
-
source: nil,
|
237
|
-
# The message delivery status.
|
238
|
-
status: nil,
|
239
205
|
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
240
206
|
# is provided on a workflow trigger request.
|
241
207
|
tenant: nil,
|
242
|
-
# The timestamp when the resource was last updated.
|
243
|
-
updated_at: nil,
|
244
208
|
# The key of the workflow that generated the message.
|
245
209
|
workflow: nil
|
246
210
|
)
|
@@ -251,25 +215,25 @@ module Knockapi
|
|
251
215
|
{
|
252
216
|
id: String,
|
253
217
|
_typename: String,
|
254
|
-
actors: T::Array[Knockapi::RecipientReference::Variants],
|
255
|
-
archived_at: T.nilable(Time),
|
256
218
|
channel_id: String,
|
257
|
-
clicked_at: T.nilable(Time),
|
258
|
-
data: T.nilable(T::Hash[Symbol, T.anything]),
|
259
219
|
engagement_statuses:
|
260
220
|
T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol],
|
261
221
|
inserted_at: Time,
|
222
|
+
recipient: Knockapi::RecipientReference::Variants,
|
223
|
+
source: Knockapi::Message::Source,
|
224
|
+
status: Knockapi::Message::Status::TaggedSymbol,
|
225
|
+
updated_at: Time,
|
226
|
+
actors: T::Array[Knockapi::RecipientReference::Variants],
|
227
|
+
archived_at: T.nilable(Time),
|
228
|
+
clicked_at: T.nilable(Time),
|
229
|
+
data: T.nilable(T::Hash[Symbol, T.anything]),
|
262
230
|
interacted_at: T.nilable(Time),
|
263
231
|
link_clicked_at: T.nilable(Time),
|
264
232
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
265
233
|
read_at: T.nilable(Time),
|
266
|
-
recipient: Knockapi::RecipientReference::Variants,
|
267
234
|
scheduled_at: T.nilable(Time),
|
268
235
|
seen_at: T.nilable(Time),
|
269
|
-
source: Knockapi::Message::Source,
|
270
|
-
status: Knockapi::Message::Status::TaggedSymbol,
|
271
236
|
tenant: T.nilable(String),
|
272
|
-
updated_at: Time,
|
273
237
|
workflow: T.nilable(String)
|
274
238
|
}
|
275
239
|
)
|
@@ -328,7 +292,7 @@ module Knockapi
|
|
328
292
|
sig { returns(String) }
|
329
293
|
attr_accessor :version_id
|
330
294
|
|
331
|
-
# The step reference for the step in the workflow that generated the message
|
295
|
+
# The step reference for the step in the workflow that generated the message.
|
332
296
|
sig { returns(T.nilable(String)) }
|
333
297
|
attr_accessor :step_ref
|
334
298
|
|
@@ -350,7 +314,7 @@ module Knockapi
|
|
350
314
|
key:,
|
351
315
|
# The ID of the version of the workflow that triggered the message.
|
352
316
|
version_id:,
|
353
|
-
# The step reference for the step in the workflow that generated the message
|
317
|
+
# The step reference for the step in the workflow that generated the message.
|
354
318
|
step_ref: nil
|
355
319
|
)
|
356
320
|
end
|
@@ -4,35 +4,45 @@ module Knockapi
|
|
4
4
|
{
|
5
5
|
id: String,
|
6
6
|
_typename: String,
|
7
|
+
channel_id: String,
|
8
|
+
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
9
|
+
inserted_at: Time,
|
10
|
+
recipient: Knockapi::Models::recipient_reference,
|
11
|
+
source: Knockapi::Message::Source,
|
12
|
+
status: Knockapi::Models::Message::status,
|
13
|
+
updated_at: Time,
|
7
14
|
actors: ::Array[Knockapi::Models::recipient_reference],
|
8
15
|
archived_at: Time?,
|
9
|
-
channel_id: String,
|
10
16
|
clicked_at: Time?,
|
11
17
|
data: ::Hash[Symbol, top]?,
|
12
|
-
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
13
|
-
inserted_at: Time,
|
14
18
|
interacted_at: Time?,
|
15
19
|
link_clicked_at: Time?,
|
16
20
|
metadata: ::Hash[Symbol, top]?,
|
17
21
|
read_at: Time?,
|
18
|
-
recipient: Knockapi::Models::recipient_reference,
|
19
22
|
scheduled_at: Time?,
|
20
23
|
seen_at: Time?,
|
21
|
-
source: Knockapi::Message::Source,
|
22
|
-
status: Knockapi::Models::Message::status,
|
23
24
|
tenant: String?,
|
24
|
-
updated_at: Time,
|
25
25
|
workflow: String?
|
26
26
|
}
|
27
27
|
|
28
28
|
class Message < Knockapi::Internal::Type::BaseModel
|
29
|
-
|
29
|
+
attr_accessor id: String
|
30
30
|
|
31
|
-
|
31
|
+
attr_accessor _typename: String
|
32
32
|
|
33
|
-
|
33
|
+
attr_accessor channel_id: String
|
34
34
|
|
35
|
-
|
35
|
+
attr_accessor engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]
|
36
|
+
|
37
|
+
attr_accessor inserted_at: Time
|
38
|
+
|
39
|
+
attr_accessor recipient: Knockapi::Models::recipient_reference
|
40
|
+
|
41
|
+
attr_accessor source: Knockapi::Message::Source
|
42
|
+
|
43
|
+
attr_accessor status: Knockapi::Models::Message::status
|
44
|
+
|
45
|
+
attr_accessor updated_at: Time
|
36
46
|
|
37
47
|
attr_reader actors: ::Array[Knockapi::Models::recipient_reference]?
|
38
48
|
|
@@ -42,24 +52,10 @@ module Knockapi
|
|
42
52
|
|
43
53
|
attr_accessor archived_at: Time?
|
44
54
|
|
45
|
-
attr_reader channel_id: String?
|
46
|
-
|
47
|
-
def channel_id=: (String) -> String
|
48
|
-
|
49
55
|
attr_accessor clicked_at: Time?
|
50
56
|
|
51
57
|
attr_accessor data: ::Hash[Symbol, top]?
|
52
58
|
|
53
|
-
attr_reader engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]?
|
54
|
-
|
55
|
-
def engagement_statuses=: (
|
56
|
-
::Array[Knockapi::Models::Message::engagement_status]
|
57
|
-
) -> ::Array[Knockapi::Models::Message::engagement_status]
|
58
|
-
|
59
|
-
attr_reader inserted_at: Time?
|
60
|
-
|
61
|
-
def inserted_at=: (Time) -> Time
|
62
|
-
|
63
59
|
attr_accessor interacted_at: Time?
|
64
60
|
|
65
61
|
attr_accessor link_clicked_at: Time?
|
@@ -68,79 +64,59 @@ module Knockapi
|
|
68
64
|
|
69
65
|
attr_accessor read_at: Time?
|
70
66
|
|
71
|
-
attr_reader recipient: Knockapi::Models::recipient_reference?
|
72
|
-
|
73
|
-
def recipient=: (
|
74
|
-
Knockapi::Models::recipient_reference
|
75
|
-
) -> Knockapi::Models::recipient_reference
|
76
|
-
|
77
67
|
attr_accessor scheduled_at: Time?
|
78
68
|
|
79
69
|
attr_accessor seen_at: Time?
|
80
70
|
|
81
|
-
attr_reader source: Knockapi::Message::Source?
|
82
|
-
|
83
|
-
def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source
|
84
|
-
|
85
|
-
attr_reader status: Knockapi::Models::Message::status?
|
86
|
-
|
87
|
-
def status=: (
|
88
|
-
Knockapi::Models::Message::status
|
89
|
-
) -> Knockapi::Models::Message::status
|
90
|
-
|
91
71
|
attr_accessor tenant: String?
|
92
72
|
|
93
|
-
attr_reader updated_at: Time?
|
94
|
-
|
95
|
-
def updated_at=: (Time) -> Time
|
96
|
-
|
97
73
|
attr_accessor workflow: String?
|
98
74
|
|
99
75
|
def initialize: (
|
100
|
-
|
101
|
-
|
76
|
+
id: String,
|
77
|
+
_typename: String,
|
78
|
+
channel_id: String,
|
79
|
+
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
80
|
+
inserted_at: Time,
|
81
|
+
recipient: Knockapi::Models::recipient_reference,
|
82
|
+
source: Knockapi::Message::Source,
|
83
|
+
status: Knockapi::Models::Message::status,
|
84
|
+
updated_at: Time,
|
102
85
|
?actors: ::Array[Knockapi::Models::recipient_reference],
|
103
86
|
?archived_at: Time?,
|
104
|
-
?channel_id: String,
|
105
87
|
?clicked_at: Time?,
|
106
88
|
?data: ::Hash[Symbol, top]?,
|
107
|
-
?engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
108
|
-
?inserted_at: Time,
|
109
89
|
?interacted_at: Time?,
|
110
90
|
?link_clicked_at: Time?,
|
111
91
|
?metadata: ::Hash[Symbol, top]?,
|
112
92
|
?read_at: Time?,
|
113
|
-
?recipient: Knockapi::Models::recipient_reference,
|
114
93
|
?scheduled_at: Time?,
|
115
94
|
?seen_at: Time?,
|
116
|
-
?source: Knockapi::Message::Source,
|
117
|
-
?status: Knockapi::Models::Message::status,
|
118
95
|
?tenant: String?,
|
119
|
-
?updated_at: Time,
|
120
96
|
?workflow: String?
|
121
97
|
) -> void
|
122
98
|
|
123
99
|
def to_hash: -> {
|
124
100
|
id: String,
|
125
101
|
_typename: String,
|
102
|
+
channel_id: String,
|
103
|
+
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
104
|
+
inserted_at: Time,
|
105
|
+
recipient: Knockapi::Models::recipient_reference,
|
106
|
+
source: Knockapi::Message::Source,
|
107
|
+
status: Knockapi::Models::Message::status,
|
108
|
+
updated_at: Time,
|
126
109
|
actors: ::Array[Knockapi::Models::recipient_reference],
|
127
110
|
archived_at: Time?,
|
128
|
-
channel_id: String,
|
129
111
|
clicked_at: Time?,
|
130
112
|
data: ::Hash[Symbol, top]?,
|
131
|
-
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
132
|
-
inserted_at: Time,
|
133
113
|
interacted_at: Time?,
|
134
114
|
link_clicked_at: Time?,
|
135
115
|
metadata: ::Hash[Symbol, top]?,
|
136
116
|
read_at: Time?,
|
137
|
-
recipient: Knockapi::Models::recipient_reference,
|
138
117
|
scheduled_at: Time?,
|
139
118
|
seen_at: Time?,
|
140
|
-
source: Knockapi::Message::Source,
|
141
|
-
status: Knockapi::Models::Message::status,
|
142
119
|
tenant: String?,
|
143
|
-
updated_at: Time,
|
144
120
|
workflow: String?
|
145
121
|
}
|
146
122
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: knockapi
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.12.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Knock
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-09-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: connection_pool
|