knockapi 1.38.0 → 1.39.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 +16 -0
- data/README.md +1 -1
- data/lib/knockapi/models/message_event.rb +5 -5
- data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +14 -26
- data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +5 -29
- data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +11 -27
- data/lib/knockapi/resources/users/guides.rb +13 -24
- data/lib/knockapi/version.rb +1 -1
- data/rbi/knockapi/models/message_event.rbi +15 -15
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +19 -36
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +8 -38
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +14 -36
- data/rbi/knockapi/resources/users/guides.rbi +11 -31
- data/sig/knockapi/models/message_event.rbs +10 -10
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +11 -23
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +6 -25
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +10 -24
- data/sig/knockapi/resources/users/guides.rbs +5 -12
- 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: 706550cb23080e850c2ff4cd5daf2107611079f396a7d44df3924f2ba56222ee
|
|
4
|
+
data.tar.gz: 0e86cca83b585998a9b0faa4f521eaf9e538d655d2945c1dee95d614c2556aa6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9d645f0840a90e538f5b4f58cfd1a8adc2d8e23e74dee243c2a35a36499fe11853611edc9d3b9c27c36b4396758b066c5ddc3af27986a3d324a7d598e74e1478
|
|
7
|
+
data.tar.gz: 3e4151b6409fd020b79c122240ad2a8b9c2b222660434bb3dc1f600dfde0bd873ef6a4a16f16ed128cf43a34f1a511c24bdd6ff34a0be276bc158d1f5c85ceac
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.39.0](https://github.com/knocklabs/knock-ruby/compare/v1.38.0...v1.39.0) (2026-07-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update api spec to v0.1.1599 ([e087beb](https://github.com/knocklabs/knock-ruby/commit/e087beb49fb56d8fbf123858163008c4e98dc984))
|
|
9
|
+
* update api spec to v0.1.1605 ([31ddc3e](https://github.com/knocklabs/knock-ruby/commit/31ddc3e8e474b11a8df37e05fff603e4e34b28c8))
|
|
10
|
+
* update api spec to v0.1.1607 ([3b5254e](https://github.com/knocklabs/knock-ruby/commit/3b5254e4f12c10a447d7ca5fbfd5a9a4d5af15c1))
|
|
11
|
+
* update api spec to v0.1.1608 ([a76e7b2](https://github.com/knocklabs/knock-ruby/commit/a76e7b2aa80265a5f701374aa06c3c447be44825))
|
|
12
|
+
* update api spec to v0.1.1609 ([4f22935](https://github.com/knocklabs/knock-ruby/commit/4f22935b2198ff54a122a7843cec9eec93602881))
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Chores
|
|
16
|
+
|
|
17
|
+
* forward SDK_WRITE_TOKEN to the back-sync workflow ([b79c2b9](https://github.com/knocklabs/knock-ruby/commit/b79c2b9bfb80b385fcdf312cee231b6fd6d25f84))
|
|
18
|
+
|
|
3
19
|
## [1.38.0](https://github.com/knocklabs/knock-ruby/compare/v1.37.0...v1.38.0) (2026-07-16)
|
|
4
20
|
|
|
5
21
|
|
data/README.md
CHANGED
|
@@ -69,19 +69,19 @@ module Knockapi
|
|
|
69
69
|
MESSAGE_READ = :"message.read"
|
|
70
70
|
MESSAGE_SENT = :"message.sent"
|
|
71
71
|
MESSAGE_SEEN = :"message.seen"
|
|
72
|
-
|
|
72
|
+
MESSAGE_ARCHIVED = :"message.archived"
|
|
73
73
|
MESSAGE_QUEUED = :"message.queued"
|
|
74
74
|
MESSAGE_DELIVERED = :"message.delivered"
|
|
75
|
+
MESSAGE_NOT_SENT = :"message.not_sent"
|
|
75
76
|
MESSAGE_BOUNCED = :"message.bounced"
|
|
76
77
|
MESSAGE_UNDELIVERED = :"message.undelivered"
|
|
77
|
-
MESSAGE_NOT_SENT = :"message.not_sent"
|
|
78
78
|
MESSAGE_DELIVERY_ATTEMPTED = :"message.delivery_attempted"
|
|
79
|
-
MESSAGE_ARCHIVED = :"message.archived"
|
|
80
|
-
MESSAGE_LINK_CLICKED = :"message.link_clicked"
|
|
81
79
|
MESSAGE_INTERACTED = :"message.interacted"
|
|
80
|
+
MESSAGE_UNARCHIVED = :"message.unarchived"
|
|
81
|
+
MESSAGE_LINK_CLICKED = :"message.link_clicked"
|
|
82
82
|
MESSAGE_UNSEEN = :"message.unseen"
|
|
83
83
|
MESSAGE_UNREAD = :"message.unread"
|
|
84
|
-
|
|
84
|
+
MESSAGE_CREATED = :"message.created"
|
|
85
85
|
|
|
86
86
|
# @!method self.values
|
|
87
87
|
# @return [Array<Symbol>]
|
|
@@ -42,37 +42,29 @@ module Knockapi
|
|
|
42
42
|
# @return [String]
|
|
43
43
|
required :guide_step_ref, String
|
|
44
44
|
|
|
45
|
-
# @!attribute content
|
|
46
|
-
# The content of the guide.
|
|
47
|
-
#
|
|
48
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
49
|
-
optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
50
|
-
|
|
51
|
-
# @!attribute data
|
|
52
|
-
# The data of the guide.
|
|
53
|
-
#
|
|
54
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
55
|
-
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
56
|
-
|
|
57
45
|
# @!attribute is_final
|
|
58
46
|
# Whether the guide is final.
|
|
59
47
|
#
|
|
60
48
|
# @return [Boolean, nil]
|
|
61
49
|
optional :is_final, Knockapi::Internal::Type::Boolean
|
|
62
50
|
|
|
63
|
-
# @!attribute metadata
|
|
64
|
-
# The metadata of the guide.
|
|
65
|
-
#
|
|
66
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
67
|
-
optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
68
|
-
|
|
69
51
|
# @!attribute tenant
|
|
70
52
|
# The tenant ID of the guide.
|
|
71
53
|
#
|
|
72
54
|
# @return [String, nil]
|
|
73
|
-
optional :tenant, String
|
|
55
|
+
optional :tenant, String
|
|
74
56
|
|
|
75
|
-
# @!
|
|
57
|
+
# @!attribute unthrottled
|
|
58
|
+
# Whether the guide bypasses its guide group's throttle settings. When true,
|
|
59
|
+
# archiving the guide does not open a new throttle window.
|
|
60
|
+
#
|
|
61
|
+
# @return [Boolean, nil]
|
|
62
|
+
optional :unthrottled, Knockapi::Internal::Type::Boolean
|
|
63
|
+
|
|
64
|
+
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, is_final: nil, tenant: nil, unthrottled: nil, request_options: {})
|
|
65
|
+
# Some parameter documentations has been truncated, see
|
|
66
|
+
# {Knockapi::Models::Users::GuideMarkMessageAsArchivedParams} for more details.
|
|
67
|
+
#
|
|
76
68
|
# @param user_id [String]
|
|
77
69
|
#
|
|
78
70
|
# @param message_id [String]
|
|
@@ -85,15 +77,11 @@ module Knockapi
|
|
|
85
77
|
#
|
|
86
78
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
87
79
|
#
|
|
88
|
-
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
89
|
-
#
|
|
90
|
-
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
91
|
-
#
|
|
92
80
|
# @param is_final [Boolean] Whether the guide is final.
|
|
93
81
|
#
|
|
94
|
-
# @param
|
|
82
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
95
83
|
#
|
|
96
|
-
# @param
|
|
84
|
+
# @param unthrottled [Boolean] Whether the guide bypasses its guide group's throttle settings. When true, archi
|
|
97
85
|
#
|
|
98
86
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
99
87
|
end
|
|
@@ -42,26 +42,8 @@ module Knockapi
|
|
|
42
42
|
# @return [String]
|
|
43
43
|
required :guide_step_ref, String
|
|
44
44
|
|
|
45
|
-
# @!attribute content
|
|
46
|
-
# The content of the guide.
|
|
47
|
-
#
|
|
48
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
49
|
-
optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
50
|
-
|
|
51
|
-
# @!attribute data
|
|
52
|
-
# The data of the guide.
|
|
53
|
-
#
|
|
54
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
55
|
-
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
56
|
-
|
|
57
|
-
# @!attribute is_final
|
|
58
|
-
# Whether the guide is final.
|
|
59
|
-
#
|
|
60
|
-
# @return [Boolean, nil]
|
|
61
|
-
optional :is_final, Knockapi::Internal::Type::Boolean
|
|
62
|
-
|
|
63
45
|
# @!attribute metadata
|
|
64
|
-
#
|
|
46
|
+
# Metadata about the interaction.
|
|
65
47
|
#
|
|
66
48
|
# @return [Hash{Symbol=>Object}, nil]
|
|
67
49
|
optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
@@ -70,9 +52,9 @@ module Knockapi
|
|
|
70
52
|
# The tenant ID of the guide.
|
|
71
53
|
#
|
|
72
54
|
# @return [String, nil]
|
|
73
|
-
optional :tenant, String
|
|
55
|
+
optional :tenant, String
|
|
74
56
|
|
|
75
|
-
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:,
|
|
57
|
+
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, metadata: nil, tenant: nil, request_options: {})
|
|
76
58
|
# @param user_id [String]
|
|
77
59
|
#
|
|
78
60
|
# @param message_id [String]
|
|
@@ -85,15 +67,9 @@ module Knockapi
|
|
|
85
67
|
#
|
|
86
68
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
87
69
|
#
|
|
88
|
-
# @param
|
|
89
|
-
#
|
|
90
|
-
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
91
|
-
#
|
|
92
|
-
# @param is_final [Boolean] Whether the guide is final.
|
|
93
|
-
#
|
|
94
|
-
# @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
|
|
70
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata about the interaction.
|
|
95
71
|
#
|
|
96
|
-
# @param tenant [String
|
|
72
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
97
73
|
#
|
|
98
74
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
99
75
|
end
|
|
@@ -24,6 +24,12 @@ module Knockapi
|
|
|
24
24
|
# @return [String]
|
|
25
25
|
required :channel_id, String
|
|
26
26
|
|
|
27
|
+
# @!attribute content
|
|
28
|
+
# The content of the guide.
|
|
29
|
+
#
|
|
30
|
+
# @return [Hash{Symbol=>Object}]
|
|
31
|
+
required :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
32
|
+
|
|
27
33
|
# @!attribute guide_id
|
|
28
34
|
# The unique identifier for the guide.
|
|
29
35
|
#
|
|
@@ -42,58 +48,36 @@ module Knockapi
|
|
|
42
48
|
# @return [String]
|
|
43
49
|
required :guide_step_ref, String
|
|
44
50
|
|
|
45
|
-
# @!attribute content
|
|
46
|
-
# The content of the guide.
|
|
47
|
-
#
|
|
48
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
49
|
-
optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
50
|
-
|
|
51
51
|
# @!attribute data
|
|
52
52
|
# The data of the guide.
|
|
53
53
|
#
|
|
54
54
|
# @return [Hash{Symbol=>Object}, nil]
|
|
55
55
|
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
56
56
|
|
|
57
|
-
# @!attribute is_final
|
|
58
|
-
# Whether the guide is final.
|
|
59
|
-
#
|
|
60
|
-
# @return [Boolean, nil]
|
|
61
|
-
optional :is_final, Knockapi::Internal::Type::Boolean
|
|
62
|
-
|
|
63
|
-
# @!attribute metadata
|
|
64
|
-
# The metadata of the guide.
|
|
65
|
-
#
|
|
66
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
67
|
-
optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
|
68
|
-
|
|
69
57
|
# @!attribute tenant
|
|
70
58
|
# The tenant ID of the guide.
|
|
71
59
|
#
|
|
72
60
|
# @return [String, nil]
|
|
73
|
-
optional :tenant, String
|
|
61
|
+
optional :tenant, String
|
|
74
62
|
|
|
75
|
-
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:,
|
|
63
|
+
# @!method initialize(user_id:, message_id:, channel_id:, content:, guide_id:, guide_key:, guide_step_ref:, data: nil, tenant: nil, request_options: {})
|
|
76
64
|
# @param user_id [String]
|
|
77
65
|
#
|
|
78
66
|
# @param message_id [String]
|
|
79
67
|
#
|
|
80
68
|
# @param channel_id [String] The unique identifier for the channel.
|
|
81
69
|
#
|
|
70
|
+
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
71
|
+
#
|
|
82
72
|
# @param guide_id [String] The unique identifier for the guide.
|
|
83
73
|
#
|
|
84
74
|
# @param guide_key [String] The key of the guide.
|
|
85
75
|
#
|
|
86
76
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
87
77
|
#
|
|
88
|
-
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
89
|
-
#
|
|
90
78
|
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
91
79
|
#
|
|
92
|
-
# @param
|
|
93
|
-
#
|
|
94
|
-
# @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
|
|
95
|
-
#
|
|
96
|
-
# @param tenant [String, nil] The tenant ID of the guide.
|
|
80
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
97
81
|
#
|
|
98
82
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
99
83
|
end
|
|
@@ -37,10 +37,13 @@ module Knockapi
|
|
|
37
37
|
)
|
|
38
38
|
end
|
|
39
39
|
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Knockapi::Models::Users::GuideMarkMessageAsArchivedParams} for more details.
|
|
42
|
+
#
|
|
40
43
|
# Records that a guide has been archived by a user, triggering any associated
|
|
41
44
|
# archived events.
|
|
42
45
|
#
|
|
43
|
-
# @overload mark_message_as_archived(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:,
|
|
46
|
+
# @overload mark_message_as_archived(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:, is_final: nil, tenant: nil, unthrottled: nil, request_options: {})
|
|
44
47
|
#
|
|
45
48
|
# @param user_id [String] The unique identifier of the user.
|
|
46
49
|
#
|
|
@@ -54,15 +57,11 @@ module Knockapi
|
|
|
54
57
|
#
|
|
55
58
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
56
59
|
#
|
|
57
|
-
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
58
|
-
#
|
|
59
|
-
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
60
|
-
#
|
|
61
60
|
# @param is_final [Boolean] Whether the guide is final.
|
|
62
61
|
#
|
|
63
|
-
# @param
|
|
62
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
64
63
|
#
|
|
65
|
-
# @param
|
|
64
|
+
# @param unthrottled [Boolean] Whether the guide bypasses its guide group's throttle settings. When true, archi
|
|
66
65
|
#
|
|
67
66
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
68
67
|
#
|
|
@@ -83,7 +82,7 @@ module Knockapi
|
|
|
83
82
|
# Records that a user has interacted with a guide, triggering any associated
|
|
84
83
|
# interacted events.
|
|
85
84
|
#
|
|
86
|
-
# @overload mark_message_as_interacted(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:,
|
|
85
|
+
# @overload mark_message_as_interacted(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:, metadata: nil, tenant: nil, request_options: {})
|
|
87
86
|
#
|
|
88
87
|
# @param user_id [String] The unique identifier of the user.
|
|
89
88
|
#
|
|
@@ -97,15 +96,9 @@ module Knockapi
|
|
|
97
96
|
#
|
|
98
97
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
99
98
|
#
|
|
100
|
-
# @param
|
|
101
|
-
#
|
|
102
|
-
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
103
|
-
#
|
|
104
|
-
# @param is_final [Boolean] Whether the guide is final.
|
|
105
|
-
#
|
|
106
|
-
# @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
|
|
99
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata about the interaction.
|
|
107
100
|
#
|
|
108
|
-
# @param tenant [String
|
|
101
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
109
102
|
#
|
|
110
103
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
111
104
|
#
|
|
@@ -126,7 +119,7 @@ module Knockapi
|
|
|
126
119
|
# Records that a guide has been seen by a user, triggering any associated seen
|
|
127
120
|
# events.
|
|
128
121
|
#
|
|
129
|
-
# @overload mark_message_as_seen(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:,
|
|
122
|
+
# @overload mark_message_as_seen(user_id, message_id, channel_id:, content:, guide_id:, guide_key:, guide_step_ref:, data: nil, tenant: nil, request_options: {})
|
|
130
123
|
#
|
|
131
124
|
# @param user_id [String] The unique identifier of the user.
|
|
132
125
|
#
|
|
@@ -134,21 +127,17 @@ module Knockapi
|
|
|
134
127
|
#
|
|
135
128
|
# @param channel_id [String] The unique identifier for the channel.
|
|
136
129
|
#
|
|
130
|
+
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
131
|
+
#
|
|
137
132
|
# @param guide_id [String] The unique identifier for the guide.
|
|
138
133
|
#
|
|
139
134
|
# @param guide_key [String] The key of the guide.
|
|
140
135
|
#
|
|
141
136
|
# @param guide_step_ref [String] The step reference of the guide.
|
|
142
137
|
#
|
|
143
|
-
# @param content [Hash{Symbol=>Object}] The content of the guide.
|
|
144
|
-
#
|
|
145
138
|
# @param data [Hash{Symbol=>Object}] The data of the guide.
|
|
146
139
|
#
|
|
147
|
-
# @param
|
|
148
|
-
#
|
|
149
|
-
# @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
|
|
150
|
-
#
|
|
151
|
-
# @param tenant [String, nil] The tenant ID of the guide.
|
|
140
|
+
# @param tenant [String] The tenant ID of the guide.
|
|
152
141
|
#
|
|
153
142
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
154
143
|
#
|
data/lib/knockapi/version.rb
CHANGED
|
@@ -95,8 +95,8 @@ module Knockapi
|
|
|
95
95
|
T.let(:"message.sent", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
96
96
|
MESSAGE_SEEN =
|
|
97
97
|
T.let(:"message.seen", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
98
|
-
|
|
99
|
-
T.let(:"message.
|
|
98
|
+
MESSAGE_ARCHIVED =
|
|
99
|
+
T.let(:"message.archived", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
100
100
|
MESSAGE_QUEUED =
|
|
101
101
|
T.let(:"message.queued", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
102
102
|
MESSAGE_DELIVERED =
|
|
@@ -104,6 +104,8 @@ module Knockapi
|
|
|
104
104
|
:"message.delivered",
|
|
105
105
|
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
106
106
|
)
|
|
107
|
+
MESSAGE_NOT_SENT =
|
|
108
|
+
T.let(:"message.not_sent", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
107
109
|
MESSAGE_BOUNCED =
|
|
108
110
|
T.let(:"message.bounced", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
109
111
|
MESSAGE_UNDELIVERED =
|
|
@@ -111,34 +113,32 @@ module Knockapi
|
|
|
111
113
|
:"message.undelivered",
|
|
112
114
|
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
113
115
|
)
|
|
114
|
-
MESSAGE_NOT_SENT =
|
|
115
|
-
T.let(:"message.not_sent", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
116
116
|
MESSAGE_DELIVERY_ATTEMPTED =
|
|
117
117
|
T.let(
|
|
118
118
|
:"message.delivery_attempted",
|
|
119
119
|
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
120
120
|
)
|
|
121
|
-
MESSAGE_ARCHIVED =
|
|
122
|
-
T.let(:"message.archived", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
123
|
-
MESSAGE_LINK_CLICKED =
|
|
124
|
-
T.let(
|
|
125
|
-
:"message.link_clicked",
|
|
126
|
-
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
127
|
-
)
|
|
128
121
|
MESSAGE_INTERACTED =
|
|
129
122
|
T.let(
|
|
130
123
|
:"message.interacted",
|
|
131
124
|
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
132
125
|
)
|
|
133
|
-
MESSAGE_UNSEEN =
|
|
134
|
-
T.let(:"message.unseen", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
135
|
-
MESSAGE_UNREAD =
|
|
136
|
-
T.let(:"message.unread", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
137
126
|
MESSAGE_UNARCHIVED =
|
|
138
127
|
T.let(
|
|
139
128
|
:"message.unarchived",
|
|
140
129
|
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
141
130
|
)
|
|
131
|
+
MESSAGE_LINK_CLICKED =
|
|
132
|
+
T.let(
|
|
133
|
+
:"message.link_clicked",
|
|
134
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
|
135
|
+
)
|
|
136
|
+
MESSAGE_UNSEEN =
|
|
137
|
+
T.let(:"message.unseen", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
138
|
+
MESSAGE_UNREAD =
|
|
139
|
+
T.let(:"message.unread", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
140
|
+
MESSAGE_CREATED =
|
|
141
|
+
T.let(:"message.created", Knockapi::MessageEvent::Type::TaggedSymbol)
|
|
142
142
|
|
|
143
143
|
sig do
|
|
144
144
|
override.returns(T::Array[Knockapi::MessageEvent::Type::TaggedSymbol])
|
|
@@ -37,20 +37,6 @@ module Knockapi
|
|
|
37
37
|
sig { returns(String) }
|
|
38
38
|
attr_accessor :guide_step_ref
|
|
39
39
|
|
|
40
|
-
# The content of the guide.
|
|
41
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
42
|
-
attr_reader :content
|
|
43
|
-
|
|
44
|
-
sig { params(content: T::Hash[Symbol, T.anything]).void }
|
|
45
|
-
attr_writer :content
|
|
46
|
-
|
|
47
|
-
# The data of the guide.
|
|
48
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
49
|
-
attr_reader :data
|
|
50
|
-
|
|
51
|
-
sig { params(data: T::Hash[Symbol, T.anything]).void }
|
|
52
|
-
attr_writer :data
|
|
53
|
-
|
|
54
40
|
# Whether the guide is final.
|
|
55
41
|
sig { returns(T.nilable(T::Boolean)) }
|
|
56
42
|
attr_reader :is_final
|
|
@@ -58,16 +44,20 @@ module Knockapi
|
|
|
58
44
|
sig { params(is_final: T::Boolean).void }
|
|
59
45
|
attr_writer :is_final
|
|
60
46
|
|
|
61
|
-
# The metadata of the guide.
|
|
62
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
63
|
-
attr_reader :metadata
|
|
64
|
-
|
|
65
|
-
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
|
66
|
-
attr_writer :metadata
|
|
67
|
-
|
|
68
47
|
# The tenant ID of the guide.
|
|
69
48
|
sig { returns(T.nilable(String)) }
|
|
70
|
-
|
|
49
|
+
attr_reader :tenant
|
|
50
|
+
|
|
51
|
+
sig { params(tenant: String).void }
|
|
52
|
+
attr_writer :tenant
|
|
53
|
+
|
|
54
|
+
# Whether the guide bypasses its guide group's throttle settings. When true,
|
|
55
|
+
# archiving the guide does not open a new throttle window.
|
|
56
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
57
|
+
attr_reader :unthrottled
|
|
58
|
+
|
|
59
|
+
sig { params(unthrottled: T::Boolean).void }
|
|
60
|
+
attr_writer :unthrottled
|
|
71
61
|
|
|
72
62
|
sig do
|
|
73
63
|
params(
|
|
@@ -77,11 +67,9 @@ module Knockapi
|
|
|
77
67
|
guide_id: String,
|
|
78
68
|
guide_key: String,
|
|
79
69
|
guide_step_ref: String,
|
|
80
|
-
content: T::Hash[Symbol, T.anything],
|
|
81
|
-
data: T::Hash[Symbol, T.anything],
|
|
82
70
|
is_final: T::Boolean,
|
|
83
|
-
|
|
84
|
-
|
|
71
|
+
tenant: String,
|
|
72
|
+
unthrottled: T::Boolean,
|
|
85
73
|
request_options: Knockapi::RequestOptions::OrHash
|
|
86
74
|
).returns(T.attached_class)
|
|
87
75
|
end
|
|
@@ -96,16 +84,13 @@ module Knockapi
|
|
|
96
84
|
guide_key:,
|
|
97
85
|
# The step reference of the guide.
|
|
98
86
|
guide_step_ref:,
|
|
99
|
-
# The content of the guide.
|
|
100
|
-
content: nil,
|
|
101
|
-
# The data of the guide.
|
|
102
|
-
data: nil,
|
|
103
87
|
# Whether the guide is final.
|
|
104
88
|
is_final: nil,
|
|
105
|
-
# The metadata of the guide.
|
|
106
|
-
metadata: nil,
|
|
107
89
|
# The tenant ID of the guide.
|
|
108
90
|
tenant: nil,
|
|
91
|
+
# Whether the guide bypasses its guide group's throttle settings. When true,
|
|
92
|
+
# archiving the guide does not open a new throttle window.
|
|
93
|
+
unthrottled: nil,
|
|
109
94
|
request_options: {}
|
|
110
95
|
)
|
|
111
96
|
end
|
|
@@ -119,11 +104,9 @@ module Knockapi
|
|
|
119
104
|
guide_id: String,
|
|
120
105
|
guide_key: String,
|
|
121
106
|
guide_step_ref: String,
|
|
122
|
-
content: T::Hash[Symbol, T.anything],
|
|
123
|
-
data: T::Hash[Symbol, T.anything],
|
|
124
107
|
is_final: T::Boolean,
|
|
125
|
-
|
|
126
|
-
|
|
108
|
+
tenant: String,
|
|
109
|
+
unthrottled: T::Boolean,
|
|
127
110
|
request_options: Knockapi::RequestOptions
|
|
128
111
|
}
|
|
129
112
|
)
|
|
@@ -37,28 +37,7 @@ module Knockapi
|
|
|
37
37
|
sig { returns(String) }
|
|
38
38
|
attr_accessor :guide_step_ref
|
|
39
39
|
|
|
40
|
-
#
|
|
41
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
42
|
-
attr_reader :content
|
|
43
|
-
|
|
44
|
-
sig { params(content: T::Hash[Symbol, T.anything]).void }
|
|
45
|
-
attr_writer :content
|
|
46
|
-
|
|
47
|
-
# The data of the guide.
|
|
48
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
49
|
-
attr_reader :data
|
|
50
|
-
|
|
51
|
-
sig { params(data: T::Hash[Symbol, T.anything]).void }
|
|
52
|
-
attr_writer :data
|
|
53
|
-
|
|
54
|
-
# Whether the guide is final.
|
|
55
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
56
|
-
attr_reader :is_final
|
|
57
|
-
|
|
58
|
-
sig { params(is_final: T::Boolean).void }
|
|
59
|
-
attr_writer :is_final
|
|
60
|
-
|
|
61
|
-
# The metadata of the guide.
|
|
40
|
+
# Metadata about the interaction.
|
|
62
41
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
63
42
|
attr_reader :metadata
|
|
64
43
|
|
|
@@ -67,7 +46,10 @@ module Knockapi
|
|
|
67
46
|
|
|
68
47
|
# The tenant ID of the guide.
|
|
69
48
|
sig { returns(T.nilable(String)) }
|
|
70
|
-
|
|
49
|
+
attr_reader :tenant
|
|
50
|
+
|
|
51
|
+
sig { params(tenant: String).void }
|
|
52
|
+
attr_writer :tenant
|
|
71
53
|
|
|
72
54
|
sig do
|
|
73
55
|
params(
|
|
@@ -77,11 +59,8 @@ module Knockapi
|
|
|
77
59
|
guide_id: String,
|
|
78
60
|
guide_key: String,
|
|
79
61
|
guide_step_ref: String,
|
|
80
|
-
content: T::Hash[Symbol, T.anything],
|
|
81
|
-
data: T::Hash[Symbol, T.anything],
|
|
82
|
-
is_final: T::Boolean,
|
|
83
62
|
metadata: T::Hash[Symbol, T.anything],
|
|
84
|
-
tenant:
|
|
63
|
+
tenant: String,
|
|
85
64
|
request_options: Knockapi::RequestOptions::OrHash
|
|
86
65
|
).returns(T.attached_class)
|
|
87
66
|
end
|
|
@@ -96,13 +75,7 @@ module Knockapi
|
|
|
96
75
|
guide_key:,
|
|
97
76
|
# The step reference of the guide.
|
|
98
77
|
guide_step_ref:,
|
|
99
|
-
#
|
|
100
|
-
content: nil,
|
|
101
|
-
# The data of the guide.
|
|
102
|
-
data: nil,
|
|
103
|
-
# Whether the guide is final.
|
|
104
|
-
is_final: nil,
|
|
105
|
-
# The metadata of the guide.
|
|
78
|
+
# Metadata about the interaction.
|
|
106
79
|
metadata: nil,
|
|
107
80
|
# The tenant ID of the guide.
|
|
108
81
|
tenant: nil,
|
|
@@ -119,11 +92,8 @@ module Knockapi
|
|
|
119
92
|
guide_id: String,
|
|
120
93
|
guide_key: String,
|
|
121
94
|
guide_step_ref: String,
|
|
122
|
-
content: T::Hash[Symbol, T.anything],
|
|
123
|
-
data: T::Hash[Symbol, T.anything],
|
|
124
|
-
is_final: T::Boolean,
|
|
125
95
|
metadata: T::Hash[Symbol, T.anything],
|
|
126
|
-
tenant:
|
|
96
|
+
tenant: String,
|
|
127
97
|
request_options: Knockapi::RequestOptions
|
|
128
98
|
}
|
|
129
99
|
)
|
|
@@ -25,6 +25,10 @@ module Knockapi
|
|
|
25
25
|
sig { returns(String) }
|
|
26
26
|
attr_accessor :channel_id
|
|
27
27
|
|
|
28
|
+
# The content of the guide.
|
|
29
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
|
30
|
+
attr_accessor :content
|
|
31
|
+
|
|
28
32
|
# The unique identifier for the guide.
|
|
29
33
|
sig { returns(String) }
|
|
30
34
|
attr_accessor :guide_id
|
|
@@ -37,13 +41,6 @@ module Knockapi
|
|
|
37
41
|
sig { returns(String) }
|
|
38
42
|
attr_accessor :guide_step_ref
|
|
39
43
|
|
|
40
|
-
# The content of the guide.
|
|
41
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
42
|
-
attr_reader :content
|
|
43
|
-
|
|
44
|
-
sig { params(content: T::Hash[Symbol, T.anything]).void }
|
|
45
|
-
attr_writer :content
|
|
46
|
-
|
|
47
44
|
# The data of the guide.
|
|
48
45
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
49
46
|
attr_reader :data
|
|
@@ -51,37 +48,24 @@ module Knockapi
|
|
|
51
48
|
sig { params(data: T::Hash[Symbol, T.anything]).void }
|
|
52
49
|
attr_writer :data
|
|
53
50
|
|
|
54
|
-
# Whether the guide is final.
|
|
55
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
56
|
-
attr_reader :is_final
|
|
57
|
-
|
|
58
|
-
sig { params(is_final: T::Boolean).void }
|
|
59
|
-
attr_writer :is_final
|
|
60
|
-
|
|
61
|
-
# The metadata of the guide.
|
|
62
|
-
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
63
|
-
attr_reader :metadata
|
|
64
|
-
|
|
65
|
-
sig { params(metadata: T::Hash[Symbol, T.anything]).void }
|
|
66
|
-
attr_writer :metadata
|
|
67
|
-
|
|
68
51
|
# The tenant ID of the guide.
|
|
69
52
|
sig { returns(T.nilable(String)) }
|
|
70
|
-
|
|
53
|
+
attr_reader :tenant
|
|
54
|
+
|
|
55
|
+
sig { params(tenant: String).void }
|
|
56
|
+
attr_writer :tenant
|
|
71
57
|
|
|
72
58
|
sig do
|
|
73
59
|
params(
|
|
74
60
|
user_id: String,
|
|
75
61
|
message_id: String,
|
|
76
62
|
channel_id: String,
|
|
63
|
+
content: T::Hash[Symbol, T.anything],
|
|
77
64
|
guide_id: String,
|
|
78
65
|
guide_key: String,
|
|
79
66
|
guide_step_ref: String,
|
|
80
|
-
content: T::Hash[Symbol, T.anything],
|
|
81
67
|
data: T::Hash[Symbol, T.anything],
|
|
82
|
-
|
|
83
|
-
metadata: T::Hash[Symbol, T.anything],
|
|
84
|
-
tenant: T.nilable(String),
|
|
68
|
+
tenant: String,
|
|
85
69
|
request_options: Knockapi::RequestOptions::OrHash
|
|
86
70
|
).returns(T.attached_class)
|
|
87
71
|
end
|
|
@@ -90,20 +74,16 @@ module Knockapi
|
|
|
90
74
|
message_id:,
|
|
91
75
|
# The unique identifier for the channel.
|
|
92
76
|
channel_id:,
|
|
77
|
+
# The content of the guide.
|
|
78
|
+
content:,
|
|
93
79
|
# The unique identifier for the guide.
|
|
94
80
|
guide_id:,
|
|
95
81
|
# The key of the guide.
|
|
96
82
|
guide_key:,
|
|
97
83
|
# The step reference of the guide.
|
|
98
84
|
guide_step_ref:,
|
|
99
|
-
# The content of the guide.
|
|
100
|
-
content: nil,
|
|
101
85
|
# The data of the guide.
|
|
102
86
|
data: nil,
|
|
103
|
-
# Whether the guide is final.
|
|
104
|
-
is_final: nil,
|
|
105
|
-
# The metadata of the guide.
|
|
106
|
-
metadata: nil,
|
|
107
87
|
# The tenant ID of the guide.
|
|
108
88
|
tenant: nil,
|
|
109
89
|
request_options: {}
|
|
@@ -116,14 +96,12 @@ module Knockapi
|
|
|
116
96
|
user_id: String,
|
|
117
97
|
message_id: String,
|
|
118
98
|
channel_id: String,
|
|
99
|
+
content: T::Hash[Symbol, T.anything],
|
|
119
100
|
guide_id: String,
|
|
120
101
|
guide_key: String,
|
|
121
102
|
guide_step_ref: String,
|
|
122
|
-
content: T::Hash[Symbol, T.anything],
|
|
123
103
|
data: T::Hash[Symbol, T.anything],
|
|
124
|
-
|
|
125
|
-
metadata: T::Hash[Symbol, T.anything],
|
|
126
|
-
tenant: T.nilable(String),
|
|
104
|
+
tenant: String,
|
|
127
105
|
request_options: Knockapi::RequestOptions
|
|
128
106
|
}
|
|
129
107
|
)
|
|
@@ -42,11 +42,9 @@ module Knockapi
|
|
|
42
42
|
guide_id: String,
|
|
43
43
|
guide_key: String,
|
|
44
44
|
guide_step_ref: String,
|
|
45
|
-
content: T::Hash[Symbol, T.anything],
|
|
46
|
-
data: T::Hash[Symbol, T.anything],
|
|
47
45
|
is_final: T::Boolean,
|
|
48
|
-
|
|
49
|
-
|
|
46
|
+
tenant: String,
|
|
47
|
+
unthrottled: T::Boolean,
|
|
50
48
|
request_options: Knockapi::RequestOptions::OrHash
|
|
51
49
|
).returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
|
|
52
50
|
end
|
|
@@ -62,16 +60,13 @@ module Knockapi
|
|
|
62
60
|
guide_key:,
|
|
63
61
|
# The step reference of the guide.
|
|
64
62
|
guide_step_ref:,
|
|
65
|
-
# The content of the guide.
|
|
66
|
-
content: nil,
|
|
67
|
-
# The data of the guide.
|
|
68
|
-
data: nil,
|
|
69
63
|
# Whether the guide is final.
|
|
70
64
|
is_final: nil,
|
|
71
|
-
# The metadata of the guide.
|
|
72
|
-
metadata: nil,
|
|
73
65
|
# The tenant ID of the guide.
|
|
74
66
|
tenant: nil,
|
|
67
|
+
# Whether the guide bypasses its guide group's throttle settings. When true,
|
|
68
|
+
# archiving the guide does not open a new throttle window.
|
|
69
|
+
unthrottled: nil,
|
|
75
70
|
request_options: {}
|
|
76
71
|
)
|
|
77
72
|
end
|
|
@@ -86,11 +81,8 @@ module Knockapi
|
|
|
86
81
|
guide_id: String,
|
|
87
82
|
guide_key: String,
|
|
88
83
|
guide_step_ref: String,
|
|
89
|
-
content: T::Hash[Symbol, T.anything],
|
|
90
|
-
data: T::Hash[Symbol, T.anything],
|
|
91
|
-
is_final: T::Boolean,
|
|
92
84
|
metadata: T::Hash[Symbol, T.anything],
|
|
93
|
-
tenant:
|
|
85
|
+
tenant: String,
|
|
94
86
|
request_options: Knockapi::RequestOptions::OrHash
|
|
95
87
|
).returns(
|
|
96
88
|
Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
|
|
@@ -108,13 +100,7 @@ module Knockapi
|
|
|
108
100
|
guide_key:,
|
|
109
101
|
# The step reference of the guide.
|
|
110
102
|
guide_step_ref:,
|
|
111
|
-
#
|
|
112
|
-
content: nil,
|
|
113
|
-
# The data of the guide.
|
|
114
|
-
data: nil,
|
|
115
|
-
# Whether the guide is final.
|
|
116
|
-
is_final: nil,
|
|
117
|
-
# The metadata of the guide.
|
|
103
|
+
# Metadata about the interaction.
|
|
118
104
|
metadata: nil,
|
|
119
105
|
# The tenant ID of the guide.
|
|
120
106
|
tenant: nil,
|
|
@@ -129,14 +115,12 @@ module Knockapi
|
|
|
129
115
|
user_id: String,
|
|
130
116
|
message_id: String,
|
|
131
117
|
channel_id: String,
|
|
118
|
+
content: T::Hash[Symbol, T.anything],
|
|
132
119
|
guide_id: String,
|
|
133
120
|
guide_key: String,
|
|
134
121
|
guide_step_ref: String,
|
|
135
|
-
content: T::Hash[Symbol, T.anything],
|
|
136
122
|
data: T::Hash[Symbol, T.anything],
|
|
137
|
-
|
|
138
|
-
metadata: T::Hash[Symbol, T.anything],
|
|
139
|
-
tenant: T.nilable(String),
|
|
123
|
+
tenant: String,
|
|
140
124
|
request_options: Knockapi::RequestOptions::OrHash
|
|
141
125
|
).returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
|
|
142
126
|
end
|
|
@@ -146,20 +130,16 @@ module Knockapi
|
|
|
146
130
|
message_id,
|
|
147
131
|
# The unique identifier for the channel.
|
|
148
132
|
channel_id:,
|
|
133
|
+
# The content of the guide.
|
|
134
|
+
content:,
|
|
149
135
|
# The unique identifier for the guide.
|
|
150
136
|
guide_id:,
|
|
151
137
|
# The key of the guide.
|
|
152
138
|
guide_key:,
|
|
153
139
|
# The step reference of the guide.
|
|
154
140
|
guide_step_ref:,
|
|
155
|
-
# The content of the guide.
|
|
156
|
-
content: nil,
|
|
157
141
|
# The data of the guide.
|
|
158
142
|
data: nil,
|
|
159
|
-
# Whether the guide is final.
|
|
160
|
-
is_final: nil,
|
|
161
|
-
# The metadata of the guide.
|
|
162
|
-
metadata: nil,
|
|
163
143
|
# The tenant ID of the guide.
|
|
164
144
|
tenant: nil,
|
|
165
145
|
request_options: {}
|
|
@@ -45,19 +45,19 @@ module Knockapi
|
|
|
45
45
|
:"message.read"
|
|
46
46
|
| :"message.sent"
|
|
47
47
|
| :"message.seen"
|
|
48
|
-
| :"message.
|
|
48
|
+
| :"message.archived"
|
|
49
49
|
| :"message.queued"
|
|
50
50
|
| :"message.delivered"
|
|
51
|
+
| :"message.not_sent"
|
|
51
52
|
| :"message.bounced"
|
|
52
53
|
| :"message.undelivered"
|
|
53
|
-
| :"message.not_sent"
|
|
54
54
|
| :"message.delivery_attempted"
|
|
55
|
-
| :"message.archived"
|
|
56
|
-
| :"message.link_clicked"
|
|
57
55
|
| :"message.interacted"
|
|
56
|
+
| :"message.unarchived"
|
|
57
|
+
| :"message.link_clicked"
|
|
58
58
|
| :"message.unseen"
|
|
59
59
|
| :"message.unread"
|
|
60
|
-
| :"message.
|
|
60
|
+
| :"message.created"
|
|
61
61
|
|
|
62
62
|
module Type
|
|
63
63
|
extend Knockapi::Internal::Type::Enum
|
|
@@ -65,19 +65,19 @@ module Knockapi
|
|
|
65
65
|
MESSAGE_READ: :"message.read"
|
|
66
66
|
MESSAGE_SENT: :"message.sent"
|
|
67
67
|
MESSAGE_SEEN: :"message.seen"
|
|
68
|
-
|
|
68
|
+
MESSAGE_ARCHIVED: :"message.archived"
|
|
69
69
|
MESSAGE_QUEUED: :"message.queued"
|
|
70
70
|
MESSAGE_DELIVERED: :"message.delivered"
|
|
71
|
+
MESSAGE_NOT_SENT: :"message.not_sent"
|
|
71
72
|
MESSAGE_BOUNCED: :"message.bounced"
|
|
72
73
|
MESSAGE_UNDELIVERED: :"message.undelivered"
|
|
73
|
-
MESSAGE_NOT_SENT: :"message.not_sent"
|
|
74
74
|
MESSAGE_DELIVERY_ATTEMPTED: :"message.delivery_attempted"
|
|
75
|
-
MESSAGE_ARCHIVED: :"message.archived"
|
|
76
|
-
MESSAGE_LINK_CLICKED: :"message.link_clicked"
|
|
77
75
|
MESSAGE_INTERACTED: :"message.interacted"
|
|
76
|
+
MESSAGE_UNARCHIVED: :"message.unarchived"
|
|
77
|
+
MESSAGE_LINK_CLICKED: :"message.link_clicked"
|
|
78
78
|
MESSAGE_UNSEEN: :"message.unseen"
|
|
79
79
|
MESSAGE_UNREAD: :"message.unread"
|
|
80
|
-
|
|
80
|
+
MESSAGE_CREATED: :"message.created"
|
|
81
81
|
|
|
82
82
|
def self?.values: -> ::Array[Knockapi::Models::MessageEvent::type_]
|
|
83
83
|
end
|
|
@@ -9,11 +9,9 @@ module Knockapi
|
|
|
9
9
|
guide_id: String,
|
|
10
10
|
guide_key: String,
|
|
11
11
|
guide_step_ref: String,
|
|
12
|
-
content: ::Hash[Symbol, top],
|
|
13
|
-
data: ::Hash[Symbol, top],
|
|
14
12
|
is_final: bool,
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
tenant: String,
|
|
14
|
+
unthrottled: bool
|
|
17
15
|
}
|
|
18
16
|
& Knockapi::Internal::Type::request_parameters
|
|
19
17
|
|
|
@@ -33,23 +31,17 @@ module Knockapi
|
|
|
33
31
|
|
|
34
32
|
attr_accessor guide_step_ref: String
|
|
35
33
|
|
|
36
|
-
attr_reader content: ::Hash[Symbol, top]?
|
|
37
|
-
|
|
38
|
-
def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
39
|
-
|
|
40
|
-
attr_reader data: ::Hash[Symbol, top]?
|
|
41
|
-
|
|
42
|
-
def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
43
|
-
|
|
44
34
|
attr_reader is_final: bool?
|
|
45
35
|
|
|
46
36
|
def is_final=: (bool) -> bool
|
|
47
37
|
|
|
48
|
-
attr_reader
|
|
38
|
+
attr_reader tenant: String?
|
|
39
|
+
|
|
40
|
+
def tenant=: (String) -> String
|
|
49
41
|
|
|
50
|
-
|
|
42
|
+
attr_reader unthrottled: bool?
|
|
51
43
|
|
|
52
|
-
|
|
44
|
+
def unthrottled=: (bool) -> bool
|
|
53
45
|
|
|
54
46
|
def initialize: (
|
|
55
47
|
user_id: String,
|
|
@@ -58,11 +50,9 @@ module Knockapi
|
|
|
58
50
|
guide_id: String,
|
|
59
51
|
guide_key: String,
|
|
60
52
|
guide_step_ref: String,
|
|
61
|
-
?content: ::Hash[Symbol, top],
|
|
62
|
-
?data: ::Hash[Symbol, top],
|
|
63
53
|
?is_final: bool,
|
|
64
|
-
?
|
|
65
|
-
?
|
|
54
|
+
?tenant: String,
|
|
55
|
+
?unthrottled: bool,
|
|
66
56
|
?request_options: Knockapi::request_opts
|
|
67
57
|
) -> void
|
|
68
58
|
|
|
@@ -73,11 +63,9 @@ module Knockapi
|
|
|
73
63
|
guide_id: String,
|
|
74
64
|
guide_key: String,
|
|
75
65
|
guide_step_ref: String,
|
|
76
|
-
content: ::Hash[Symbol, top],
|
|
77
|
-
data: ::Hash[Symbol, top],
|
|
78
66
|
is_final: bool,
|
|
79
|
-
|
|
80
|
-
|
|
67
|
+
tenant: String,
|
|
68
|
+
unthrottled: bool,
|
|
81
69
|
request_options: Knockapi::RequestOptions
|
|
82
70
|
}
|
|
83
71
|
end
|
|
@@ -9,11 +9,8 @@ module Knockapi
|
|
|
9
9
|
guide_id: String,
|
|
10
10
|
guide_key: String,
|
|
11
11
|
guide_step_ref: String,
|
|
12
|
-
content: ::Hash[Symbol, top],
|
|
13
|
-
data: ::Hash[Symbol, top],
|
|
14
|
-
is_final: bool,
|
|
15
12
|
metadata: ::Hash[Symbol, top],
|
|
16
|
-
tenant: String
|
|
13
|
+
tenant: String
|
|
17
14
|
}
|
|
18
15
|
& Knockapi::Internal::Type::request_parameters
|
|
19
16
|
|
|
@@ -33,23 +30,13 @@ module Knockapi
|
|
|
33
30
|
|
|
34
31
|
attr_accessor guide_step_ref: String
|
|
35
32
|
|
|
36
|
-
attr_reader content: ::Hash[Symbol, top]?
|
|
37
|
-
|
|
38
|
-
def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
39
|
-
|
|
40
|
-
attr_reader data: ::Hash[Symbol, top]?
|
|
41
|
-
|
|
42
|
-
def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
43
|
-
|
|
44
|
-
attr_reader is_final: bool?
|
|
45
|
-
|
|
46
|
-
def is_final=: (bool) -> bool
|
|
47
|
-
|
|
48
33
|
attr_reader metadata: ::Hash[Symbol, top]?
|
|
49
34
|
|
|
50
35
|
def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
51
36
|
|
|
52
|
-
|
|
37
|
+
attr_reader tenant: String?
|
|
38
|
+
|
|
39
|
+
def tenant=: (String) -> String
|
|
53
40
|
|
|
54
41
|
def initialize: (
|
|
55
42
|
user_id: String,
|
|
@@ -58,11 +45,8 @@ module Knockapi
|
|
|
58
45
|
guide_id: String,
|
|
59
46
|
guide_key: String,
|
|
60
47
|
guide_step_ref: String,
|
|
61
|
-
?content: ::Hash[Symbol, top],
|
|
62
|
-
?data: ::Hash[Symbol, top],
|
|
63
|
-
?is_final: bool,
|
|
64
48
|
?metadata: ::Hash[Symbol, top],
|
|
65
|
-
?tenant: String
|
|
49
|
+
?tenant: String,
|
|
66
50
|
?request_options: Knockapi::request_opts
|
|
67
51
|
) -> void
|
|
68
52
|
|
|
@@ -73,11 +57,8 @@ module Knockapi
|
|
|
73
57
|
guide_id: String,
|
|
74
58
|
guide_key: String,
|
|
75
59
|
guide_step_ref: String,
|
|
76
|
-
content: ::Hash[Symbol, top],
|
|
77
|
-
data: ::Hash[Symbol, top],
|
|
78
|
-
is_final: bool,
|
|
79
60
|
metadata: ::Hash[Symbol, top],
|
|
80
|
-
tenant: String
|
|
61
|
+
tenant: String,
|
|
81
62
|
request_options: Knockapi::RequestOptions
|
|
82
63
|
}
|
|
83
64
|
end
|
|
@@ -6,14 +6,12 @@ module Knockapi
|
|
|
6
6
|
user_id: String,
|
|
7
7
|
message_id: String,
|
|
8
8
|
channel_id: String,
|
|
9
|
+
content: ::Hash[Symbol, top],
|
|
9
10
|
guide_id: String,
|
|
10
11
|
guide_key: String,
|
|
11
12
|
guide_step_ref: String,
|
|
12
|
-
content: ::Hash[Symbol, top],
|
|
13
13
|
data: ::Hash[Symbol, top],
|
|
14
|
-
|
|
15
|
-
metadata: ::Hash[Symbol, top],
|
|
16
|
-
tenant: String?
|
|
14
|
+
tenant: String
|
|
17
15
|
}
|
|
18
16
|
& Knockapi::Internal::Type::request_parameters
|
|
19
17
|
|
|
@@ -27,42 +25,32 @@ module Knockapi
|
|
|
27
25
|
|
|
28
26
|
attr_accessor channel_id: String
|
|
29
27
|
|
|
28
|
+
attr_accessor content: ::Hash[Symbol, top]
|
|
29
|
+
|
|
30
30
|
attr_accessor guide_id: String
|
|
31
31
|
|
|
32
32
|
attr_accessor guide_key: String
|
|
33
33
|
|
|
34
34
|
attr_accessor guide_step_ref: String
|
|
35
35
|
|
|
36
|
-
attr_reader content: ::Hash[Symbol, top]?
|
|
37
|
-
|
|
38
|
-
def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
39
|
-
|
|
40
36
|
attr_reader data: ::Hash[Symbol, top]?
|
|
41
37
|
|
|
42
38
|
def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
43
39
|
|
|
44
|
-
attr_reader
|
|
45
|
-
|
|
46
|
-
def is_final=: (bool) -> bool
|
|
40
|
+
attr_reader tenant: String?
|
|
47
41
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
51
|
-
|
|
52
|
-
attr_accessor tenant: String?
|
|
42
|
+
def tenant=: (String) -> String
|
|
53
43
|
|
|
54
44
|
def initialize: (
|
|
55
45
|
user_id: String,
|
|
56
46
|
message_id: String,
|
|
57
47
|
channel_id: String,
|
|
48
|
+
content: ::Hash[Symbol, top],
|
|
58
49
|
guide_id: String,
|
|
59
50
|
guide_key: String,
|
|
60
51
|
guide_step_ref: String,
|
|
61
|
-
?content: ::Hash[Symbol, top],
|
|
62
52
|
?data: ::Hash[Symbol, top],
|
|
63
|
-
?
|
|
64
|
-
?metadata: ::Hash[Symbol, top],
|
|
65
|
-
?tenant: String?,
|
|
53
|
+
?tenant: String,
|
|
66
54
|
?request_options: Knockapi::request_opts
|
|
67
55
|
) -> void
|
|
68
56
|
|
|
@@ -70,14 +58,12 @@ module Knockapi
|
|
|
70
58
|
user_id: String,
|
|
71
59
|
message_id: String,
|
|
72
60
|
channel_id: String,
|
|
61
|
+
content: ::Hash[Symbol, top],
|
|
73
62
|
guide_id: String,
|
|
74
63
|
guide_key: String,
|
|
75
64
|
guide_step_ref: String,
|
|
76
|
-
content: ::Hash[Symbol, top],
|
|
77
65
|
data: ::Hash[Symbol, top],
|
|
78
|
-
|
|
79
|
-
metadata: ::Hash[Symbol, top],
|
|
80
|
-
tenant: String?,
|
|
66
|
+
tenant: String,
|
|
81
67
|
request_options: Knockapi::RequestOptions
|
|
82
68
|
}
|
|
83
69
|
end
|
|
@@ -18,11 +18,9 @@ module Knockapi
|
|
|
18
18
|
guide_id: String,
|
|
19
19
|
guide_key: String,
|
|
20
20
|
guide_step_ref: String,
|
|
21
|
-
?content: ::Hash[Symbol, top],
|
|
22
|
-
?data: ::Hash[Symbol, top],
|
|
23
21
|
?is_final: bool,
|
|
24
|
-
?
|
|
25
|
-
?
|
|
22
|
+
?tenant: String,
|
|
23
|
+
?unthrottled: bool,
|
|
26
24
|
?request_options: Knockapi::request_opts
|
|
27
25
|
) -> Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse
|
|
28
26
|
|
|
@@ -33,11 +31,8 @@ module Knockapi
|
|
|
33
31
|
guide_id: String,
|
|
34
32
|
guide_key: String,
|
|
35
33
|
guide_step_ref: String,
|
|
36
|
-
?content: ::Hash[Symbol, top],
|
|
37
|
-
?data: ::Hash[Symbol, top],
|
|
38
|
-
?is_final: bool,
|
|
39
34
|
?metadata: ::Hash[Symbol, top],
|
|
40
|
-
?tenant: String
|
|
35
|
+
?tenant: String,
|
|
41
36
|
?request_options: Knockapi::request_opts
|
|
42
37
|
) -> Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
|
|
43
38
|
|
|
@@ -45,14 +40,12 @@ module Knockapi
|
|
|
45
40
|
String user_id,
|
|
46
41
|
String message_id,
|
|
47
42
|
channel_id: String,
|
|
43
|
+
content: ::Hash[Symbol, top],
|
|
48
44
|
guide_id: String,
|
|
49
45
|
guide_key: String,
|
|
50
46
|
guide_step_ref: String,
|
|
51
|
-
?content: ::Hash[Symbol, top],
|
|
52
47
|
?data: ::Hash[Symbol, top],
|
|
53
|
-
?
|
|
54
|
-
?metadata: ::Hash[Symbol, top],
|
|
55
|
-
?tenant: String?,
|
|
48
|
+
?tenant: String,
|
|
56
49
|
?request_options: Knockapi::request_opts
|
|
57
50
|
) -> Knockapi::Models::Users::GuideMarkMessageAsSeenResponse
|
|
58
51
|
|
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.39.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Knock
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|