trycourier 4.10.1 → 4.10.2
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 +9 -0
- data/lib/courier/models/notification_list_response.rb +8 -8
- data/lib/courier/models/notification_template_create_request.rb +3 -3
- data/lib/courier/models/notification_template_payload.rb +2 -2
- data/lib/courier/models/notification_template_response.rb +71 -0
- data/lib/courier/models/notification_template_update_request.rb +3 -3
- data/lib/courier/models.rb +2 -2
- data/lib/courier/resources/notifications/checks.rb +16 -6
- data/lib/courier/resources/notifications.rb +8 -8
- data/lib/courier/version.rb +1 -1
- data/lib/courier.rb +1 -1
- data/rbi/courier/models/notification_list_response.rbi +9 -6
- data/rbi/courier/models/notification_template_create_request.rbi +4 -4
- data/rbi/courier/models/notification_template_payload.rbi +2 -2
- data/rbi/courier/models/notification_template_response.rbi +120 -0
- data/rbi/courier/models/notification_template_update_request.rbi +4 -4
- data/rbi/courier/models.rbi +2 -3
- data/rbi/courier/resources/notifications/checks.rbi +19 -4
- data/rbi/courier/resources/notifications.rbi +7 -7
- data/sig/courier/models/notification_list_response.rbs +7 -5
- data/sig/courier/models/notification_template_response.rbs +70 -0
- data/sig/courier/models.rbs +2 -2
- data/sig/courier/resources/notifications.rbs +3 -3
- metadata +5 -5
- data/lib/courier/models/notification_template_get_response.rb +0 -92
- data/rbi/courier/models/notification_template_get_response.rbi +0 -162
- data/sig/courier/models/notification_template_get_response.rbs +0 -72
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2c653d07cd54be88e8b8328788188c56e6d62e7308f6bccf582769bd38b5e413
|
|
4
|
+
data.tar.gz: 9a025d1497b0e9383686ba5c849d2784be1195c7c21a52ba24d2491f6e5ebe71
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ee312a1f98ddfd71c03692e23047237cd1205465687890e3d0dea3bd675acb6ed1ba30b340e67a85e9cd3d73017c09c29e5ef0a3946c4b6e2ccb806e7af29392
|
|
7
|
+
data.tar.gz: ac1e5417c4e7400965fc5efc5074e40cff4e5e4b5a4427795884cdba02869dbc54185252d2653c9599fe745b8a78e2fd0793675bf9a08b6a9d5d3903ee0139c8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 4.10.2 (2026-04-14)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v4.10.1...v4.10.2](https://github.com/trycourier/courier-ruby/compare/v4.10.1...v4.10.2)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
* **types:** flatten NotificationTemplateResponse model structure ([4c019eb](https://github.com/trycourier/courier-ruby/commit/4c019ebb34aaf3b6c37e778da95c593aa5faa409))
|
|
10
|
+
* **types:** make note optional, flatten NotificationTemplateGetResponse ([05f8c8c](https://github.com/trycourier/courier-ruby/commit/05f8c8c41198a2f8156ac10ccf4a67fa84130350))
|
|
11
|
+
|
|
3
12
|
## 4.10.1 (2026-04-13)
|
|
4
13
|
|
|
5
14
|
Full Changelog: [v4.10.0...v4.10.1](https://github.com/trycourier/courier-ruby/compare/v4.10.0...v4.10.1)
|
|
@@ -47,11 +47,6 @@ module Courier
|
|
|
47
47
|
# @return [Array<String>]
|
|
48
48
|
required :event_ids, Courier::Internal::Type::ArrayOf[String]
|
|
49
49
|
|
|
50
|
-
# @!attribute note
|
|
51
|
-
#
|
|
52
|
-
# @return [String]
|
|
53
|
-
required :note, String
|
|
54
|
-
|
|
55
50
|
# @!attribute routing
|
|
56
51
|
#
|
|
57
52
|
# @return [Courier::Models::MessageRouting]
|
|
@@ -67,6 +62,11 @@ module Courier
|
|
|
67
62
|
# @return [Integer]
|
|
68
63
|
required :updated_at, Integer
|
|
69
64
|
|
|
65
|
+
# @!attribute note
|
|
66
|
+
#
|
|
67
|
+
# @return [String, nil]
|
|
68
|
+
optional :note, String
|
|
69
|
+
|
|
70
70
|
# @!attribute tags
|
|
71
71
|
#
|
|
72
72
|
# @return [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
|
|
@@ -77,21 +77,21 @@ module Courier
|
|
|
77
77
|
# @return [String, nil]
|
|
78
78
|
optional :title, String, nil?: true
|
|
79
79
|
|
|
80
|
-
# @!method initialize(id:, created_at:, event_ids:,
|
|
80
|
+
# @!method initialize(id:, created_at:, event_ids:, routing:, topic_id:, updated_at:, note: nil, tags: nil, title: nil)
|
|
81
81
|
# @param id [String]
|
|
82
82
|
#
|
|
83
83
|
# @param created_at [Integer]
|
|
84
84
|
#
|
|
85
85
|
# @param event_ids [Array<String>] Array of event IDs associated with this notification
|
|
86
86
|
#
|
|
87
|
-
# @param note [String]
|
|
88
|
-
#
|
|
89
87
|
# @param routing [Courier::Models::MessageRouting]
|
|
90
88
|
#
|
|
91
89
|
# @param topic_id [String]
|
|
92
90
|
#
|
|
93
91
|
# @param updated_at [Integer]
|
|
94
92
|
#
|
|
93
|
+
# @param note [String]
|
|
94
|
+
#
|
|
95
95
|
# @param tags [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
|
|
96
96
|
#
|
|
97
97
|
# @param title [String, nil]
|
|
@@ -4,8 +4,8 @@ module Courier
|
|
|
4
4
|
module Models
|
|
5
5
|
class NotificationTemplateCreateRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute notification
|
|
7
|
-
#
|
|
8
|
-
#
|
|
7
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
8
|
+
# `notification` key) and returned at the top level in responses.
|
|
9
9
|
#
|
|
10
10
|
# @return [Courier::Models::NotificationTemplatePayload]
|
|
11
11
|
required :notification, -> { Courier::NotificationTemplatePayload }
|
|
@@ -23,7 +23,7 @@ module Courier
|
|
|
23
23
|
#
|
|
24
24
|
# Request body for creating a notification template.
|
|
25
25
|
#
|
|
26
|
-
# @param notification [Courier::Models::NotificationTemplatePayload]
|
|
26
|
+
# @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
|
|
27
27
|
#
|
|
28
28
|
# @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
|
|
29
29
|
|
|
@@ -40,8 +40,8 @@ module Courier
|
|
|
40
40
|
required :tags, Courier::Internal::Type::ArrayOf[String]
|
|
41
41
|
|
|
42
42
|
# @!method initialize(brand:, content:, name:, routing:, subscription:, tags:)
|
|
43
|
-
#
|
|
44
|
-
#
|
|
43
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
44
|
+
# `notification` key) and returned at the top level in responses.
|
|
45
45
|
#
|
|
46
46
|
# @param brand [Courier::Models::NotificationTemplatePayload::Brand, nil] Brand reference, or null for no brand.
|
|
47
47
|
#
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Courier
|
|
4
|
+
module Models
|
|
5
|
+
# @see Courier::Resources::Notifications#create
|
|
6
|
+
class NotificationTemplateResponse < Courier::Models::NotificationTemplatePayload
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The template ID.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created
|
|
14
|
+
# Epoch milliseconds when the template was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute creator
|
|
20
|
+
# User ID of the creator.
|
|
21
|
+
#
|
|
22
|
+
# @return [String]
|
|
23
|
+
required :creator, String
|
|
24
|
+
|
|
25
|
+
# @!attribute state
|
|
26
|
+
# The template state. Always uppercase.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, Courier::Models::NotificationTemplateResponse::State]
|
|
29
|
+
required :state, enum: -> { Courier::NotificationTemplateResponse::State }
|
|
30
|
+
|
|
31
|
+
# @!attribute updated
|
|
32
|
+
# Epoch milliseconds of last update.
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :updated, Integer
|
|
36
|
+
|
|
37
|
+
# @!attribute updater
|
|
38
|
+
# User ID of the last updater.
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :updater, String
|
|
42
|
+
|
|
43
|
+
# @!method initialize(id:, created:, creator:, state:, updated: nil, updater: nil)
|
|
44
|
+
# Response for GET /notifications/{id}, POST /notifications, and PUT
|
|
45
|
+
# /notifications/{id}. Returns all template fields at the top level.
|
|
46
|
+
#
|
|
47
|
+
# @param id [String] The template ID.
|
|
48
|
+
#
|
|
49
|
+
# @param created [Integer] Epoch milliseconds when the template was created.
|
|
50
|
+
#
|
|
51
|
+
# @param creator [String] User ID of the creator.
|
|
52
|
+
#
|
|
53
|
+
# @param state [Symbol, Courier::Models::NotificationTemplateResponse::State] The template state. Always uppercase.
|
|
54
|
+
#
|
|
55
|
+
# @param updated [Integer] Epoch milliseconds of last update.
|
|
56
|
+
#
|
|
57
|
+
# @param updater [String] User ID of the last updater.
|
|
58
|
+
|
|
59
|
+
# The template state. Always uppercase.
|
|
60
|
+
module State
|
|
61
|
+
extend Courier::Internal::Type::Enum
|
|
62
|
+
|
|
63
|
+
DRAFT = :DRAFT
|
|
64
|
+
PUBLISHED = :PUBLISHED
|
|
65
|
+
|
|
66
|
+
# @!method self.values
|
|
67
|
+
# @return [Array<Symbol>]
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
@@ -4,8 +4,8 @@ module Courier
|
|
|
4
4
|
module Models
|
|
5
5
|
class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute notification
|
|
7
|
-
#
|
|
8
|
-
#
|
|
7
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
8
|
+
# `notification` key) and returned at the top level in responses.
|
|
9
9
|
#
|
|
10
10
|
# @return [Courier::Models::NotificationTemplatePayload]
|
|
11
11
|
required :notification, -> { Courier::NotificationTemplatePayload }
|
|
@@ -24,7 +24,7 @@ module Courier
|
|
|
24
24
|
# Request body for replacing a notification template. Same shape as create. All
|
|
25
25
|
# fields required (PUT = full replacement).
|
|
26
26
|
#
|
|
27
|
-
# @param notification [Courier::Models::NotificationTemplatePayload]
|
|
27
|
+
# @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
|
|
28
28
|
#
|
|
29
29
|
# @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
|
|
30
30
|
|
data/lib/courier/models.rb
CHANGED
|
@@ -297,12 +297,12 @@ module Courier
|
|
|
297
297
|
|
|
298
298
|
NotificationTemplateCreateRequest = Courier::Models::NotificationTemplateCreateRequest
|
|
299
299
|
|
|
300
|
-
NotificationTemplateGetResponse = Courier::Models::NotificationTemplateGetResponse
|
|
301
|
-
|
|
302
300
|
NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
|
|
303
301
|
|
|
304
302
|
NotificationTemplatePublishRequest = Courier::Models::NotificationTemplatePublishRequest
|
|
305
303
|
|
|
304
|
+
NotificationTemplateResponse = Courier::Models::NotificationTemplateResponse
|
|
305
|
+
|
|
306
306
|
NotificationTemplateState = Courier::Models::NotificationTemplateState
|
|
307
307
|
|
|
308
308
|
NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
|
|
@@ -4,11 +4,13 @@ module Courier
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Notifications
|
|
6
6
|
class Checks
|
|
7
|
+
# Replace the checks for a notification template submission.
|
|
8
|
+
#
|
|
7
9
|
# @overload update(submission_id, id:, checks:, request_options: {})
|
|
8
10
|
#
|
|
9
|
-
# @param submission_id [String] Path param
|
|
11
|
+
# @param submission_id [String] Path param: Submission ID.
|
|
10
12
|
#
|
|
11
|
-
# @param id [String] Path param
|
|
13
|
+
# @param id [String] Path param: Notification template ID.
|
|
12
14
|
#
|
|
13
15
|
# @param checks [Array<Courier::Models::BaseCheck>] Body param
|
|
14
16
|
#
|
|
@@ -32,10 +34,14 @@ module Courier
|
|
|
32
34
|
)
|
|
33
35
|
end
|
|
34
36
|
|
|
37
|
+
# Retrieve the checks for a notification template submission.
|
|
38
|
+
#
|
|
35
39
|
# @overload list(submission_id, id:, request_options: {})
|
|
36
40
|
#
|
|
37
|
-
# @param submission_id [String]
|
|
38
|
-
#
|
|
41
|
+
# @param submission_id [String] Submission ID.
|
|
42
|
+
#
|
|
43
|
+
# @param id [String] Notification template ID.
|
|
44
|
+
#
|
|
39
45
|
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
40
46
|
#
|
|
41
47
|
# @return [Courier::Models::Notifications::CheckListResponse]
|
|
@@ -55,10 +61,14 @@ module Courier
|
|
|
55
61
|
)
|
|
56
62
|
end
|
|
57
63
|
|
|
64
|
+
# Cancel a notification template submission.
|
|
65
|
+
#
|
|
58
66
|
# @overload delete(submission_id, id:, request_options: {})
|
|
59
67
|
#
|
|
60
|
-
# @param submission_id [String]
|
|
61
|
-
#
|
|
68
|
+
# @param submission_id [String] Submission ID.
|
|
69
|
+
#
|
|
70
|
+
# @param id [String] Notification template ID.
|
|
71
|
+
#
|
|
62
72
|
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
63
73
|
#
|
|
64
74
|
# @return [nil]
|
|
@@ -14,13 +14,13 @@ module Courier
|
|
|
14
14
|
#
|
|
15
15
|
# @overload create(notification:, state: nil, request_options: {})
|
|
16
16
|
#
|
|
17
|
-
# @param notification [Courier::Models::NotificationTemplatePayload]
|
|
17
|
+
# @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
|
|
18
18
|
#
|
|
19
19
|
# @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
|
|
20
20
|
#
|
|
21
21
|
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
22
|
#
|
|
23
|
-
# @return [Courier::Models::
|
|
23
|
+
# @return [Courier::Models::NotificationTemplateResponse]
|
|
24
24
|
#
|
|
25
25
|
# @see Courier::Models::NotificationCreateParams
|
|
26
26
|
def create(params)
|
|
@@ -29,7 +29,7 @@ module Courier
|
|
|
29
29
|
method: :post,
|
|
30
30
|
path: "notifications",
|
|
31
31
|
body: parsed,
|
|
32
|
-
model: Courier::
|
|
32
|
+
model: Courier::NotificationTemplateResponse,
|
|
33
33
|
options: options
|
|
34
34
|
)
|
|
35
35
|
end
|
|
@@ -48,7 +48,7 @@ module Courier
|
|
|
48
48
|
#
|
|
49
49
|
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
50
50
|
#
|
|
51
|
-
# @return [Courier::Models::
|
|
51
|
+
# @return [Courier::Models::NotificationTemplateResponse]
|
|
52
52
|
#
|
|
53
53
|
# @see Courier::Models::NotificationRetrieveParams
|
|
54
54
|
def retrieve(id, params = {})
|
|
@@ -58,7 +58,7 @@ module Courier
|
|
|
58
58
|
method: :get,
|
|
59
59
|
path: ["notifications/%1$s", id],
|
|
60
60
|
query: query,
|
|
61
|
-
model: Courier::
|
|
61
|
+
model: Courier::NotificationTemplateResponse,
|
|
62
62
|
options: options
|
|
63
63
|
)
|
|
64
64
|
end
|
|
@@ -276,13 +276,13 @@ module Courier
|
|
|
276
276
|
#
|
|
277
277
|
# @param id [String] Template ID (nt\_ prefix).
|
|
278
278
|
#
|
|
279
|
-
# @param notification [Courier::Models::NotificationTemplatePayload]
|
|
279
|
+
# @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
|
|
280
280
|
#
|
|
281
281
|
# @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
|
|
282
282
|
#
|
|
283
283
|
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
284
284
|
#
|
|
285
|
-
# @return [Courier::Models::
|
|
285
|
+
# @return [Courier::Models::NotificationTemplateResponse]
|
|
286
286
|
#
|
|
287
287
|
# @see Courier::Models::NotificationReplaceParams
|
|
288
288
|
def replace(id, params)
|
|
@@ -291,7 +291,7 @@ module Courier
|
|
|
291
291
|
method: :put,
|
|
292
292
|
path: ["notifications/%1$s", id],
|
|
293
293
|
body: parsed,
|
|
294
|
-
model: Courier::
|
|
294
|
+
model: Courier::NotificationTemplateResponse,
|
|
295
295
|
options: options
|
|
296
296
|
)
|
|
297
297
|
end
|
data/lib/courier/version.rb
CHANGED
data/lib/courier.rb
CHANGED
|
@@ -216,7 +216,7 @@ require_relative "courier/models/notifications/check_list_params"
|
|
|
216
216
|
require_relative "courier/models/notifications/check_list_response"
|
|
217
217
|
require_relative "courier/models/notifications/check_update_params"
|
|
218
218
|
require_relative "courier/models/notifications/check_update_response"
|
|
219
|
-
require_relative "courier/models/
|
|
219
|
+
require_relative "courier/models/notification_template_response"
|
|
220
220
|
require_relative "courier/models/notification_template_state"
|
|
221
221
|
require_relative "courier/models/notification_template_summary"
|
|
222
222
|
require_relative "courier/models/notification_template_version_list_response"
|
|
@@ -89,9 +89,6 @@ module Courier
|
|
|
89
89
|
sig { returns(T::Array[String]) }
|
|
90
90
|
attr_accessor :event_ids
|
|
91
91
|
|
|
92
|
-
sig { returns(String) }
|
|
93
|
-
attr_accessor :note
|
|
94
|
-
|
|
95
92
|
sig { returns(Courier::MessageRouting) }
|
|
96
93
|
attr_reader :routing
|
|
97
94
|
|
|
@@ -104,6 +101,12 @@ module Courier
|
|
|
104
101
|
sig { returns(Integer) }
|
|
105
102
|
attr_accessor :updated_at
|
|
106
103
|
|
|
104
|
+
sig { returns(T.nilable(String)) }
|
|
105
|
+
attr_reader :note
|
|
106
|
+
|
|
107
|
+
sig { params(note: String).void }
|
|
108
|
+
attr_writer :note
|
|
109
|
+
|
|
107
110
|
sig do
|
|
108
111
|
returns(
|
|
109
112
|
T.nilable(
|
|
@@ -131,10 +134,10 @@ module Courier
|
|
|
131
134
|
id: String,
|
|
132
135
|
created_at: Integer,
|
|
133
136
|
event_ids: T::Array[String],
|
|
134
|
-
note: String,
|
|
135
137
|
routing: Courier::MessageRouting::OrHash,
|
|
136
138
|
topic_id: String,
|
|
137
139
|
updated_at: Integer,
|
|
140
|
+
note: String,
|
|
138
141
|
tags:
|
|
139
142
|
T.nilable(
|
|
140
143
|
Courier::Models::NotificationListResponse::Result::Notification::Tags::OrHash
|
|
@@ -147,10 +150,10 @@ module Courier
|
|
|
147
150
|
created_at:,
|
|
148
151
|
# Array of event IDs associated with this notification
|
|
149
152
|
event_ids:,
|
|
150
|
-
note:,
|
|
151
153
|
routing:,
|
|
152
154
|
topic_id:,
|
|
153
155
|
updated_at:,
|
|
156
|
+
note: nil,
|
|
154
157
|
tags: nil,
|
|
155
158
|
title: nil
|
|
156
159
|
)
|
|
@@ -162,10 +165,10 @@ module Courier
|
|
|
162
165
|
id: String,
|
|
163
166
|
created_at: Integer,
|
|
164
167
|
event_ids: T::Array[String],
|
|
165
|
-
note: String,
|
|
166
168
|
routing: Courier::MessageRouting,
|
|
167
169
|
topic_id: String,
|
|
168
170
|
updated_at: Integer,
|
|
171
|
+
note: String,
|
|
169
172
|
tags:
|
|
170
173
|
T.nilable(
|
|
171
174
|
Courier::Models::NotificationListResponse::Result::Notification::Tags
|
|
@@ -11,8 +11,8 @@ module Courier
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
#
|
|
15
|
-
#
|
|
14
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
15
|
+
# `notification` key) and returned at the top level in responses.
|
|
16
16
|
sig { returns(Courier::NotificationTemplatePayload) }
|
|
17
17
|
attr_reader :notification
|
|
18
18
|
|
|
@@ -45,8 +45,8 @@ module Courier
|
|
|
45
45
|
).returns(T.attached_class)
|
|
46
46
|
end
|
|
47
47
|
def self.new(
|
|
48
|
-
#
|
|
49
|
-
#
|
|
48
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
49
|
+
# `notification` key) and returned at the top level in responses.
|
|
50
50
|
notification:,
|
|
51
51
|
# Template state after creation. Case-insensitive input, normalized to uppercase
|
|
52
52
|
# in the response. Defaults to "DRAFT".
|
|
@@ -65,8 +65,8 @@ module Courier
|
|
|
65
65
|
sig { returns(T::Array[String]) }
|
|
66
66
|
attr_accessor :tags
|
|
67
67
|
|
|
68
|
-
#
|
|
69
|
-
#
|
|
68
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
69
|
+
# `notification` key) and returned at the top level in responses.
|
|
70
70
|
sig do
|
|
71
71
|
params(
|
|
72
72
|
brand: T.nilable(Courier::NotificationTemplatePayload::Brand::OrHash),
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Courier
|
|
4
|
+
module Models
|
|
5
|
+
class NotificationTemplateResponse < Courier::Models::NotificationTemplatePayload
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias do
|
|
8
|
+
T.any(
|
|
9
|
+
Courier::NotificationTemplateResponse,
|
|
10
|
+
Courier::Internal::AnyHash
|
|
11
|
+
)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
# The template ID.
|
|
15
|
+
sig { returns(String) }
|
|
16
|
+
attr_accessor :id
|
|
17
|
+
|
|
18
|
+
# Epoch milliseconds when the template was created.
|
|
19
|
+
sig { returns(Integer) }
|
|
20
|
+
attr_accessor :created
|
|
21
|
+
|
|
22
|
+
# User ID of the creator.
|
|
23
|
+
sig { returns(String) }
|
|
24
|
+
attr_accessor :creator
|
|
25
|
+
|
|
26
|
+
# The template state. Always uppercase.
|
|
27
|
+
sig do
|
|
28
|
+
returns(Courier::NotificationTemplateResponse::State::TaggedSymbol)
|
|
29
|
+
end
|
|
30
|
+
attr_accessor :state
|
|
31
|
+
|
|
32
|
+
# Epoch milliseconds of last update.
|
|
33
|
+
sig { returns(T.nilable(Integer)) }
|
|
34
|
+
attr_reader :updated
|
|
35
|
+
|
|
36
|
+
sig { params(updated: Integer).void }
|
|
37
|
+
attr_writer :updated
|
|
38
|
+
|
|
39
|
+
# User ID of the last updater.
|
|
40
|
+
sig { returns(T.nilable(String)) }
|
|
41
|
+
attr_reader :updater
|
|
42
|
+
|
|
43
|
+
sig { params(updater: String).void }
|
|
44
|
+
attr_writer :updater
|
|
45
|
+
|
|
46
|
+
# Response for GET /notifications/{id}, POST /notifications, and PUT
|
|
47
|
+
# /notifications/{id}. Returns all template fields at the top level.
|
|
48
|
+
sig do
|
|
49
|
+
params(
|
|
50
|
+
id: String,
|
|
51
|
+
created: Integer,
|
|
52
|
+
creator: String,
|
|
53
|
+
state: Courier::NotificationTemplateResponse::State::OrSymbol,
|
|
54
|
+
updated: Integer,
|
|
55
|
+
updater: String
|
|
56
|
+
).returns(T.attached_class)
|
|
57
|
+
end
|
|
58
|
+
def self.new(
|
|
59
|
+
# The template ID.
|
|
60
|
+
id:,
|
|
61
|
+
# Epoch milliseconds when the template was created.
|
|
62
|
+
created:,
|
|
63
|
+
# User ID of the creator.
|
|
64
|
+
creator:,
|
|
65
|
+
# The template state. Always uppercase.
|
|
66
|
+
state:,
|
|
67
|
+
# Epoch milliseconds of last update.
|
|
68
|
+
updated: nil,
|
|
69
|
+
# User ID of the last updater.
|
|
70
|
+
updater: nil
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
sig do
|
|
75
|
+
override.returns(
|
|
76
|
+
{
|
|
77
|
+
id: String,
|
|
78
|
+
created: Integer,
|
|
79
|
+
creator: String,
|
|
80
|
+
state: Courier::NotificationTemplateResponse::State::TaggedSymbol,
|
|
81
|
+
updated: Integer,
|
|
82
|
+
updater: String
|
|
83
|
+
}
|
|
84
|
+
)
|
|
85
|
+
end
|
|
86
|
+
def to_hash
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# The template state. Always uppercase.
|
|
90
|
+
module State
|
|
91
|
+
extend Courier::Internal::Type::Enum
|
|
92
|
+
|
|
93
|
+
TaggedSymbol =
|
|
94
|
+
T.type_alias do
|
|
95
|
+
T.all(Symbol, Courier::NotificationTemplateResponse::State)
|
|
96
|
+
end
|
|
97
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
98
|
+
|
|
99
|
+
DRAFT =
|
|
100
|
+
T.let(
|
|
101
|
+
:DRAFT,
|
|
102
|
+
Courier::NotificationTemplateResponse::State::TaggedSymbol
|
|
103
|
+
)
|
|
104
|
+
PUBLISHED =
|
|
105
|
+
T.let(
|
|
106
|
+
:PUBLISHED,
|
|
107
|
+
Courier::NotificationTemplateResponse::State::TaggedSymbol
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
sig do
|
|
111
|
+
override.returns(
|
|
112
|
+
T::Array[Courier::NotificationTemplateResponse::State::TaggedSymbol]
|
|
113
|
+
)
|
|
114
|
+
end
|
|
115
|
+
def self.values
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
|
@@ -11,8 +11,8 @@ module Courier
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
#
|
|
15
|
-
#
|
|
14
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
15
|
+
# `notification` key) and returned at the top level in responses.
|
|
16
16
|
sig { returns(Courier::NotificationTemplatePayload) }
|
|
17
17
|
attr_reader :notification
|
|
18
18
|
|
|
@@ -46,8 +46,8 @@ module Courier
|
|
|
46
46
|
).returns(T.attached_class)
|
|
47
47
|
end
|
|
48
48
|
def self.new(
|
|
49
|
-
#
|
|
50
|
-
#
|
|
49
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
50
|
+
# `notification` key) and returned at the top level in responses.
|
|
51
51
|
notification:,
|
|
52
52
|
# Template state after update. Case-insensitive input, normalized to uppercase in
|
|
53
53
|
# the response. Defaults to "DRAFT".
|
data/rbi/courier/models.rbi
CHANGED
|
@@ -266,14 +266,13 @@ module Courier
|
|
|
266
266
|
NotificationTemplateCreateRequest =
|
|
267
267
|
Courier::Models::NotificationTemplateCreateRequest
|
|
268
268
|
|
|
269
|
-
NotificationTemplateGetResponse =
|
|
270
|
-
Courier::Models::NotificationTemplateGetResponse
|
|
271
|
-
|
|
272
269
|
NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
|
|
273
270
|
|
|
274
271
|
NotificationTemplatePublishRequest =
|
|
275
272
|
Courier::Models::NotificationTemplatePublishRequest
|
|
276
273
|
|
|
274
|
+
NotificationTemplateResponse = Courier::Models::NotificationTemplateResponse
|
|
275
|
+
|
|
277
276
|
NotificationTemplateState = Courier::Models::NotificationTemplateState
|
|
278
277
|
|
|
279
278
|
NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
|
|
@@ -4,6 +4,7 @@ module Courier
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Notifications
|
|
6
6
|
class Checks
|
|
7
|
+
# Replace the checks for a notification template submission.
|
|
7
8
|
sig do
|
|
8
9
|
params(
|
|
9
10
|
submission_id: String,
|
|
@@ -13,9 +14,9 @@ module Courier
|
|
|
13
14
|
).returns(Courier::Models::Notifications::CheckUpdateResponse)
|
|
14
15
|
end
|
|
15
16
|
def update(
|
|
16
|
-
# Path param
|
|
17
|
+
# Path param: Submission ID.
|
|
17
18
|
submission_id,
|
|
18
|
-
# Path param
|
|
19
|
+
# Path param: Notification template ID.
|
|
19
20
|
id:,
|
|
20
21
|
# Body param
|
|
21
22
|
checks:,
|
|
@@ -23,6 +24,7 @@ module Courier
|
|
|
23
24
|
)
|
|
24
25
|
end
|
|
25
26
|
|
|
27
|
+
# Retrieve the checks for a notification template submission.
|
|
26
28
|
sig do
|
|
27
29
|
params(
|
|
28
30
|
submission_id: String,
|
|
@@ -30,9 +32,16 @@ module Courier
|
|
|
30
32
|
request_options: Courier::RequestOptions::OrHash
|
|
31
33
|
).returns(Courier::Models::Notifications::CheckListResponse)
|
|
32
34
|
end
|
|
33
|
-
def list(
|
|
35
|
+
def list(
|
|
36
|
+
# Submission ID.
|
|
37
|
+
submission_id,
|
|
38
|
+
# Notification template ID.
|
|
39
|
+
id:,
|
|
40
|
+
request_options: {}
|
|
41
|
+
)
|
|
34
42
|
end
|
|
35
43
|
|
|
44
|
+
# Cancel a notification template submission.
|
|
36
45
|
sig do
|
|
37
46
|
params(
|
|
38
47
|
submission_id: String,
|
|
@@ -40,7 +49,13 @@ module Courier
|
|
|
40
49
|
request_options: Courier::RequestOptions::OrHash
|
|
41
50
|
).void
|
|
42
51
|
end
|
|
43
|
-
def delete(
|
|
52
|
+
def delete(
|
|
53
|
+
# Submission ID.
|
|
54
|
+
submission_id,
|
|
55
|
+
# Notification template ID.
|
|
56
|
+
id:,
|
|
57
|
+
request_options: {}
|
|
58
|
+
)
|
|
44
59
|
end
|
|
45
60
|
|
|
46
61
|
# @api private
|
|
@@ -13,11 +13,11 @@ module Courier
|
|
|
13
13
|
notification: Courier::NotificationTemplatePayload::OrHash,
|
|
14
14
|
state: Courier::NotificationTemplateCreateRequest::State::OrSymbol,
|
|
15
15
|
request_options: Courier::RequestOptions::OrHash
|
|
16
|
-
).returns(Courier::
|
|
16
|
+
).returns(Courier::NotificationTemplateResponse)
|
|
17
17
|
end
|
|
18
18
|
def create(
|
|
19
|
-
#
|
|
20
|
-
#
|
|
19
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
20
|
+
# `notification` key) and returned at the top level in responses.
|
|
21
21
|
notification:,
|
|
22
22
|
# Template state after creation. Case-insensitive input, normalized to uppercase
|
|
23
23
|
# in the response. Defaults to "DRAFT".
|
|
@@ -33,7 +33,7 @@ module Courier
|
|
|
33
33
|
id: String,
|
|
34
34
|
version: String,
|
|
35
35
|
request_options: Courier::RequestOptions::OrHash
|
|
36
|
-
).returns(Courier::
|
|
36
|
+
).returns(Courier::NotificationTemplateResponse)
|
|
37
37
|
end
|
|
38
38
|
def retrieve(
|
|
39
39
|
# Template ID (nt\_ prefix).
|
|
@@ -211,13 +211,13 @@ module Courier
|
|
|
211
211
|
notification: Courier::NotificationTemplatePayload::OrHash,
|
|
212
212
|
state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol,
|
|
213
213
|
request_options: Courier::RequestOptions::OrHash
|
|
214
|
-
).returns(Courier::
|
|
214
|
+
).returns(Courier::NotificationTemplateResponse)
|
|
215
215
|
end
|
|
216
216
|
def replace(
|
|
217
217
|
# Template ID (nt\_ prefix).
|
|
218
218
|
id,
|
|
219
|
-
#
|
|
220
|
-
#
|
|
219
|
+
# Core template fields used in POST and PUT request bodies (nested under a
|
|
220
|
+
# `notification` key) and returned at the top level in responses.
|
|
221
221
|
notification:,
|
|
222
222
|
# Template state after update. Case-insensitive input, normalized to uppercase in
|
|
223
223
|
# the response. Defaults to "DRAFT".
|
|
@@ -33,10 +33,10 @@ module Courier
|
|
|
33
33
|
id: String,
|
|
34
34
|
created_at: Integer,
|
|
35
35
|
event_ids: ::Array[String],
|
|
36
|
-
note: String,
|
|
37
36
|
routing: Courier::MessageRouting,
|
|
38
37
|
topic_id: String,
|
|
39
38
|
updated_at: Integer,
|
|
39
|
+
note: String,
|
|
40
40
|
tags: Courier::Models::NotificationListResponse::Result::Notification::Tags?,
|
|
41
41
|
title: String?
|
|
42
42
|
}
|
|
@@ -48,14 +48,16 @@ module Courier
|
|
|
48
48
|
|
|
49
49
|
attr_accessor event_ids: ::Array[String]
|
|
50
50
|
|
|
51
|
-
attr_accessor note: String
|
|
52
|
-
|
|
53
51
|
attr_accessor routing: Courier::MessageRouting
|
|
54
52
|
|
|
55
53
|
attr_accessor topic_id: String
|
|
56
54
|
|
|
57
55
|
attr_accessor updated_at: Integer
|
|
58
56
|
|
|
57
|
+
attr_reader note: String?
|
|
58
|
+
|
|
59
|
+
def note=: (String) -> String
|
|
60
|
+
|
|
59
61
|
attr_accessor tags: Courier::Models::NotificationListResponse::Result::Notification::Tags?
|
|
60
62
|
|
|
61
63
|
attr_accessor title: String?
|
|
@@ -64,10 +66,10 @@ module Courier
|
|
|
64
66
|
id: String,
|
|
65
67
|
created_at: Integer,
|
|
66
68
|
event_ids: ::Array[String],
|
|
67
|
-
note: String,
|
|
68
69
|
routing: Courier::MessageRouting,
|
|
69
70
|
topic_id: String,
|
|
70
71
|
updated_at: Integer,
|
|
72
|
+
?note: String,
|
|
71
73
|
?tags: Courier::Models::NotificationListResponse::Result::Notification::Tags?,
|
|
72
74
|
?title: String?
|
|
73
75
|
) -> void
|
|
@@ -76,10 +78,10 @@ module Courier
|
|
|
76
78
|
id: String,
|
|
77
79
|
created_at: Integer,
|
|
78
80
|
event_ids: ::Array[String],
|
|
79
|
-
note: String,
|
|
80
81
|
routing: Courier::MessageRouting,
|
|
81
82
|
topic_id: String,
|
|
82
83
|
updated_at: Integer,
|
|
84
|
+
note: String,
|
|
83
85
|
tags: Courier::Models::NotificationListResponse::Result::Notification::Tags?,
|
|
84
86
|
title: String?
|
|
85
87
|
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
module Courier
|
|
2
|
+
module Models
|
|
3
|
+
type notification_template_response =
|
|
4
|
+
{
|
|
5
|
+
id: String,
|
|
6
|
+
created: Integer,
|
|
7
|
+
creator: String,
|
|
8
|
+
state: Courier::Models::NotificationTemplateResponse::state,
|
|
9
|
+
updated: Integer,
|
|
10
|
+
updater: String
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
class NotificationTemplateResponse < Courier::Models::NotificationTemplatePayload
|
|
14
|
+
def id: -> String
|
|
15
|
+
|
|
16
|
+
def id=: (String _) -> String
|
|
17
|
+
|
|
18
|
+
def created: -> Integer
|
|
19
|
+
|
|
20
|
+
def created=: (Integer _) -> Integer
|
|
21
|
+
|
|
22
|
+
def creator: -> String
|
|
23
|
+
|
|
24
|
+
def creator=: (String _) -> String
|
|
25
|
+
|
|
26
|
+
def state: -> Courier::Models::NotificationTemplateResponse::state
|
|
27
|
+
|
|
28
|
+
def state=: (
|
|
29
|
+
Courier::Models::NotificationTemplateResponse::state _
|
|
30
|
+
) -> Courier::Models::NotificationTemplateResponse::state
|
|
31
|
+
|
|
32
|
+
def updated: -> Integer?
|
|
33
|
+
|
|
34
|
+
def updated=: (Integer _) -> Integer
|
|
35
|
+
|
|
36
|
+
def updater: -> String?
|
|
37
|
+
|
|
38
|
+
def updater=: (String _) -> String
|
|
39
|
+
|
|
40
|
+
def initialize: (
|
|
41
|
+
id: String,
|
|
42
|
+
created: Integer,
|
|
43
|
+
creator: String,
|
|
44
|
+
state: Courier::Models::NotificationTemplateResponse::state,
|
|
45
|
+
?updated: Integer,
|
|
46
|
+
?updater: String
|
|
47
|
+
) -> void
|
|
48
|
+
|
|
49
|
+
def to_hash: -> {
|
|
50
|
+
id: String,
|
|
51
|
+
created: Integer,
|
|
52
|
+
creator: String,
|
|
53
|
+
state: Courier::Models::NotificationTemplateResponse::state,
|
|
54
|
+
updated: Integer,
|
|
55
|
+
updater: String
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
type state = :DRAFT | :PUBLISHED
|
|
59
|
+
|
|
60
|
+
module State
|
|
61
|
+
extend Courier::Internal::Type::Enum
|
|
62
|
+
|
|
63
|
+
DRAFT: :DRAFT
|
|
64
|
+
PUBLISHED: :PUBLISHED
|
|
65
|
+
|
|
66
|
+
def self?.values: -> ::Array[Courier::Models::NotificationTemplateResponse::state]
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
data/sig/courier/models.rbs
CHANGED
|
@@ -255,12 +255,12 @@ module Courier
|
|
|
255
255
|
|
|
256
256
|
class NotificationTemplateCreateRequest = Courier::Models::NotificationTemplateCreateRequest
|
|
257
257
|
|
|
258
|
-
class NotificationTemplateGetResponse = Courier::Models::NotificationTemplateGetResponse
|
|
259
|
-
|
|
260
258
|
class NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
|
|
261
259
|
|
|
262
260
|
class NotificationTemplatePublishRequest = Courier::Models::NotificationTemplatePublishRequest
|
|
263
261
|
|
|
262
|
+
class NotificationTemplateResponse = Courier::Models::NotificationTemplateResponse
|
|
263
|
+
|
|
264
264
|
module NotificationTemplateState = Courier::Models::NotificationTemplateState
|
|
265
265
|
|
|
266
266
|
class NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
|
|
@@ -7,13 +7,13 @@ module Courier
|
|
|
7
7
|
notification: Courier::NotificationTemplatePayload,
|
|
8
8
|
?state: Courier::Models::NotificationTemplateCreateRequest::state,
|
|
9
9
|
?request_options: Courier::request_opts
|
|
10
|
-
) -> Courier::
|
|
10
|
+
) -> Courier::NotificationTemplateResponse
|
|
11
11
|
|
|
12
12
|
def retrieve: (
|
|
13
13
|
String id,
|
|
14
14
|
?version: String,
|
|
15
15
|
?request_options: Courier::request_opts
|
|
16
|
-
) -> Courier::
|
|
16
|
+
) -> Courier::NotificationTemplateResponse
|
|
17
17
|
|
|
18
18
|
def list: (
|
|
19
19
|
?cursor: String?,
|
|
@@ -70,7 +70,7 @@ module Courier
|
|
|
70
70
|
notification: Courier::NotificationTemplatePayload,
|
|
71
71
|
?state: Courier::Models::NotificationTemplateUpdateRequest::state,
|
|
72
72
|
?request_options: Courier::request_opts
|
|
73
|
-
) -> Courier::
|
|
73
|
+
) -> Courier::NotificationTemplateResponse
|
|
74
74
|
|
|
75
75
|
def retrieve_content: (
|
|
76
76
|
String id,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: trycourier
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.10.
|
|
4
|
+
version: 4.10.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Courier
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-04-
|
|
11
|
+
date: 2026-04-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -219,9 +219,9 @@ files:
|
|
|
219
219
|
- lib/courier/models/notification_retrieve_content_response.rb
|
|
220
220
|
- lib/courier/models/notification_retrieve_params.rb
|
|
221
221
|
- lib/courier/models/notification_template_create_request.rb
|
|
222
|
-
- lib/courier/models/notification_template_get_response.rb
|
|
223
222
|
- lib/courier/models/notification_template_payload.rb
|
|
224
223
|
- lib/courier/models/notification_template_publish_request.rb
|
|
224
|
+
- lib/courier/models/notification_template_response.rb
|
|
225
225
|
- lib/courier/models/notification_template_state.rb
|
|
226
226
|
- lib/courier/models/notification_template_summary.rb
|
|
227
227
|
- lib/courier/models/notification_template_update_request.rb
|
|
@@ -558,9 +558,9 @@ files:
|
|
|
558
558
|
- rbi/courier/models/notification_retrieve_content_response.rbi
|
|
559
559
|
- rbi/courier/models/notification_retrieve_params.rbi
|
|
560
560
|
- rbi/courier/models/notification_template_create_request.rbi
|
|
561
|
-
- rbi/courier/models/notification_template_get_response.rbi
|
|
562
561
|
- rbi/courier/models/notification_template_payload.rbi
|
|
563
562
|
- rbi/courier/models/notification_template_publish_request.rbi
|
|
563
|
+
- rbi/courier/models/notification_template_response.rbi
|
|
564
564
|
- rbi/courier/models/notification_template_state.rbi
|
|
565
565
|
- rbi/courier/models/notification_template_summary.rbi
|
|
566
566
|
- rbi/courier/models/notification_template_update_request.rbi
|
|
@@ -896,9 +896,9 @@ files:
|
|
|
896
896
|
- sig/courier/models/notification_retrieve_content_response.rbs
|
|
897
897
|
- sig/courier/models/notification_retrieve_params.rbs
|
|
898
898
|
- sig/courier/models/notification_template_create_request.rbs
|
|
899
|
-
- sig/courier/models/notification_template_get_response.rbs
|
|
900
899
|
- sig/courier/models/notification_template_payload.rbs
|
|
901
900
|
- sig/courier/models/notification_template_publish_request.rbs
|
|
901
|
+
- sig/courier/models/notification_template_response.rbs
|
|
902
902
|
- sig/courier/models/notification_template_state.rbs
|
|
903
903
|
- sig/courier/models/notification_template_summary.rbs
|
|
904
904
|
- sig/courier/models/notification_template_update_request.rbs
|
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Notifications#create
|
|
6
|
-
class NotificationTemplateGetResponse < Courier::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute created
|
|
8
|
-
# Epoch milliseconds when the template was created.
|
|
9
|
-
#
|
|
10
|
-
# @return [Integer]
|
|
11
|
-
required :created, Integer
|
|
12
|
-
|
|
13
|
-
# @!attribute creator
|
|
14
|
-
# User ID of the creator.
|
|
15
|
-
#
|
|
16
|
-
# @return [String]
|
|
17
|
-
required :creator, String
|
|
18
|
-
|
|
19
|
-
# @!attribute notification
|
|
20
|
-
# Full document shape used in POST and PUT request bodies, and returned inside the
|
|
21
|
-
# GET response envelope.
|
|
22
|
-
#
|
|
23
|
-
# @return [Courier::Models::NotificationTemplateGetResponse::Notification]
|
|
24
|
-
required :notification, -> { Courier::NotificationTemplateGetResponse::Notification }
|
|
25
|
-
|
|
26
|
-
# @!attribute state
|
|
27
|
-
# The template state. Always uppercase.
|
|
28
|
-
#
|
|
29
|
-
# @return [Symbol, Courier::Models::NotificationTemplateGetResponse::State]
|
|
30
|
-
required :state, enum: -> { Courier::NotificationTemplateGetResponse::State }
|
|
31
|
-
|
|
32
|
-
# @!attribute updated
|
|
33
|
-
# Epoch milliseconds of last update.
|
|
34
|
-
#
|
|
35
|
-
# @return [Integer, nil]
|
|
36
|
-
optional :updated, Integer
|
|
37
|
-
|
|
38
|
-
# @!attribute updater
|
|
39
|
-
# User ID of the last updater.
|
|
40
|
-
#
|
|
41
|
-
# @return [String, nil]
|
|
42
|
-
optional :updater, String
|
|
43
|
-
|
|
44
|
-
# @!method initialize(created:, creator:, notification:, state:, updated: nil, updater: nil)
|
|
45
|
-
# Some parameter documentations has been truncated, see
|
|
46
|
-
# {Courier::Models::NotificationTemplateGetResponse} for more details.
|
|
47
|
-
#
|
|
48
|
-
# Envelope response for GET /notifications/{id}. The notification object mirrors
|
|
49
|
-
# the POST/PUT input shape. Nullable fields return null when unset.
|
|
50
|
-
#
|
|
51
|
-
# @param created [Integer] Epoch milliseconds when the template was created.
|
|
52
|
-
#
|
|
53
|
-
# @param creator [String] User ID of the creator.
|
|
54
|
-
#
|
|
55
|
-
# @param notification [Courier::Models::NotificationTemplateGetResponse::Notification] Full document shape used in POST and PUT request bodies, and returned inside the
|
|
56
|
-
#
|
|
57
|
-
# @param state [Symbol, Courier::Models::NotificationTemplateGetResponse::State] The template state. Always uppercase.
|
|
58
|
-
#
|
|
59
|
-
# @param updated [Integer] Epoch milliseconds of last update.
|
|
60
|
-
#
|
|
61
|
-
# @param updater [String] User ID of the last updater.
|
|
62
|
-
|
|
63
|
-
# @see Courier::Models::NotificationTemplateGetResponse#notification
|
|
64
|
-
class Notification < Courier::Models::NotificationTemplatePayload
|
|
65
|
-
# @!attribute id
|
|
66
|
-
# The template ID.
|
|
67
|
-
#
|
|
68
|
-
# @return [String]
|
|
69
|
-
required :id, String
|
|
70
|
-
|
|
71
|
-
# @!method initialize(id:)
|
|
72
|
-
# Full document shape used in POST and PUT request bodies, and returned inside the
|
|
73
|
-
# GET response envelope.
|
|
74
|
-
#
|
|
75
|
-
# @param id [String] The template ID.
|
|
76
|
-
end
|
|
77
|
-
|
|
78
|
-
# The template state. Always uppercase.
|
|
79
|
-
#
|
|
80
|
-
# @see Courier::Models::NotificationTemplateGetResponse#state
|
|
81
|
-
module State
|
|
82
|
-
extend Courier::Internal::Type::Enum
|
|
83
|
-
|
|
84
|
-
DRAFT = :DRAFT
|
|
85
|
-
PUBLISHED = :PUBLISHED
|
|
86
|
-
|
|
87
|
-
# @!method self.values
|
|
88
|
-
# @return [Array<Symbol>]
|
|
89
|
-
end
|
|
90
|
-
end
|
|
91
|
-
end
|
|
92
|
-
end
|
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
class NotificationTemplateGetResponse < Courier::Internal::Type::BaseModel
|
|
6
|
-
OrHash =
|
|
7
|
-
T.type_alias do
|
|
8
|
-
T.any(
|
|
9
|
-
Courier::NotificationTemplateGetResponse,
|
|
10
|
-
Courier::Internal::AnyHash
|
|
11
|
-
)
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
# Epoch milliseconds when the template was created.
|
|
15
|
-
sig { returns(Integer) }
|
|
16
|
-
attr_accessor :created
|
|
17
|
-
|
|
18
|
-
# User ID of the creator.
|
|
19
|
-
sig { returns(String) }
|
|
20
|
-
attr_accessor :creator
|
|
21
|
-
|
|
22
|
-
# Full document shape used in POST and PUT request bodies, and returned inside the
|
|
23
|
-
# GET response envelope.
|
|
24
|
-
sig { returns(Courier::NotificationTemplateGetResponse::Notification) }
|
|
25
|
-
attr_reader :notification
|
|
26
|
-
|
|
27
|
-
sig do
|
|
28
|
-
params(
|
|
29
|
-
notification:
|
|
30
|
-
Courier::NotificationTemplateGetResponse::Notification::OrHash
|
|
31
|
-
).void
|
|
32
|
-
end
|
|
33
|
-
attr_writer :notification
|
|
34
|
-
|
|
35
|
-
# The template state. Always uppercase.
|
|
36
|
-
sig do
|
|
37
|
-
returns(Courier::NotificationTemplateGetResponse::State::TaggedSymbol)
|
|
38
|
-
end
|
|
39
|
-
attr_accessor :state
|
|
40
|
-
|
|
41
|
-
# Epoch milliseconds of last update.
|
|
42
|
-
sig { returns(T.nilable(Integer)) }
|
|
43
|
-
attr_reader :updated
|
|
44
|
-
|
|
45
|
-
sig { params(updated: Integer).void }
|
|
46
|
-
attr_writer :updated
|
|
47
|
-
|
|
48
|
-
# User ID of the last updater.
|
|
49
|
-
sig { returns(T.nilable(String)) }
|
|
50
|
-
attr_reader :updater
|
|
51
|
-
|
|
52
|
-
sig { params(updater: String).void }
|
|
53
|
-
attr_writer :updater
|
|
54
|
-
|
|
55
|
-
# Envelope response for GET /notifications/{id}. The notification object mirrors
|
|
56
|
-
# the POST/PUT input shape. Nullable fields return null when unset.
|
|
57
|
-
sig do
|
|
58
|
-
params(
|
|
59
|
-
created: Integer,
|
|
60
|
-
creator: String,
|
|
61
|
-
notification:
|
|
62
|
-
Courier::NotificationTemplateGetResponse::Notification::OrHash,
|
|
63
|
-
state: Courier::NotificationTemplateGetResponse::State::OrSymbol,
|
|
64
|
-
updated: Integer,
|
|
65
|
-
updater: String
|
|
66
|
-
).returns(T.attached_class)
|
|
67
|
-
end
|
|
68
|
-
def self.new(
|
|
69
|
-
# Epoch milliseconds when the template was created.
|
|
70
|
-
created:,
|
|
71
|
-
# User ID of the creator.
|
|
72
|
-
creator:,
|
|
73
|
-
# Full document shape used in POST and PUT request bodies, and returned inside the
|
|
74
|
-
# GET response envelope.
|
|
75
|
-
notification:,
|
|
76
|
-
# The template state. Always uppercase.
|
|
77
|
-
state:,
|
|
78
|
-
# Epoch milliseconds of last update.
|
|
79
|
-
updated: nil,
|
|
80
|
-
# User ID of the last updater.
|
|
81
|
-
updater: nil
|
|
82
|
-
)
|
|
83
|
-
end
|
|
84
|
-
|
|
85
|
-
sig do
|
|
86
|
-
override.returns(
|
|
87
|
-
{
|
|
88
|
-
created: Integer,
|
|
89
|
-
creator: String,
|
|
90
|
-
notification:
|
|
91
|
-
Courier::NotificationTemplateGetResponse::Notification,
|
|
92
|
-
state:
|
|
93
|
-
Courier::NotificationTemplateGetResponse::State::TaggedSymbol,
|
|
94
|
-
updated: Integer,
|
|
95
|
-
updater: String
|
|
96
|
-
}
|
|
97
|
-
)
|
|
98
|
-
end
|
|
99
|
-
def to_hash
|
|
100
|
-
end
|
|
101
|
-
|
|
102
|
-
class Notification < Courier::Models::NotificationTemplatePayload
|
|
103
|
-
OrHash =
|
|
104
|
-
T.type_alias do
|
|
105
|
-
T.any(
|
|
106
|
-
Courier::NotificationTemplateGetResponse::Notification,
|
|
107
|
-
Courier::Internal::AnyHash
|
|
108
|
-
)
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
# The template ID.
|
|
112
|
-
sig { returns(String) }
|
|
113
|
-
attr_accessor :id
|
|
114
|
-
|
|
115
|
-
# Full document shape used in POST and PUT request bodies, and returned inside the
|
|
116
|
-
# GET response envelope.
|
|
117
|
-
sig { params(id: String).returns(T.attached_class) }
|
|
118
|
-
def self.new(
|
|
119
|
-
# The template ID.
|
|
120
|
-
id:
|
|
121
|
-
)
|
|
122
|
-
end
|
|
123
|
-
|
|
124
|
-
sig { override.returns({ id: String }) }
|
|
125
|
-
def to_hash
|
|
126
|
-
end
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# The template state. Always uppercase.
|
|
130
|
-
module State
|
|
131
|
-
extend Courier::Internal::Type::Enum
|
|
132
|
-
|
|
133
|
-
TaggedSymbol =
|
|
134
|
-
T.type_alias do
|
|
135
|
-
T.all(Symbol, Courier::NotificationTemplateGetResponse::State)
|
|
136
|
-
end
|
|
137
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
138
|
-
|
|
139
|
-
DRAFT =
|
|
140
|
-
T.let(
|
|
141
|
-
:DRAFT,
|
|
142
|
-
Courier::NotificationTemplateGetResponse::State::TaggedSymbol
|
|
143
|
-
)
|
|
144
|
-
PUBLISHED =
|
|
145
|
-
T.let(
|
|
146
|
-
:PUBLISHED,
|
|
147
|
-
Courier::NotificationTemplateGetResponse::State::TaggedSymbol
|
|
148
|
-
)
|
|
149
|
-
|
|
150
|
-
sig do
|
|
151
|
-
override.returns(
|
|
152
|
-
T::Array[
|
|
153
|
-
Courier::NotificationTemplateGetResponse::State::TaggedSymbol
|
|
154
|
-
]
|
|
155
|
-
)
|
|
156
|
-
end
|
|
157
|
-
def self.values
|
|
158
|
-
end
|
|
159
|
-
end
|
|
160
|
-
end
|
|
161
|
-
end
|
|
162
|
-
end
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
module Courier
|
|
2
|
-
module Models
|
|
3
|
-
type notification_template_get_response =
|
|
4
|
-
{
|
|
5
|
-
created: Integer,
|
|
6
|
-
creator: String,
|
|
7
|
-
notification: Courier::NotificationTemplateGetResponse::Notification,
|
|
8
|
-
state: Courier::Models::NotificationTemplateGetResponse::state,
|
|
9
|
-
updated: Integer,
|
|
10
|
-
updater: String
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
class NotificationTemplateGetResponse < Courier::Internal::Type::BaseModel
|
|
14
|
-
attr_accessor created: Integer
|
|
15
|
-
|
|
16
|
-
attr_accessor creator: String
|
|
17
|
-
|
|
18
|
-
attr_accessor notification: Courier::NotificationTemplateGetResponse::Notification
|
|
19
|
-
|
|
20
|
-
attr_accessor state: Courier::Models::NotificationTemplateGetResponse::state
|
|
21
|
-
|
|
22
|
-
attr_reader updated: Integer?
|
|
23
|
-
|
|
24
|
-
def updated=: (Integer) -> Integer
|
|
25
|
-
|
|
26
|
-
attr_reader updater: String?
|
|
27
|
-
|
|
28
|
-
def updater=: (String) -> String
|
|
29
|
-
|
|
30
|
-
def initialize: (
|
|
31
|
-
created: Integer,
|
|
32
|
-
creator: String,
|
|
33
|
-
notification: Courier::NotificationTemplateGetResponse::Notification,
|
|
34
|
-
state: Courier::Models::NotificationTemplateGetResponse::state,
|
|
35
|
-
?updated: Integer,
|
|
36
|
-
?updater: String
|
|
37
|
-
) -> void
|
|
38
|
-
|
|
39
|
-
def to_hash: -> {
|
|
40
|
-
created: Integer,
|
|
41
|
-
creator: String,
|
|
42
|
-
notification: Courier::NotificationTemplateGetResponse::Notification,
|
|
43
|
-
state: Courier::Models::NotificationTemplateGetResponse::state,
|
|
44
|
-
updated: Integer,
|
|
45
|
-
updater: String
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
type notification = { id: String }
|
|
49
|
-
|
|
50
|
-
class Notification < Courier::Models::NotificationTemplatePayload
|
|
51
|
-
def id: -> String
|
|
52
|
-
|
|
53
|
-
def id=: (String _) -> String
|
|
54
|
-
|
|
55
|
-
def initialize: (id: String) -> void
|
|
56
|
-
|
|
57
|
-
def to_hash: -> { id: String }
|
|
58
|
-
end
|
|
59
|
-
|
|
60
|
-
type state = :DRAFT | :PUBLISHED
|
|
61
|
-
|
|
62
|
-
module State
|
|
63
|
-
extend Courier::Internal::Type::Enum
|
|
64
|
-
|
|
65
|
-
DRAFT: :DRAFT
|
|
66
|
-
PUBLISHED: :PUBLISHED
|
|
67
|
-
|
|
68
|
-
def self?.values: -> ::Array[Courier::Models::NotificationTemplateGetResponse::state]
|
|
69
|
-
end
|
|
70
|
-
end
|
|
71
|
-
end
|
|
72
|
-
end
|