trycourier 4.17.0 → 4.17.1
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 +11 -0
- data/lib/courier/client.rb +3 -3
- data/lib/courier/models/publish_preferences_response.rb +1 -1
- data/lib/courier/models/{preference_section_archive_params.rb → workspace_preference_archive_params.rb} +2 -2
- data/lib/courier/models/{preference_section_create_params.rb → workspace_preference_create_params.rb} +2 -2
- data/lib/courier/models/{preference_section_create_request.rb → workspace_preference_create_request.rb} +8 -8
- data/lib/courier/models/{preference_section_get_response.rb → workspace_preference_get_response.rb} +15 -15
- data/lib/courier/models/{preference_section_list_params.rb → workspace_preference_list_params.rb} +2 -2
- data/lib/courier/models/workspace_preference_list_response.rb +18 -0
- data/lib/courier/models/{preference_section_publish_params.rb → workspace_preference_publish_params.rb} +2 -2
- data/lib/courier/models/{preference_section_replace_params.rb → workspace_preference_replace_params.rb} +2 -2
- data/lib/courier/models/{preference_section_replace_request.rb → workspace_preference_replace_request.rb} +8 -8
- data/lib/courier/models/{preference_section_retrieve_params.rb → workspace_preference_retrieve_params.rb} +2 -2
- data/lib/courier/models/{preference_topic_create_request.rb → workspace_preference_topic_create_request.rb} +9 -9
- data/lib/courier/models/{preference_topic_get_response.rb → workspace_preference_topic_get_response.rb} +8 -8
- data/lib/courier/models/workspace_preference_topic_list_response.rb +17 -0
- data/lib/courier/models/{preference_topic_replace_request.rb → workspace_preference_topic_replace_request.rb} +8 -8
- data/lib/courier/models/{preference_sections → workspace_preferences}/topic_archive_params.rb +2 -2
- data/lib/courier/models/{preference_sections → workspace_preferences}/topic_create_params.rb +3 -3
- data/lib/courier/models/{preference_sections → workspace_preferences}/topic_list_params.rb +2 -2
- data/lib/courier/models/{preference_sections → workspace_preferences}/topic_replace_params.rb +3 -3
- data/lib/courier/models/{preference_sections → workspace_preferences}/topic_retrieve_params.rb +2 -2
- data/lib/courier/models.rb +30 -30
- data/lib/courier/resources/notifications/checks.rb +3 -3
- data/lib/courier/resources/{preference_sections → workspace_preferences}/topics.rb +40 -37
- data/lib/courier/resources/{preference_sections.rb → workspace_preferences.rb} +40 -40
- data/lib/courier/version.rb +1 -1
- data/lib/courier.rb +21 -21
- data/rbi/courier/client.rbi +2 -2
- data/rbi/courier/models/{preference_section_retrieve_params.rbi → workspace_preference_archive_params.rbi} +2 -2
- data/rbi/courier/models/{preference_section_create_params.rbi → workspace_preference_create_params.rbi} +2 -2
- data/rbi/courier/models/{preference_section_create_request.rbi → workspace_preference_create_request.rbi} +9 -9
- data/rbi/courier/models/{preference_section_get_response.rbi → workspace_preference_get_response.rbi} +17 -16
- data/rbi/courier/models/{preference_section_list_params.rbi → workspace_preference_list_params.rbi} +2 -2
- data/rbi/courier/models/{preference_topic_list_response.rbi → workspace_preference_list_response.rbi} +6 -6
- data/rbi/courier/models/{preference_section_publish_params.rbi → workspace_preference_publish_params.rbi} +2 -2
- data/rbi/courier/models/{preference_section_replace_params.rbi → workspace_preference_replace_params.rbi} +2 -2
- data/rbi/courier/models/{preference_section_replace_request.rbi → workspace_preference_replace_request.rbi} +9 -9
- data/rbi/courier/models/{preference_section_archive_params.rbi → workspace_preference_retrieve_params.rbi} +2 -2
- data/rbi/courier/models/{preference_topic_create_request.rbi → workspace_preference_topic_create_request.rbi} +22 -17
- data/rbi/courier/models/{preference_topic_get_response.rbi → workspace_preference_topic_get_response.rbi} +23 -17
- data/rbi/courier/models/workspace_preference_topic_list_response.rbi +36 -0
- data/rbi/courier/models/{preference_topic_replace_request.rbi → workspace_preference_topic_replace_request.rbi} +22 -17
- data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_archive_params.rbi +2 -2
- data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_create_params.rbi +3 -3
- data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_list_params.rbi +2 -2
- data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_replace_params.rbi +3 -3
- data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_retrieve_params.rbi +2 -2
- data/rbi/courier/models.rbi +43 -36
- data/rbi/courier/resources/notifications/checks.rbi +3 -3
- data/rbi/courier/resources/{preference_sections → workspace_preferences}/topics.rbi +25 -22
- data/rbi/courier/resources/{preference_sections.rbi → workspace_preferences.rbi} +27 -27
- data/sig/courier/client.rbs +1 -1
- data/sig/courier/models/{preference_section_retrieve_params.rbs → workspace_preference_archive_params.rbs} +2 -2
- data/sig/courier/models/{preference_section_create_params.rbs → workspace_preference_create_params.rbs} +2 -2
- data/sig/courier/models/{preference_section_replace_request.rbs → workspace_preference_create_request.rbs} +2 -2
- data/sig/courier/models/{preference_section_get_response.rbs → workspace_preference_get_response.rbs} +6 -6
- data/sig/courier/models/{preference_section_list_params.rbs → workspace_preference_list_params.rbs} +2 -2
- data/sig/courier/models/workspace_preference_list_response.rbs +18 -0
- data/sig/courier/models/{preference_section_publish_params.rbs → workspace_preference_publish_params.rbs} +2 -2
- data/sig/courier/models/{preference_section_replace_params.rbs → workspace_preference_replace_params.rbs} +2 -2
- data/sig/courier/models/{preference_section_create_request.rbs → workspace_preference_replace_request.rbs} +2 -2
- data/sig/courier/models/{preference_section_archive_params.rbs → workspace_preference_retrieve_params.rbs} +2 -2
- data/sig/courier/models/{preference_topic_create_request.rbs → workspace_preference_topic_create_request.rbs} +12 -12
- data/sig/courier/models/{preference_topic_get_response.rbs → workspace_preference_topic_get_response.rbs} +12 -12
- data/sig/courier/models/workspace_preference_topic_list_response.rbs +18 -0
- data/sig/courier/models/{preference_topic_replace_request.rbs → workspace_preference_topic_replace_request.rbs} +12 -12
- data/sig/courier/models/{preference_sections → workspace_preferences}/topic_archive_params.rbs +1 -1
- data/sig/courier/models/{preference_sections → workspace_preferences}/topic_create_params.rbs +2 -2
- data/sig/courier/models/{preference_sections → workspace_preferences}/topic_list_params.rbs +1 -1
- data/sig/courier/models/{preference_sections → workspace_preferences}/topic_replace_params.rbs +2 -2
- data/sig/courier/models/{preference_sections → workspace_preferences}/topic_retrieve_params.rbs +1 -1
- data/sig/courier/models.rbs +30 -30
- data/sig/courier/resources/{preference_sections → workspace_preferences}/topics.rbs +9 -9
- data/sig/courier/resources/{preference_sections.rbs → workspace_preferences.rbs} +6 -6
- metadata +65 -65
- data/lib/courier/models/preference_section_list_response.rb +0 -18
- data/lib/courier/models/preference_topic_list_response.rb +0 -17
- data/rbi/courier/models/preference_section_list_response.rbi +0 -35
- data/sig/courier/models/preference_section_list_response.rbs +0 -18
- data/sig/courier/models/preference_topic_list_response.rbs +0 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 767d16490b100cdf1a74b068086a2d8dce286dc441ceaf2d6a1014f7a87e8117
|
|
4
|
+
data.tar.gz: c5d5013207f3876f9a2a98c87ece15788851f3720dc48a4e5814a3a7ba0273d7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 170f814c04185d95c823f0309563ba0223b661d4079dc8cddd34785234fe39b2c8c7a1dfa54171f7e752897f82be866d26a6bd97f54a4a06babb23a155aa4b9b
|
|
7
|
+
data.tar.gz: f18775095318e5eafdd9cc9b7cfe8b8109d06f7ba86c61e397436db89173030257808fc07a75b1ffeb7f6f63777fc4c8d6d6e7dded71c29d5c2e601a7a09f7ff
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 4.17.1 (2026-06-25)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v4.17.0...v4.17.1](https://github.com/trycourier/courier-ruby/compare/v4.17.0...v4.17.1)
|
|
6
|
+
|
|
7
|
+
### Documentation
|
|
8
|
+
|
|
9
|
+
* **openapi:** add full response examples to every endpoint ([be9724a](https://github.com/trycourier/courier-ruby/commit/be9724a3a5d7317bd31d99160414959b58d1e5bb))
|
|
10
|
+
* **openapi:** reword Cancel Submission description ([68565aa](https://github.com/trycourier/courier-ruby/commit/68565aa1f8de141d9780a390da4b48aeb178624e))
|
|
11
|
+
* **openapi:** reword Get Submission Checks description ([94541e4](https://github.com/trycourier/courier-ruby/commit/94541e4aaebbf1ac567e1047d2ce84e5ad97741b))
|
|
12
|
+
* **openapi:** reword Replace Submission Checks description ([7aa63c1](https://github.com/trycourier/courier-ruby/commit/7aa63c14c83b9585ec963d426f47b2720b5b04cc))
|
|
13
|
+
|
|
3
14
|
## 4.17.0 (2026-06-24)
|
|
4
15
|
|
|
5
16
|
Full Changelog: [v4.16.0...v4.17.0](https://github.com/trycourier/courier-ruby/compare/v4.16.0...v4.17.0)
|
data/lib/courier/client.rb
CHANGED
|
@@ -66,8 +66,8 @@ module Courier
|
|
|
66
66
|
# @return [Courier::Resources::RoutingStrategies]
|
|
67
67
|
attr_reader :routing_strategies
|
|
68
68
|
|
|
69
|
-
# @return [Courier::Resources::
|
|
70
|
-
attr_reader :
|
|
69
|
+
# @return [Courier::Resources::WorkspacePreferences]
|
|
70
|
+
attr_reader :workspace_preferences
|
|
71
71
|
|
|
72
72
|
# @return [Courier::Resources::Profiles]
|
|
73
73
|
attr_reader :profiles
|
|
@@ -158,7 +158,7 @@ module Courier
|
|
|
158
158
|
@requests = Courier::Resources::Requests.new(client: self)
|
|
159
159
|
@notifications = Courier::Resources::Notifications.new(client: self)
|
|
160
160
|
@routing_strategies = Courier::Resources::RoutingStrategies.new(client: self)
|
|
161
|
-
@
|
|
161
|
+
@workspace_preferences = Courier::Resources::WorkspacePreferences.new(client: self)
|
|
162
162
|
@profiles = Courier::Resources::Profiles.new(client: self)
|
|
163
163
|
@tenants = Courier::Resources::Tenants.new(client: self)
|
|
164
164
|
@translations = Courier::Resources::Translations.new(client: self)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#publish
|
|
6
6
|
class PublishPreferencesResponse < Courier::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute page_id
|
|
8
8
|
# Id of the published page snapshot.
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#archive
|
|
6
|
+
class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#create
|
|
6
|
+
class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute name
|
|
7
|
-
# Human-readable name for the
|
|
7
|
+
# Human-readable name for the workspace preference.
|
|
8
8
|
#
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :name, String
|
|
11
11
|
|
|
12
12
|
# @!attribute has_custom_routing
|
|
13
|
-
# Whether the
|
|
13
|
+
# Whether the workspace preference defines custom routing for its topics.
|
|
14
14
|
#
|
|
15
15
|
# @return [Boolean, nil]
|
|
16
16
|
optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
|
|
17
17
|
|
|
18
18
|
# @!attribute routing_options
|
|
19
|
-
# Default channels for the
|
|
19
|
+
# Default channels for the workspace preference. Defaults to empty if omitted.
|
|
20
20
|
#
|
|
21
21
|
# @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
|
|
22
22
|
optional :routing_options,
|
|
@@ -24,13 +24,13 @@ module Courier
|
|
|
24
24
|
nil?: true
|
|
25
25
|
|
|
26
26
|
# @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
|
|
27
|
-
# Request body for creating a preference
|
|
27
|
+
# Request body for creating a workspace preference.
|
|
28
28
|
#
|
|
29
|
-
# @param name [String] Human-readable name for the
|
|
29
|
+
# @param name [String] Human-readable name for the workspace preference.
|
|
30
30
|
#
|
|
31
|
-
# @param has_custom_routing [Boolean, nil] Whether the
|
|
31
|
+
# @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
|
|
32
32
|
#
|
|
33
|
-
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the
|
|
33
|
+
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Defaults to empty if omitted.
|
|
34
34
|
end
|
|
35
35
|
end
|
|
36
36
|
end
|
data/lib/courier/models/{preference_section_get_response.rb → workspace_preference_get_response.rb}
RENAMED
|
@@ -2,22 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#create
|
|
6
|
+
class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
|
-
# The preference
|
|
8
|
+
# The workspace preference id.
|
|
9
9
|
#
|
|
10
10
|
# @return [String]
|
|
11
11
|
required :id, String
|
|
12
12
|
|
|
13
13
|
# @!attribute created
|
|
14
|
-
# ISO-8601 timestamp of when the
|
|
14
|
+
# ISO-8601 timestamp of when the workspace preference was created.
|
|
15
15
|
#
|
|
16
16
|
# @return [String]
|
|
17
17
|
required :created, String
|
|
18
18
|
|
|
19
19
|
# @!attribute has_custom_routing
|
|
20
|
-
# Whether the
|
|
20
|
+
# Whether the workspace preference defines custom routing for its topics.
|
|
21
21
|
#
|
|
22
22
|
# @return [Boolean]
|
|
23
23
|
required :has_custom_routing, Courier::Internal::Type::Boolean
|
|
@@ -29,16 +29,16 @@ module Courier
|
|
|
29
29
|
required :name, String
|
|
30
30
|
|
|
31
31
|
# @!attribute routing_options
|
|
32
|
-
# Default channels for the
|
|
32
|
+
# Default channels for the workspace preference. May be empty.
|
|
33
33
|
#
|
|
34
34
|
# @return [Array<Symbol, Courier::Models::ChannelClassification>]
|
|
35
35
|
required :routing_options, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
|
|
36
36
|
|
|
37
37
|
# @!attribute topics
|
|
38
|
-
# The topics contained in this
|
|
38
|
+
# The topics contained in this workspace preference.
|
|
39
39
|
#
|
|
40
|
-
# @return [Array<Courier::Models::
|
|
41
|
-
required :topics, -> { Courier::Internal::Type::ArrayOf[Courier::
|
|
40
|
+
# @return [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>]
|
|
41
|
+
required :topics, -> { Courier::Internal::Type::ArrayOf[Courier::WorkspacePreferenceTopicGetResponse] }
|
|
42
42
|
|
|
43
43
|
# @!attribute creator
|
|
44
44
|
# Id of the creator.
|
|
@@ -59,19 +59,19 @@ module Courier
|
|
|
59
59
|
optional :updater, String, nil?: true
|
|
60
60
|
|
|
61
61
|
# @!method initialize(id:, created:, has_custom_routing:, name:, routing_options:, topics:, creator: nil, updated: nil, updater: nil)
|
|
62
|
-
# A preference
|
|
62
|
+
# A workspace preference in your workspace, including its topics.
|
|
63
63
|
#
|
|
64
|
-
# @param id [String] The preference
|
|
64
|
+
# @param id [String] The workspace preference id.
|
|
65
65
|
#
|
|
66
|
-
# @param created [String] ISO-8601 timestamp of when the
|
|
66
|
+
# @param created [String] ISO-8601 timestamp of when the workspace preference was created.
|
|
67
67
|
#
|
|
68
|
-
# @param has_custom_routing [Boolean] Whether the
|
|
68
|
+
# @param has_custom_routing [Boolean] Whether the workspace preference defines custom routing for its topics.
|
|
69
69
|
#
|
|
70
70
|
# @param name [String] Human-readable name.
|
|
71
71
|
#
|
|
72
|
-
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels for the
|
|
72
|
+
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels for the workspace preference. May be empty.
|
|
73
73
|
#
|
|
74
|
-
# @param topics [Array<Courier::Models::
|
|
74
|
+
# @param topics [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>] The topics contained in this workspace preference.
|
|
75
75
|
#
|
|
76
76
|
# @param creator [String, nil] Id of the creator.
|
|
77
77
|
#
|
data/lib/courier/models/{preference_section_list_params.rb → workspace_preference_list_params.rb}
RENAMED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#list
|
|
6
|
+
class WorkspacePreferenceListParams < Courier::Internal::Type::BaseModel
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Courier
|
|
4
|
+
module Models
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#list
|
|
6
|
+
class WorkspacePreferenceListResponse < Courier::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute results
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<Courier::Models::WorkspacePreferenceGetResponse>]
|
|
10
|
+
required :results, -> { Courier::Internal::Type::ArrayOf[Courier::WorkspacePreferenceGetResponse] }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(results:)
|
|
13
|
+
# The workspace's preferences, each with its topics.
|
|
14
|
+
#
|
|
15
|
+
# @param results [Array<Courier::Models::WorkspacePreferenceGetResponse>]
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#publish
|
|
6
|
+
class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#replace
|
|
6
|
+
class WorkspacePreferenceReplaceParams < Courier::Models::WorkspacePreferenceReplaceRequest
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class WorkspacePreferenceReplaceRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute name
|
|
7
|
-
# Human-readable name for the
|
|
7
|
+
# Human-readable name for the workspace preference.
|
|
8
8
|
#
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :name, String
|
|
11
11
|
|
|
12
12
|
# @!attribute has_custom_routing
|
|
13
|
-
# Whether the
|
|
13
|
+
# Whether the workspace preference defines custom routing for its topics.
|
|
14
14
|
#
|
|
15
15
|
# @return [Boolean, nil]
|
|
16
16
|
optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
|
|
17
17
|
|
|
18
18
|
# @!attribute routing_options
|
|
19
|
-
# Default channels for the
|
|
19
|
+
# Default channels for the workspace preference. Omit to clear.
|
|
20
20
|
#
|
|
21
21
|
# @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
|
|
22
22
|
optional :routing_options,
|
|
@@ -24,14 +24,14 @@ module Courier
|
|
|
24
24
|
nil?: true
|
|
25
25
|
|
|
26
26
|
# @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
|
|
27
|
-
# Request body for replacing a preference
|
|
27
|
+
# Request body for replacing a workspace preference. Full document replacement;
|
|
28
28
|
# missing optional fields are cleared.
|
|
29
29
|
#
|
|
30
|
-
# @param name [String] Human-readable name for the
|
|
30
|
+
# @param name [String] Human-readable name for the workspace preference.
|
|
31
31
|
#
|
|
32
|
-
# @param has_custom_routing [Boolean, nil] Whether the
|
|
32
|
+
# @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
|
|
33
33
|
#
|
|
34
|
-
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the
|
|
34
|
+
# @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Omit to clear.
|
|
35
35
|
end
|
|
36
36
|
end
|
|
37
37
|
end
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
# @see Courier::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see Courier::Resources::WorkspacePreferences#retrieve
|
|
6
|
+
class WorkspacePreferenceRetrieveParams < Courier::Internal::Type::BaseModel
|
|
7
7
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Courier::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class WorkspacePreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute default_status
|
|
7
7
|
# The default subscription status applied when a recipient has not set their own.
|
|
8
8
|
#
|
|
9
|
-
# @return [Symbol, Courier::Models::
|
|
10
|
-
required :default_status, enum: -> { Courier::
|
|
9
|
+
# @return [Symbol, Courier::Models::WorkspacePreferenceTopicCreateRequest::DefaultStatus]
|
|
10
|
+
required :default_status, enum: -> { Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus }
|
|
11
11
|
|
|
12
12
|
# @!attribute name
|
|
13
13
|
# Human-readable name for the preference topic.
|
|
@@ -19,10 +19,10 @@ module Courier
|
|
|
19
19
|
# Preference controls a recipient may customize for this topic. Defaults to empty
|
|
20
20
|
# if omitted.
|
|
21
21
|
#
|
|
22
|
-
# @return [Array<Symbol, Courier::Models::
|
|
22
|
+
# @return [Array<Symbol, Courier::Models::WorkspacePreferenceTopicCreateRequest::AllowedPreference>, nil]
|
|
23
23
|
optional :allowed_preferences,
|
|
24
24
|
-> {
|
|
25
|
-
Courier::Internal::Type::ArrayOf[enum: Courier::
|
|
25
|
+
Courier::Internal::Type::ArrayOf[enum: Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference]
|
|
26
26
|
},
|
|
27
27
|
nil?: true
|
|
28
28
|
|
|
@@ -48,15 +48,15 @@ module Courier
|
|
|
48
48
|
|
|
49
49
|
# @!method initialize(default_status:, name:, allowed_preferences: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
|
|
50
50
|
# Some parameter documentations has been truncated, see
|
|
51
|
-
# {Courier::Models::
|
|
51
|
+
# {Courier::Models::WorkspacePreferenceTopicCreateRequest} for more details.
|
|
52
52
|
#
|
|
53
53
|
# Request body for creating a preference topic.
|
|
54
54
|
#
|
|
55
|
-
# @param default_status [Symbol, Courier::Models::
|
|
55
|
+
# @param default_status [Symbol, Courier::Models::WorkspacePreferenceTopicCreateRequest::DefaultStatus] The default subscription status applied when a recipient has not set their own.
|
|
56
56
|
#
|
|
57
57
|
# @param name [String] Human-readable name for the preference topic.
|
|
58
58
|
#
|
|
59
|
-
# @param allowed_preferences [Array<Symbol, Courier::Models::
|
|
59
|
+
# @param allowed_preferences [Array<Symbol, Courier::Models::WorkspacePreferenceTopicCreateRequest::AllowedPreference>, nil] Preference controls a recipient may customize for this topic. Defaults to empty
|
|
60
60
|
#
|
|
61
61
|
# @param include_unsubscribe_header [Boolean, nil] Whether to include a list-unsubscribe header on emails for this topic.
|
|
62
62
|
#
|
|
@@ -66,7 +66,7 @@ module Courier
|
|
|
66
66
|
|
|
67
67
|
# The default subscription status applied when a recipient has not set their own.
|
|
68
68
|
#
|
|
69
|
-
# @see Courier::Models::
|
|
69
|
+
# @see Courier::Models::WorkspacePreferenceTopicCreateRequest#default_status
|
|
70
70
|
module DefaultStatus
|
|
71
71
|
extend Courier::Internal::Type::Enum
|
|
72
72
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class WorkspacePreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute id
|
|
7
7
|
# The preference topic id.
|
|
8
8
|
#
|
|
@@ -12,9 +12,9 @@ module Courier
|
|
|
12
12
|
# @!attribute allowed_preferences
|
|
13
13
|
# Preference controls a recipient may customize. May be empty.
|
|
14
14
|
#
|
|
15
|
-
# @return [Array<Symbol, Courier::Models::
|
|
15
|
+
# @return [Array<Symbol, Courier::Models::WorkspacePreferenceTopicGetResponse::AllowedPreference>]
|
|
16
16
|
required :allowed_preferences,
|
|
17
|
-
-> { Courier::Internal::Type::ArrayOf[enum: Courier::
|
|
17
|
+
-> { Courier::Internal::Type::ArrayOf[enum: Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference] }
|
|
18
18
|
|
|
19
19
|
# @!attribute created
|
|
20
20
|
# ISO-8601 timestamp of when the topic was created.
|
|
@@ -25,8 +25,8 @@ module Courier
|
|
|
25
25
|
# @!attribute default_status
|
|
26
26
|
# The default subscription status applied when a recipient has not set their own.
|
|
27
27
|
#
|
|
28
|
-
# @return [Symbol, Courier::Models::
|
|
29
|
-
required :default_status, enum: -> { Courier::
|
|
28
|
+
# @return [Symbol, Courier::Models::WorkspacePreferenceTopicGetResponse::DefaultStatus]
|
|
29
|
+
required :default_status, enum: -> { Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus }
|
|
30
30
|
|
|
31
31
|
# @!attribute include_unsubscribe_header
|
|
32
32
|
# Whether a list-unsubscribe header is included on emails for this topic.
|
|
@@ -75,11 +75,11 @@ module Courier
|
|
|
75
75
|
#
|
|
76
76
|
# @param id [String] The preference topic id.
|
|
77
77
|
#
|
|
78
|
-
# @param allowed_preferences [Array<Symbol, Courier::Models::
|
|
78
|
+
# @param allowed_preferences [Array<Symbol, Courier::Models::WorkspacePreferenceTopicGetResponse::AllowedPreference>] Preference controls a recipient may customize. May be empty.
|
|
79
79
|
#
|
|
80
80
|
# @param created [String] ISO-8601 timestamp of when the topic was created.
|
|
81
81
|
#
|
|
82
|
-
# @param default_status [Symbol, Courier::Models::
|
|
82
|
+
# @param default_status [Symbol, Courier::Models::WorkspacePreferenceTopicGetResponse::DefaultStatus] The default subscription status applied when a recipient has not set their own.
|
|
83
83
|
#
|
|
84
84
|
# @param include_unsubscribe_header [Boolean] Whether a list-unsubscribe header is included on emails for this topic.
|
|
85
85
|
#
|
|
@@ -108,7 +108,7 @@ module Courier
|
|
|
108
108
|
|
|
109
109
|
# The default subscription status applied when a recipient has not set their own.
|
|
110
110
|
#
|
|
111
|
-
# @see Courier::Models::
|
|
111
|
+
# @see Courier::Models::WorkspacePreferenceTopicGetResponse#default_status
|
|
112
112
|
module DefaultStatus
|
|
113
113
|
extend Courier::Internal::Type::Enum
|
|
114
114
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Courier
|
|
4
|
+
module Models
|
|
5
|
+
class WorkspacePreferenceTopicListResponse < Courier::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute results
|
|
7
|
+
#
|
|
8
|
+
# @return [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>]
|
|
9
|
+
required :results, -> { Courier::Internal::Type::ArrayOf[Courier::WorkspacePreferenceTopicGetResponse] }
|
|
10
|
+
|
|
11
|
+
# @!method initialize(results:)
|
|
12
|
+
# Topics contained in a workspace preference.
|
|
13
|
+
#
|
|
14
|
+
# @param results [Array<Courier::Models::WorkspacePreferenceTopicGetResponse>]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class WorkspacePreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute default_status
|
|
7
7
|
# The default subscription status applied when a recipient has not set their own.
|
|
8
8
|
#
|
|
9
|
-
# @return [Symbol, Courier::Models::
|
|
10
|
-
required :default_status, enum: -> { Courier::
|
|
9
|
+
# @return [Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::DefaultStatus]
|
|
10
|
+
required :default_status, enum: -> { Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus }
|
|
11
11
|
|
|
12
12
|
# @!attribute name
|
|
13
13
|
# Human-readable name for the preference topic.
|
|
@@ -18,10 +18,10 @@ module Courier
|
|
|
18
18
|
# @!attribute allowed_preferences
|
|
19
19
|
# Preference controls a recipient may customize. Omit to clear.
|
|
20
20
|
#
|
|
21
|
-
# @return [Array<Symbol, Courier::Models::
|
|
21
|
+
# @return [Array<Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::AllowedPreference>, nil]
|
|
22
22
|
optional :allowed_preferences,
|
|
23
23
|
-> {
|
|
24
|
-
Courier::Internal::Type::ArrayOf[enum: Courier::
|
|
24
|
+
Courier::Internal::Type::ArrayOf[enum: Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference]
|
|
25
25
|
},
|
|
26
26
|
nil?: true
|
|
27
27
|
|
|
@@ -49,11 +49,11 @@ module Courier
|
|
|
49
49
|
# Request body for replacing a preference topic. Full document replacement;
|
|
50
50
|
# missing optional fields are cleared.
|
|
51
51
|
#
|
|
52
|
-
# @param default_status [Symbol, Courier::Models::
|
|
52
|
+
# @param default_status [Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::DefaultStatus] The default subscription status applied when a recipient has not set their own.
|
|
53
53
|
#
|
|
54
54
|
# @param name [String] Human-readable name for the preference topic.
|
|
55
55
|
#
|
|
56
|
-
# @param allowed_preferences [Array<Symbol, Courier::Models::
|
|
56
|
+
# @param allowed_preferences [Array<Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::AllowedPreference>, nil] Preference controls a recipient may customize. Omit to clear.
|
|
57
57
|
#
|
|
58
58
|
# @param include_unsubscribe_header [Boolean, nil] Whether to include a list-unsubscribe header on emails for this topic.
|
|
59
59
|
#
|
|
@@ -63,7 +63,7 @@ module Courier
|
|
|
63
63
|
|
|
64
64
|
# The default subscription status applied when a recipient has not set their own.
|
|
65
65
|
#
|
|
66
|
-
# @see Courier::Models::
|
|
66
|
+
# @see Courier::Models::WorkspacePreferenceTopicReplaceRequest#default_status
|
|
67
67
|
module DefaultStatus
|
|
68
68
|
extend Courier::Internal::Type::Enum
|
|
69
69
|
|
data/lib/courier/models/{preference_sections → workspace_preferences}/topic_archive_params.rb
RENAMED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Courier::Resources::
|
|
5
|
+
module WorkspacePreferences
|
|
6
|
+
# @see Courier::Resources::WorkspacePreferences::Topics#archive
|
|
7
7
|
class TopicArchiveParams < Courier::Internal::Type::BaseModel
|
|
8
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Courier::Internal::Type::RequestParameters
|
data/lib/courier/models/{preference_sections → workspace_preferences}/topic_create_params.rb
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Courier::Resources::
|
|
7
|
-
class TopicCreateParams < Courier::Models::
|
|
5
|
+
module WorkspacePreferences
|
|
6
|
+
# @see Courier::Resources::WorkspacePreferences::Topics#create
|
|
7
|
+
class TopicCreateParams < Courier::Models::WorkspacePreferenceTopicCreateRequest
|
|
8
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Courier::Internal::Type::RequestParameters
|
|
10
10
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Courier::Resources::
|
|
5
|
+
module WorkspacePreferences
|
|
6
|
+
# @see Courier::Resources::WorkspacePreferences::Topics#list
|
|
7
7
|
class TopicListParams < Courier::Internal::Type::BaseModel
|
|
8
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Courier::Internal::Type::RequestParameters
|
data/lib/courier/models/{preference_sections → workspace_preferences}/topic_replace_params.rb
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Courier::Resources::
|
|
7
|
-
class TopicReplaceParams < Courier::Models::
|
|
5
|
+
module WorkspacePreferences
|
|
6
|
+
# @see Courier::Resources::WorkspacePreferences::Topics#replace
|
|
7
|
+
class TopicReplaceParams < Courier::Models::WorkspacePreferenceTopicReplaceRequest
|
|
8
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Courier::Internal::Type::RequestParameters
|
|
10
10
|
|
data/lib/courier/models/{preference_sections → workspace_preferences}/topic_retrieve_params.rb
RENAMED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Courier
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Courier::Resources::
|
|
5
|
+
module WorkspacePreferences
|
|
6
|
+
# @see Courier::Resources::WorkspacePreferences::Topics#retrieve
|
|
7
7
|
class TopicRetrieveParams < Courier::Internal::Type::BaseModel
|
|
8
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Courier::Internal::Type::RequestParameters
|
data/lib/courier/models.rb
CHANGED
|
@@ -404,38 +404,8 @@ module Courier
|
|
|
404
404
|
|
|
405
405
|
Preference = Courier::Models::Preference
|
|
406
406
|
|
|
407
|
-
PreferenceSectionArchiveParams = Courier::Models::PreferenceSectionArchiveParams
|
|
408
|
-
|
|
409
|
-
PreferenceSectionCreateParams = Courier::Models::PreferenceSectionCreateParams
|
|
410
|
-
|
|
411
|
-
PreferenceSectionCreateRequest = Courier::Models::PreferenceSectionCreateRequest
|
|
412
|
-
|
|
413
|
-
PreferenceSectionGetResponse = Courier::Models::PreferenceSectionGetResponse
|
|
414
|
-
|
|
415
|
-
PreferenceSectionListParams = Courier::Models::PreferenceSectionListParams
|
|
416
|
-
|
|
417
|
-
PreferenceSectionListResponse = Courier::Models::PreferenceSectionListResponse
|
|
418
|
-
|
|
419
|
-
PreferenceSectionPublishParams = Courier::Models::PreferenceSectionPublishParams
|
|
420
|
-
|
|
421
|
-
PreferenceSectionReplaceParams = Courier::Models::PreferenceSectionReplaceParams
|
|
422
|
-
|
|
423
|
-
PreferenceSectionReplaceRequest = Courier::Models::PreferenceSectionReplaceRequest
|
|
424
|
-
|
|
425
|
-
PreferenceSectionRetrieveParams = Courier::Models::PreferenceSectionRetrieveParams
|
|
426
|
-
|
|
427
|
-
PreferenceSections = Courier::Models::PreferenceSections
|
|
428
|
-
|
|
429
407
|
PreferenceStatus = Courier::Models::PreferenceStatus
|
|
430
408
|
|
|
431
|
-
PreferenceTopicCreateRequest = Courier::Models::PreferenceTopicCreateRequest
|
|
432
|
-
|
|
433
|
-
PreferenceTopicGetResponse = Courier::Models::PreferenceTopicGetResponse
|
|
434
|
-
|
|
435
|
-
PreferenceTopicListResponse = Courier::Models::PreferenceTopicListResponse
|
|
436
|
-
|
|
437
|
-
PreferenceTopicReplaceRequest = Courier::Models::PreferenceTopicReplaceRequest
|
|
438
|
-
|
|
439
409
|
ProfileCreateParams = Courier::Models::ProfileCreateParams
|
|
440
410
|
|
|
441
411
|
ProfileDeleteParams = Courier::Models::ProfileDeleteParams
|
|
@@ -587,4 +557,34 @@ module Courier
|
|
|
587
557
|
WebhookRecipient = Courier::Models::WebhookRecipient
|
|
588
558
|
|
|
589
559
|
WidgetBackground = Courier::Models::WidgetBackground
|
|
560
|
+
|
|
561
|
+
WorkspacePreferenceArchiveParams = Courier::Models::WorkspacePreferenceArchiveParams
|
|
562
|
+
|
|
563
|
+
WorkspacePreferenceCreateParams = Courier::Models::WorkspacePreferenceCreateParams
|
|
564
|
+
|
|
565
|
+
WorkspacePreferenceCreateRequest = Courier::Models::WorkspacePreferenceCreateRequest
|
|
566
|
+
|
|
567
|
+
WorkspacePreferenceGetResponse = Courier::Models::WorkspacePreferenceGetResponse
|
|
568
|
+
|
|
569
|
+
WorkspacePreferenceListParams = Courier::Models::WorkspacePreferenceListParams
|
|
570
|
+
|
|
571
|
+
WorkspacePreferenceListResponse = Courier::Models::WorkspacePreferenceListResponse
|
|
572
|
+
|
|
573
|
+
WorkspacePreferencePublishParams = Courier::Models::WorkspacePreferencePublishParams
|
|
574
|
+
|
|
575
|
+
WorkspacePreferenceReplaceParams = Courier::Models::WorkspacePreferenceReplaceParams
|
|
576
|
+
|
|
577
|
+
WorkspacePreferenceReplaceRequest = Courier::Models::WorkspacePreferenceReplaceRequest
|
|
578
|
+
|
|
579
|
+
WorkspacePreferenceRetrieveParams = Courier::Models::WorkspacePreferenceRetrieveParams
|
|
580
|
+
|
|
581
|
+
WorkspacePreferences = Courier::Models::WorkspacePreferences
|
|
582
|
+
|
|
583
|
+
WorkspacePreferenceTopicCreateRequest = Courier::Models::WorkspacePreferenceTopicCreateRequest
|
|
584
|
+
|
|
585
|
+
WorkspacePreferenceTopicGetResponse = Courier::Models::WorkspacePreferenceTopicGetResponse
|
|
586
|
+
|
|
587
|
+
WorkspacePreferenceTopicListResponse = Courier::Models::WorkspacePreferenceTopicListResponse
|
|
588
|
+
|
|
589
|
+
WorkspacePreferenceTopicReplaceRequest = Courier::Models::WorkspacePreferenceTopicReplaceRequest
|
|
590
590
|
end
|