trycourier 4.10.0 → 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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/lib/courier/internal/util.rb +3 -1
  4. data/lib/courier/models/notification_list_response.rb +8 -8
  5. data/lib/courier/models/notification_template_create_request.rb +3 -3
  6. data/lib/courier/models/notification_template_payload.rb +2 -2
  7. data/lib/courier/models/notification_template_response.rb +71 -0
  8. data/lib/courier/models/notification_template_update_request.rb +3 -3
  9. data/lib/courier/models/provider_update_params.rb +3 -2
  10. data/lib/courier/models/routing_strategy_get_response.rb +1 -1
  11. data/lib/courier/models.rb +2 -6
  12. data/lib/courier/resources/notifications/checks.rb +16 -6
  13. data/lib/courier/resources/notifications.rb +8 -8
  14. data/lib/courier/resources/providers.rb +7 -5
  15. data/lib/courier/resources/routing_strategies.rb +4 -4
  16. data/lib/courier/version.rb +1 -1
  17. data/lib/courier.rb +1 -3
  18. data/rbi/courier/models/notification_list_response.rbi +9 -6
  19. data/rbi/courier/models/notification_template_create_request.rbi +4 -4
  20. data/rbi/courier/models/notification_template_payload.rbi +2 -2
  21. data/rbi/courier/models/notification_template_response.rbi +120 -0
  22. data/rbi/courier/models/notification_template_update_request.rbi +4 -4
  23. data/rbi/courier/models/provider_update_params.rbi +4 -2
  24. data/rbi/courier/models.rbi +2 -9
  25. data/rbi/courier/resources/notifications/checks.rbi +19 -4
  26. data/rbi/courier/resources/notifications.rbi +7 -7
  27. data/rbi/courier/resources/providers.rbi +7 -4
  28. data/rbi/courier/resources/routing_strategies.rbi +2 -2
  29. data/sig/courier/models/notification_list_response.rbs +7 -5
  30. data/sig/courier/models/notification_template_response.rbs +70 -0
  31. data/sig/courier/models.rbs +2 -6
  32. data/sig/courier/resources/notifications.rbs +3 -3
  33. data/sig/courier/resources/routing_strategies.rbs +2 -2
  34. metadata +5 -11
  35. data/lib/courier/models/notification_template_get_response.rb +0 -92
  36. data/lib/courier/models/notification_template_mutation_response.rb +0 -51
  37. data/lib/courier/models/routing_strategy_mutation_response.rb +0 -19
  38. data/rbi/courier/models/notification_template_get_response.rbi +0 -162
  39. data/rbi/courier/models/notification_template_mutation_response.rbi +0 -121
  40. data/rbi/courier/models/routing_strategy_mutation_response.rbi +0 -31
  41. data/sig/courier/models/notification_template_get_response.rbs +0 -72
  42. data/sig/courier/models/notification_template_mutation_response.rbs +0 -46
  43. data/sig/courier/models/routing_strategy_mutation_response.rbs +0 -13
@@ -1,92 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Courier
4
- module Models
5
- # @see Courier::Resources::Notifications#retrieve
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,51 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Courier
4
- module Models
5
- # @see Courier::Resources::Notifications#create
6
- class NotificationTemplateMutationResponse < Courier::Internal::Type::BaseModel
7
- # @!attribute notification
8
- #
9
- # @return [Courier::Models::NotificationTemplateMutationResponse::Notification]
10
- required :notification, -> { Courier::NotificationTemplateMutationResponse::Notification }
11
-
12
- # @!attribute state
13
- # The template state after the operation. Always uppercase.
14
- #
15
- # @return [Symbol, Courier::Models::NotificationTemplateMutationResponse::State]
16
- required :state, enum: -> { Courier::NotificationTemplateMutationResponse::State }
17
-
18
- # @!method initialize(notification:, state:)
19
- # Response returned by POST and PUT operations.
20
- #
21
- # @param notification [Courier::Models::NotificationTemplateMutationResponse::Notification]
22
- #
23
- # @param state [Symbol, Courier::Models::NotificationTemplateMutationResponse::State] The template state after the operation. Always uppercase.
24
-
25
- # @see Courier::Models::NotificationTemplateMutationResponse#notification
26
- class Notification < Courier::Internal::Type::BaseModel
27
- # @!attribute id
28
- # The ID of the created or updated template.
29
- #
30
- # @return [String]
31
- required :id, String
32
-
33
- # @!method initialize(id:)
34
- # @param id [String] The ID of the created or updated template.
35
- end
36
-
37
- # The template state after the operation. Always uppercase.
38
- #
39
- # @see Courier::Models::NotificationTemplateMutationResponse#state
40
- module State
41
- extend Courier::Internal::Type::Enum
42
-
43
- DRAFT = :DRAFT
44
- PUBLISHED = :PUBLISHED
45
-
46
- # @!method self.values
47
- # @return [Array<Symbol>]
48
- end
49
- end
50
- end
51
- end
@@ -1,19 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Courier
4
- module Models
5
- # @see Courier::Resources::RoutingStrategies#create
6
- class RoutingStrategyMutationResponse < Courier::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The routing strategy ID (rs\_ prefix).
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!method initialize(id:)
14
- # Response returned by create and replace operations.
15
- #
16
- # @param id [String] The routing strategy ID (rs\_ prefix).
17
- end
18
- end
19
- 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,121 +0,0 @@
1
- # typed: strong
2
-
3
- module Courier
4
- module Models
5
- class NotificationTemplateMutationResponse < Courier::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Courier::NotificationTemplateMutationResponse,
10
- Courier::Internal::AnyHash
11
- )
12
- end
13
-
14
- sig do
15
- returns(Courier::NotificationTemplateMutationResponse::Notification)
16
- end
17
- attr_reader :notification
18
-
19
- sig do
20
- params(
21
- notification:
22
- Courier::NotificationTemplateMutationResponse::Notification::OrHash
23
- ).void
24
- end
25
- attr_writer :notification
26
-
27
- # The template state after the operation. Always uppercase.
28
- sig do
29
- returns(
30
- Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
31
- )
32
- end
33
- attr_accessor :state
34
-
35
- # Response returned by POST and PUT operations.
36
- sig do
37
- params(
38
- notification:
39
- Courier::NotificationTemplateMutationResponse::Notification::OrHash,
40
- state: Courier::NotificationTemplateMutationResponse::State::OrSymbol
41
- ).returns(T.attached_class)
42
- end
43
- def self.new(
44
- notification:,
45
- # The template state after the operation. Always uppercase.
46
- state:
47
- )
48
- end
49
-
50
- sig do
51
- override.returns(
52
- {
53
- notification:
54
- Courier::NotificationTemplateMutationResponse::Notification,
55
- state:
56
- Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
57
- }
58
- )
59
- end
60
- def to_hash
61
- end
62
-
63
- class Notification < Courier::Internal::Type::BaseModel
64
- OrHash =
65
- T.type_alias do
66
- T.any(
67
- Courier::NotificationTemplateMutationResponse::Notification,
68
- Courier::Internal::AnyHash
69
- )
70
- end
71
-
72
- # The ID of the created or updated template.
73
- sig { returns(String) }
74
- attr_accessor :id
75
-
76
- sig { params(id: String).returns(T.attached_class) }
77
- def self.new(
78
- # The ID of the created or updated template.
79
- id:
80
- )
81
- end
82
-
83
- sig { override.returns({ id: String }) }
84
- def to_hash
85
- end
86
- end
87
-
88
- # The template state after the operation. Always uppercase.
89
- module State
90
- extend Courier::Internal::Type::Enum
91
-
92
- TaggedSymbol =
93
- T.type_alias do
94
- T.all(Symbol, Courier::NotificationTemplateMutationResponse::State)
95
- end
96
- OrSymbol = T.type_alias { T.any(Symbol, String) }
97
-
98
- DRAFT =
99
- T.let(
100
- :DRAFT,
101
- Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
102
- )
103
- PUBLISHED =
104
- T.let(
105
- :PUBLISHED,
106
- Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
107
- )
108
-
109
- sig do
110
- override.returns(
111
- T::Array[
112
- Courier::NotificationTemplateMutationResponse::State::TaggedSymbol
113
- ]
114
- )
115
- end
116
- def self.values
117
- end
118
- end
119
- end
120
- end
121
- end
@@ -1,31 +0,0 @@
1
- # typed: strong
2
-
3
- module Courier
4
- module Models
5
- class RoutingStrategyMutationResponse < Courier::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Courier::RoutingStrategyMutationResponse,
10
- Courier::Internal::AnyHash
11
- )
12
- end
13
-
14
- # The routing strategy ID (rs\_ prefix).
15
- sig { returns(String) }
16
- attr_accessor :id
17
-
18
- # Response returned by create and replace operations.
19
- sig { params(id: String).returns(T.attached_class) }
20
- def self.new(
21
- # The routing strategy ID (rs\_ prefix).
22
- id:
23
- )
24
- end
25
-
26
- sig { override.returns({ id: String }) }
27
- def to_hash
28
- end
29
- end
30
- end
31
- 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
@@ -1,46 +0,0 @@
1
- module Courier
2
- module Models
3
- type notification_template_mutation_response =
4
- {
5
- notification: Courier::NotificationTemplateMutationResponse::Notification,
6
- state: Courier::Models::NotificationTemplateMutationResponse::state
7
- }
8
-
9
- class NotificationTemplateMutationResponse < Courier::Internal::Type::BaseModel
10
- attr_accessor notification: Courier::NotificationTemplateMutationResponse::Notification
11
-
12
- attr_accessor state: Courier::Models::NotificationTemplateMutationResponse::state
13
-
14
- def initialize: (
15
- notification: Courier::NotificationTemplateMutationResponse::Notification,
16
- state: Courier::Models::NotificationTemplateMutationResponse::state
17
- ) -> void
18
-
19
- def to_hash: -> {
20
- notification: Courier::NotificationTemplateMutationResponse::Notification,
21
- state: Courier::Models::NotificationTemplateMutationResponse::state
22
- }
23
-
24
- type notification = { id: String }
25
-
26
- class Notification < Courier::Internal::Type::BaseModel
27
- attr_accessor id: String
28
-
29
- def initialize: (id: String) -> void
30
-
31
- def to_hash: -> { id: String }
32
- end
33
-
34
- type state = :DRAFT | :PUBLISHED
35
-
36
- module State
37
- extend Courier::Internal::Type::Enum
38
-
39
- DRAFT: :DRAFT
40
- PUBLISHED: :PUBLISHED
41
-
42
- def self?.values: -> ::Array[Courier::Models::NotificationTemplateMutationResponse::state]
43
- end
44
- end
45
- end
46
- end
@@ -1,13 +0,0 @@
1
- module Courier
2
- module Models
3
- type routing_strategy_mutation_response = { id: String }
4
-
5
- class RoutingStrategyMutationResponse < Courier::Internal::Type::BaseModel
6
- attr_accessor id: String
7
-
8
- def initialize: (id: String) -> void
9
-
10
- def to_hash: -> { id: String }
11
- end
12
- end
13
- end