trycourier 4.20.0 → 4.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/lib/courier/client.rb +39 -4
- data/lib/courier/models/automations/invoke_invoke_ad_hoc_params.rb +13 -1
- data/lib/courier/models/automations/invoke_invoke_by_template_params.rb +13 -1
- data/lib/courier/models/brand_create_params.rb +13 -1
- data/lib/courier/models/inbox/message_delete_params.rb +22 -0
- data/lib/courier/models/inbox/message_restore_params.rb +22 -0
- data/lib/courier/models/journey_cancel_params.rb +13 -1
- data/lib/courier/models/journey_create_params.rb +13 -1
- data/lib/courier/models/journey_invoke_params.rb +13 -1
- data/lib/courier/models/journey_publish_params.rb +13 -1
- data/lib/courier/models/journeys/template_create_params.rb +13 -1
- data/lib/courier/models/journeys/template_publish_params.rb +13 -1
- data/lib/courier/models/lists/subscription_add_params.rb +13 -1
- data/lib/courier/models/notification_create_params.rb +13 -1
- data/lib/courier/models/notification_publish_params.rb +13 -1
- data/lib/courier/models/profile_create_params.rb +13 -1
- data/lib/courier/models/profiles/list_subscribe_params.rb +13 -1
- data/lib/courier/models/provider_create_params.rb +15 -1
- data/lib/courier/models/routing_strategy_create_params.rb +13 -1
- data/lib/courier/models/send_message_params.rb +15 -1
- data/lib/courier/models/users/preference_bulk_update_params.rb +15 -1
- data/lib/courier/models/users/preference_update_or_create_topic_params.rb +14 -4
- data/lib/courier/models/users/topic_preference.rb +21 -7
- data/lib/courier/models/workspace_preference_create_params.rb +13 -1
- data/lib/courier/models/workspace_preference_publish_params.rb +13 -1
- data/lib/courier/models/workspace_preferences/topic_create_params.rb +13 -1
- data/lib/courier/models.rb +2 -14
- data/lib/courier/resources/audiences.rb +12 -5
- data/lib/courier/resources/audit_events.rb +5 -2
- data/lib/courier/resources/auth.rb +5 -1
- data/lib/courier/resources/automations/invoke.rb +47 -23
- data/lib/courier/resources/automations.rb +6 -1
- data/lib/courier/resources/brands.rb +38 -12
- data/lib/courier/resources/digests/schedules.rb +4 -3
- data/lib/courier/resources/digests.rb +2 -0
- data/lib/courier/resources/inbound.rb +3 -1
- data/lib/courier/resources/inbox/messages.rb +58 -0
- data/lib/courier/resources/inbox.rb +19 -0
- data/lib/courier/resources/journeys/templates.rb +43 -25
- data/lib/courier/resources/journeys.rb +73 -44
- data/lib/courier/resources/lists/subscriptions.rb +22 -8
- data/lib/courier/resources/lists.rb +14 -5
- data/lib/courier/resources/messages.rb +14 -14
- data/lib/courier/resources/notifications/checks.rb +8 -3
- data/lib/courier/resources/notifications.rb +48 -30
- data/lib/courier/resources/profiles/lists.rb +19 -8
- data/lib/courier/resources/profiles.rb +25 -14
- data/lib/courier/resources/providers/catalog.rb +4 -4
- data/lib/courier/resources/providers.rb +27 -18
- data/lib/courier/resources/requests.rb +4 -1
- data/lib/courier/resources/routing_strategies.rb +24 -12
- data/lib/courier/resources/send.rb +14 -4
- data/lib/courier/resources/tenants/preferences/items.rb +6 -2
- data/lib/courier/resources/tenants/preferences.rb +2 -0
- data/lib/courier/resources/tenants/templates/versions.rb +4 -7
- data/lib/courier/resources/tenants/templates.rb +14 -19
- data/lib/courier/resources/tenants.rb +14 -5
- data/lib/courier/resources/translations.rb +6 -2
- data/lib/courier/resources/users/preferences.rb +23 -42
- data/lib/courier/resources/users/tenants.rb +12 -10
- data/lib/courier/resources/users/tokens.rb +14 -6
- data/lib/courier/resources/users.rb +6 -0
- data/lib/courier/resources/workspace_preferences/topics.rb +27 -19
- data/lib/courier/resources/workspace_preferences.rb +40 -20
- data/lib/courier/version.rb +1 -1
- data/lib/courier.rb +4 -11
- data/rbi/courier/client.rbi +38 -3
- data/rbi/courier/models/automations/invoke_invoke_ad_hoc_params.rbi +18 -0
- data/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi +18 -0
- data/rbi/courier/models/brand_create_params.rbi +18 -0
- data/rbi/courier/models/inbox/message_delete_params.rbi +40 -0
- data/rbi/courier/models/inbox/message_restore_params.rbi +40 -0
- data/rbi/courier/models/journey_cancel_params.rbi +31 -5
- data/rbi/courier/models/journey_create_params.rbi +31 -5
- data/rbi/courier/models/journey_invoke_params.rbi +26 -2
- data/rbi/courier/models/journey_publish_params.rbi +26 -2
- data/rbi/courier/models/journeys/template_create_params.rbi +26 -2
- data/rbi/courier/models/journeys/template_publish_params.rbi +23 -1
- data/rbi/courier/models/lists/subscription_add_params.rbi +23 -1
- data/rbi/courier/models/notification_create_params.rbi +31 -5
- data/rbi/courier/models/notification_publish_params.rbi +26 -2
- data/rbi/courier/models/profile_create_params.rbi +23 -1
- data/rbi/courier/models/profiles/list_subscribe_params.rbi +23 -1
- data/rbi/courier/models/provider_create_params.rbi +18 -0
- data/rbi/courier/models/routing_strategy_create_params.rbi +31 -5
- data/rbi/courier/models/send_message_params.rbi +18 -0
- data/rbi/courier/models/users/preference_bulk_update_params.rbi +18 -0
- data/rbi/courier/models/users/preference_update_or_create_topic_params.rbi +14 -2
- data/rbi/courier/models/users/topic_preference.rbi +24 -2
- data/rbi/courier/models/workspace_preference_create_params.rbi +31 -5
- data/rbi/courier/models/workspace_preference_publish_params.rbi +31 -5
- data/rbi/courier/models/workspace_preferences/topic_create_params.rbi +26 -2
- data/rbi/courier/models.rbi +2 -14
- data/rbi/courier/resources/audiences.rbi +12 -5
- data/rbi/courier/resources/audit_events.rbi +5 -2
- data/rbi/courier/resources/auth.rbi +5 -1
- data/rbi/courier/resources/automations/invoke.rbi +48 -7
- data/rbi/courier/resources/automations.rbi +6 -1
- data/rbi/courier/resources/brands.rbi +37 -7
- data/rbi/courier/resources/digests/schedules.rbi +4 -3
- data/rbi/courier/resources/digests.rbi +2 -0
- data/rbi/courier/resources/inbound.rbi +3 -1
- data/rbi/courier/resources/inbox/messages.rbi +44 -0
- data/rbi/courier/resources/inbox.rbi +16 -0
- data/rbi/courier/resources/journeys/templates.rbi +47 -17
- data/rbi/courier/resources/journeys.rbi +93 -39
- data/rbi/courier/resources/lists/subscriptions.rbi +24 -5
- data/rbi/courier/resources/lists.rbi +14 -5
- data/rbi/courier/resources/messages.rbi +14 -14
- data/rbi/courier/resources/notifications/checks.rbi +8 -3
- data/rbi/courier/resources/notifications.rbi +58 -28
- data/rbi/courier/resources/profiles/lists.rbi +25 -6
- data/rbi/courier/resources/profiles.rbi +31 -11
- data/rbi/courier/resources/providers/catalog.rbi +4 -4
- data/rbi/courier/resources/providers.rbi +35 -19
- data/rbi/courier/resources/requests.rbi +4 -1
- data/rbi/courier/resources/routing_strategies.rbi +26 -10
- data/rbi/courier/resources/send.rbi +20 -3
- data/rbi/courier/resources/tenants/preferences/items.rbi +6 -2
- data/rbi/courier/resources/tenants/preferences.rbi +2 -0
- data/rbi/courier/resources/tenants/templates/versions.rbi +4 -7
- data/rbi/courier/resources/tenants/templates.rbi +14 -19
- data/rbi/courier/resources/tenants.rbi +14 -5
- data/rbi/courier/resources/translations.rbi +6 -2
- data/rbi/courier/resources/users/preferences.rbi +28 -40
- data/rbi/courier/resources/users/tenants.rbi +12 -10
- data/rbi/courier/resources/users/tokens.rbi +14 -6
- data/rbi/courier/resources/users.rbi +6 -0
- data/rbi/courier/resources/workspace_preferences/topics.rbi +37 -18
- data/rbi/courier/resources/workspace_preferences.rbi +51 -17
- data/sig/courier/client.rbs +2 -2
- data/sig/courier/models/automations/invoke_invoke_ad_hoc_params.rbs +15 -1
- data/sig/courier/models/automations/invoke_invoke_by_template_params.rbs +15 -1
- data/sig/courier/models/brand_create_params.rbs +15 -1
- data/sig/courier/models/inbox/message_delete_params.rbs +25 -0
- data/sig/courier/models/inbox/message_restore_params.rbs +25 -0
- data/sig/courier/models/journey_cancel_params.rbs +20 -3
- data/sig/courier/models/journey_create_params.rbs +20 -3
- data/sig/courier/models/journey_invoke_params.rbs +18 -1
- data/sig/courier/models/journey_publish_params.rbs +18 -1
- data/sig/courier/models/journeys/template_create_params.rbs +18 -1
- data/sig/courier/models/journeys/template_publish_params.rbs +18 -1
- data/sig/courier/models/lists/subscription_add_params.rbs +15 -1
- data/sig/courier/models/notification_create_params.rbs +20 -3
- data/sig/courier/models/notification_publish_params.rbs +18 -2
- data/sig/courier/models/profile_create_params.rbs +18 -1
- data/sig/courier/models/profiles/list_subscribe_params.rbs +15 -1
- data/sig/courier/models/provider_create_params.rbs +15 -1
- data/sig/courier/models/routing_strategy_create_params.rbs +20 -3
- data/sig/courier/models/send_message_params.rbs +17 -1
- data/sig/courier/models/users/preference_bulk_update_params.rbs +15 -1
- data/sig/courier/models/workspace_preference_create_params.rbs +20 -3
- data/sig/courier/models/workspace_preference_publish_params.rbs +20 -3
- data/sig/courier/models/workspace_preferences/topic_create_params.rbs +18 -1
- data/sig/courier/models.rbs +2 -14
- data/sig/courier/resources/automations/invoke.rbs +4 -0
- data/sig/courier/resources/brands.rbs +2 -0
- data/sig/courier/resources/inbox/messages.rbs +19 -0
- data/sig/courier/resources/inbox.rbs +9 -0
- data/sig/courier/resources/journeys/templates.rbs +4 -0
- data/sig/courier/resources/journeys.rbs +8 -0
- data/sig/courier/resources/lists/subscriptions.rbs +2 -0
- data/sig/courier/resources/notifications.rbs +4 -0
- data/sig/courier/resources/profiles/lists.rbs +2 -0
- data/sig/courier/resources/profiles.rbs +2 -0
- data/sig/courier/resources/providers.rbs +2 -0
- data/sig/courier/resources/routing_strategies.rbs +2 -0
- data/sig/courier/resources/send.rbs +2 -0
- data/sig/courier/resources/users/preferences.rbs +2 -0
- data/sig/courier/resources/workspace_preferences/topics.rbs +2 -0
- data/sig/courier/resources/workspace_preferences.rbs +4 -0
- metadata +14 -35
- data/lib/courier/models/bulk_add_users_params.rb +0 -26
- data/lib/courier/models/bulk_create_job_params.rb +0 -29
- data/lib/courier/models/bulk_create_job_response.rb +0 -16
- data/lib/courier/models/bulk_list_users_params.rb +0 -33
- data/lib/courier/models/bulk_list_users_response.rb +0 -49
- data/lib/courier/models/bulk_retrieve_job_params.rb +0 -20
- data/lib/courier/models/bulk_retrieve_job_response.rb +0 -76
- data/lib/courier/models/bulk_run_job_params.rb +0 -20
- data/lib/courier/models/inbound_bulk_message.rb +0 -91
- data/lib/courier/models/inbound_bulk_message_user.rb +0 -54
- data/lib/courier/resources/bulk.rb +0 -141
- data/rbi/courier/models/bulk_add_users_params.rbi +0 -43
- data/rbi/courier/models/bulk_create_job_params.rbi +0 -54
- data/rbi/courier/models/bulk_create_job_response.rbi +0 -26
- data/rbi/courier/models/bulk_list_users_params.rbi +0 -51
- data/rbi/courier/models/bulk_list_users_response.rbi +0 -125
- data/rbi/courier/models/bulk_retrieve_job_params.rbi +0 -35
- data/rbi/courier/models/bulk_retrieve_job_response.rbi +0 -157
- data/rbi/courier/models/bulk_run_job_params.rbi +0 -35
- data/rbi/courier/models/inbound_bulk_message.rbi +0 -124
- data/rbi/courier/models/inbound_bulk_message_user.rbi +0 -88
- data/rbi/courier/resources/bulk.rbi +0 -102
- data/sig/courier/models/bulk_add_users_params.rbs +0 -28
- data/sig/courier/models/bulk_create_job_params.rbs +0 -24
- data/sig/courier/models/bulk_create_job_response.rbs +0 -13
- data/sig/courier/models/bulk_list_users_params.rbs +0 -28
- data/sig/courier/models/bulk_list_users_response.rbs +0 -65
- data/sig/courier/models/bulk_retrieve_job_params.rbs +0 -23
- data/sig/courier/models/bulk_retrieve_job_response.rbs +0 -66
- data/sig/courier/models/bulk_run_job_params.rbs +0 -23
- data/sig/courier/models/inbound_bulk_message.rbs +0 -58
- data/sig/courier/models/inbound_bulk_message_user.rbs +0 -42
- data/sig/courier/resources/bulk.rbs +0 -34
|
@@ -1,15 +1,32 @@
|
|
|
1
1
|
module Courier
|
|
2
2
|
module Models
|
|
3
3
|
type workspace_preference_publish_params =
|
|
4
|
-
{
|
|
4
|
+
{ idempotency_key: String, x_idempotency_expiration: String }
|
|
5
|
+
& Courier::Internal::Type::request_parameters
|
|
5
6
|
|
|
6
7
|
class WorkspacePreferencePublishParams < Courier::Models::PublishPreferencesRequest
|
|
7
8
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
9
|
include Courier::Internal::Type::RequestParameters
|
|
9
10
|
|
|
10
|
-
def
|
|
11
|
+
def idempotency_key: -> String?
|
|
11
12
|
|
|
12
|
-
def
|
|
13
|
+
def idempotency_key=: (String _) -> String
|
|
14
|
+
|
|
15
|
+
def x_idempotency_expiration: -> String?
|
|
16
|
+
|
|
17
|
+
def x_idempotency_expiration=: (String _) -> String
|
|
18
|
+
|
|
19
|
+
def initialize: (
|
|
20
|
+
?idempotency_key: String,
|
|
21
|
+
?x_idempotency_expiration: String,
|
|
22
|
+
?request_options: Courier::request_opts
|
|
23
|
+
) -> void
|
|
24
|
+
|
|
25
|
+
def to_hash: -> {
|
|
26
|
+
idempotency_key: String,
|
|
27
|
+
x_idempotency_expiration: String,
|
|
28
|
+
request_options: Courier::RequestOptions
|
|
29
|
+
}
|
|
13
30
|
end
|
|
14
31
|
end
|
|
15
32
|
end
|
|
@@ -2,7 +2,12 @@ module Courier
|
|
|
2
2
|
module Models
|
|
3
3
|
module WorkspacePreferences
|
|
4
4
|
type topic_create_params =
|
|
5
|
-
{
|
|
5
|
+
{
|
|
6
|
+
section_id: String,
|
|
7
|
+
idempotency_key: String,
|
|
8
|
+
x_idempotency_expiration: String
|
|
9
|
+
}
|
|
10
|
+
& Courier::Internal::Type::request_parameters
|
|
6
11
|
|
|
7
12
|
class TopicCreateParams < Courier::Models::WorkspacePreferenceTopicCreateRequest
|
|
8
13
|
extend Courier::Internal::Type::RequestParameters::Converter
|
|
@@ -12,13 +17,25 @@ module Courier
|
|
|
12
17
|
|
|
13
18
|
def section_id=: (String _) -> String
|
|
14
19
|
|
|
20
|
+
def idempotency_key: -> String?
|
|
21
|
+
|
|
22
|
+
def idempotency_key=: (String _) -> String
|
|
23
|
+
|
|
24
|
+
def x_idempotency_expiration: -> String?
|
|
25
|
+
|
|
26
|
+
def x_idempotency_expiration=: (String _) -> String
|
|
27
|
+
|
|
15
28
|
def initialize: (
|
|
16
29
|
section_id: String,
|
|
30
|
+
?idempotency_key: String,
|
|
31
|
+
?x_idempotency_expiration: String,
|
|
17
32
|
?request_options: Courier::request_opts
|
|
18
33
|
) -> void
|
|
19
34
|
|
|
20
35
|
def to_hash: -> {
|
|
21
36
|
section_id: String,
|
|
37
|
+
idempotency_key: String,
|
|
38
|
+
x_idempotency_expiration: String,
|
|
22
39
|
request_options: Courier::RequestOptions
|
|
23
40
|
}
|
|
24
41
|
end
|
data/sig/courier/models.rbs
CHANGED
|
@@ -73,16 +73,6 @@ module Courier
|
|
|
73
73
|
|
|
74
74
|
class BrandUpdateParams = Courier::Models::BrandUpdateParams
|
|
75
75
|
|
|
76
|
-
class BulkAddUsersParams = Courier::Models::BulkAddUsersParams
|
|
77
|
-
|
|
78
|
-
class BulkCreateJobParams = Courier::Models::BulkCreateJobParams
|
|
79
|
-
|
|
80
|
-
class BulkListUsersParams = Courier::Models::BulkListUsersParams
|
|
81
|
-
|
|
82
|
-
class BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
|
|
83
|
-
|
|
84
|
-
class BulkRunJobParams = Courier::Models::BulkRunJobParams
|
|
85
|
-
|
|
86
76
|
module CancelJourneyRequest = Courier::Models::CancelJourneyRequest
|
|
87
77
|
|
|
88
78
|
module CancelJourneyResponse = Courier::Models::CancelJourneyResponse
|
|
@@ -153,12 +143,10 @@ module Courier
|
|
|
153
143
|
|
|
154
144
|
class Icons = Courier::Models::Icons
|
|
155
145
|
|
|
156
|
-
class InboundBulkMessage = Courier::Models::InboundBulkMessage
|
|
157
|
-
|
|
158
|
-
class InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
|
|
159
|
-
|
|
160
146
|
class InboundTrackEventParams = Courier::Models::InboundTrackEventParams
|
|
161
147
|
|
|
148
|
+
module Inbox = Courier::Models::Inbox
|
|
149
|
+
|
|
162
150
|
class Intercom = Courier::Models::Intercom
|
|
163
151
|
|
|
164
152
|
class IntercomRecipient = Courier::Models::IntercomRecipient
|
|
@@ -9,6 +9,8 @@ module Courier
|
|
|
9
9
|
?profile: ::Hash[Symbol, top]?,
|
|
10
10
|
?recipient: String?,
|
|
11
11
|
?template: String?,
|
|
12
|
+
?idempotency_key: String,
|
|
13
|
+
?x_idempotency_expiration: String,
|
|
12
14
|
?request_options: Courier::request_opts
|
|
13
15
|
) -> Courier::AutomationInvokeResponse
|
|
14
16
|
|
|
@@ -19,6 +21,8 @@ module Courier
|
|
|
19
21
|
?data: ::Hash[Symbol, top]?,
|
|
20
22
|
?profile: ::Hash[Symbol, top]?,
|
|
21
23
|
?template: String?,
|
|
24
|
+
?idempotency_key: String,
|
|
25
|
+
?x_idempotency_expiration: String,
|
|
22
26
|
?request_options: Courier::request_opts
|
|
23
27
|
) -> Courier::AutomationInvokeResponse
|
|
24
28
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
module Courier
|
|
2
|
+
module Resources
|
|
3
|
+
class Inbox
|
|
4
|
+
class Messages
|
|
5
|
+
def delete: (
|
|
6
|
+
String message_id,
|
|
7
|
+
?request_options: Courier::request_opts
|
|
8
|
+
) -> nil
|
|
9
|
+
|
|
10
|
+
def restore: (
|
|
11
|
+
String message_id,
|
|
12
|
+
?request_options: Courier::request_opts
|
|
13
|
+
) -> nil
|
|
14
|
+
|
|
15
|
+
def initialize: (client: Courier::Client) -> void
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -8,6 +8,8 @@ module Courier
|
|
|
8
8
|
notification: Courier::JourneyTemplateCreateRequest::Notification,
|
|
9
9
|
?provider_key: String,
|
|
10
10
|
?state: String,
|
|
11
|
+
?idempotency_key: String,
|
|
12
|
+
?x_idempotency_expiration: String,
|
|
11
13
|
?request_options: Courier::request_opts
|
|
12
14
|
) -> Courier::JourneyTemplateGetResponse
|
|
13
15
|
|
|
@@ -40,6 +42,8 @@ module Courier
|
|
|
40
42
|
String notification_id,
|
|
41
43
|
template_id: String,
|
|
42
44
|
?version: String,
|
|
45
|
+
?idempotency_key: String,
|
|
46
|
+
?x_idempotency_expiration: String,
|
|
43
47
|
?request_options: Courier::request_opts
|
|
44
48
|
) -> nil
|
|
45
49
|
|
|
@@ -8,6 +8,8 @@ module Courier
|
|
|
8
8
|
nodes: ::Array[Courier::Models::journey_node],
|
|
9
9
|
?enabled: bool,
|
|
10
10
|
?state: Courier::Models::journey_state,
|
|
11
|
+
?idempotency_key: String,
|
|
12
|
+
?x_idempotency_expiration: String,
|
|
11
13
|
?request_options: Courier::request_opts
|
|
12
14
|
) -> Courier::JourneyResponse
|
|
13
15
|
|
|
@@ -30,6 +32,8 @@ module Courier
|
|
|
30
32
|
|
|
31
33
|
def cancel: (
|
|
32
34
|
cancel_journey_request: Courier::Models::cancel_journey_request,
|
|
35
|
+
?idempotency_key: String,
|
|
36
|
+
?x_idempotency_expiration: String,
|
|
33
37
|
?request_options: Courier::request_opts
|
|
34
38
|
) -> Courier::Models::cancel_journey_response
|
|
35
39
|
|
|
@@ -38,6 +42,8 @@ module Courier
|
|
|
38
42
|
?data: ::Hash[Symbol, top],
|
|
39
43
|
?profile: ::Hash[Symbol, top],
|
|
40
44
|
?user_id: String,
|
|
45
|
+
?idempotency_key: String,
|
|
46
|
+
?x_idempotency_expiration: String,
|
|
41
47
|
?request_options: Courier::request_opts
|
|
42
48
|
) -> Courier::JourneysInvokeResponse
|
|
43
49
|
|
|
@@ -49,6 +55,8 @@ module Courier
|
|
|
49
55
|
def publish: (
|
|
50
56
|
String template_id,
|
|
51
57
|
?version: String,
|
|
58
|
+
?idempotency_key: String,
|
|
59
|
+
?x_idempotency_expiration: String,
|
|
52
60
|
?request_options: Courier::request_opts
|
|
53
61
|
) -> Courier::JourneyResponse
|
|
54
62
|
|
|
@@ -6,6 +6,8 @@ module Courier
|
|
|
6
6
|
def create: (
|
|
7
7
|
notification: Courier::NotificationTemplatePayload,
|
|
8
8
|
?state: Courier::Models::NotificationTemplateCreateRequest::state,
|
|
9
|
+
?idempotency_key: String,
|
|
10
|
+
?x_idempotency_expiration: String,
|
|
9
11
|
?request_options: Courier::request_opts
|
|
10
12
|
) -> Courier::NotificationTemplateResponse
|
|
11
13
|
|
|
@@ -39,6 +41,8 @@ module Courier
|
|
|
39
41
|
def publish: (
|
|
40
42
|
String id,
|
|
41
43
|
?version: String,
|
|
44
|
+
?idempotency_key: String,
|
|
45
|
+
?x_idempotency_expiration: String,
|
|
42
46
|
?request_options: Courier::request_opts
|
|
43
47
|
) -> nil
|
|
44
48
|
|
|
@@ -16,6 +16,8 @@ module Courier
|
|
|
16
16
|
def subscribe: (
|
|
17
17
|
String user_id,
|
|
18
18
|
lists: ::Array[Courier::SubscribeToListsRequestItem],
|
|
19
|
+
?idempotency_key: String,
|
|
20
|
+
?x_idempotency_expiration: String,
|
|
19
21
|
?request_options: Courier::request_opts
|
|
20
22
|
) -> Courier::Models::Profiles::ListSubscribeResponse
|
|
21
23
|
|
|
@@ -8,6 +8,8 @@ module Courier
|
|
|
8
8
|
?description: String?,
|
|
9
9
|
?providers: Courier::Models::message_providers?,
|
|
10
10
|
?tags: ::Array[String]?,
|
|
11
|
+
?idempotency_key: String,
|
|
12
|
+
?x_idempotency_expiration: String,
|
|
11
13
|
?request_options: Courier::request_opts
|
|
12
14
|
) -> Courier::RoutingStrategyGetResponse
|
|
13
15
|
|
|
@@ -19,6 +19,8 @@ module Courier
|
|
|
19
19
|
String user_id,
|
|
20
20
|
topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
|
|
21
21
|
?tenant_id: String?,
|
|
22
|
+
?idempotency_key: String,
|
|
23
|
+
?x_idempotency_expiration: String,
|
|
22
24
|
?request_options: Courier::request_opts
|
|
23
25
|
) -> Courier::Models::Users::PreferenceBulkUpdateResponse
|
|
24
26
|
|
|
@@ -11,6 +11,8 @@ module Courier
|
|
|
11
11
|
?include_unsubscribe_header: bool?,
|
|
12
12
|
?routing_options: ::Array[Courier::Models::channel_classification]?,
|
|
13
13
|
?topic_data: ::Hash[Symbol, top]?,
|
|
14
|
+
?idempotency_key: String,
|
|
15
|
+
?x_idempotency_expiration: String,
|
|
14
16
|
?request_options: Courier::request_opts
|
|
15
17
|
) -> Courier::WorkspacePreferenceTopicGetResponse
|
|
16
18
|
|
|
@@ -8,6 +8,8 @@ module Courier
|
|
|
8
8
|
?description: String?,
|
|
9
9
|
?has_custom_routing: bool?,
|
|
10
10
|
?routing_options: ::Array[Courier::Models::channel_classification]?,
|
|
11
|
+
?idempotency_key: String,
|
|
12
|
+
?x_idempotency_expiration: String,
|
|
11
13
|
?request_options: Courier::request_opts
|
|
12
14
|
) -> Courier::WorkspacePreferenceGetResponse
|
|
13
15
|
|
|
@@ -29,6 +31,8 @@ module Courier
|
|
|
29
31
|
?brand_id: String?,
|
|
30
32
|
?description: String?,
|
|
31
33
|
?heading: String?,
|
|
34
|
+
?idempotency_key: String,
|
|
35
|
+
?x_idempotency_expiration: String,
|
|
32
36
|
?request_options: Courier::request_opts
|
|
33
37
|
) -> Courier::PublishPreferencesResponse
|
|
34
38
|
|
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.
|
|
4
|
+
version: 4.22.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Courier
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -113,14 +113,6 @@ files:
|
|
|
113
113
|
- lib/courier/models/brand_snippets.rb
|
|
114
114
|
- lib/courier/models/brand_template.rb
|
|
115
115
|
- lib/courier/models/brand_update_params.rb
|
|
116
|
-
- lib/courier/models/bulk_add_users_params.rb
|
|
117
|
-
- lib/courier/models/bulk_create_job_params.rb
|
|
118
|
-
- lib/courier/models/bulk_create_job_response.rb
|
|
119
|
-
- lib/courier/models/bulk_list_users_params.rb
|
|
120
|
-
- lib/courier/models/bulk_list_users_response.rb
|
|
121
|
-
- lib/courier/models/bulk_retrieve_job_params.rb
|
|
122
|
-
- lib/courier/models/bulk_retrieve_job_response.rb
|
|
123
|
-
- lib/courier/models/bulk_run_job_params.rb
|
|
124
116
|
- lib/courier/models/cancel_journey_request.rb
|
|
125
117
|
- lib/courier/models/cancel_journey_response.rb
|
|
126
118
|
- lib/courier/models/channel.rb
|
|
@@ -157,10 +149,10 @@ files:
|
|
|
157
149
|
- lib/courier/models/expo.rb
|
|
158
150
|
- lib/courier/models/filter_config.rb
|
|
159
151
|
- lib/courier/models/icons.rb
|
|
160
|
-
- lib/courier/models/inbound_bulk_message.rb
|
|
161
|
-
- lib/courier/models/inbound_bulk_message_user.rb
|
|
162
152
|
- lib/courier/models/inbound_track_event_params.rb
|
|
163
153
|
- lib/courier/models/inbound_track_event_response.rb
|
|
154
|
+
- lib/courier/models/inbox/message_delete_params.rb
|
|
155
|
+
- lib/courier/models/inbox/message_restore_params.rb
|
|
164
156
|
- lib/courier/models/intercom.rb
|
|
165
157
|
- lib/courier/models/intercom_recipient.rb
|
|
166
158
|
- lib/courier/models/journey.rb
|
|
@@ -448,10 +440,11 @@ files:
|
|
|
448
440
|
- lib/courier/resources/automations.rb
|
|
449
441
|
- lib/courier/resources/automations/invoke.rb
|
|
450
442
|
- lib/courier/resources/brands.rb
|
|
451
|
-
- lib/courier/resources/bulk.rb
|
|
452
443
|
- lib/courier/resources/digests.rb
|
|
453
444
|
- lib/courier/resources/digests/schedules.rb
|
|
454
445
|
- lib/courier/resources/inbound.rb
|
|
446
|
+
- lib/courier/resources/inbox.rb
|
|
447
|
+
- lib/courier/resources/inbox/messages.rb
|
|
455
448
|
- lib/courier/resources/journeys.rb
|
|
456
449
|
- lib/courier/resources/journeys/templates.rb
|
|
457
450
|
- lib/courier/resources/lists.rb
|
|
@@ -543,14 +536,6 @@ files:
|
|
|
543
536
|
- rbi/courier/models/brand_snippets.rbi
|
|
544
537
|
- rbi/courier/models/brand_template.rbi
|
|
545
538
|
- rbi/courier/models/brand_update_params.rbi
|
|
546
|
-
- rbi/courier/models/bulk_add_users_params.rbi
|
|
547
|
-
- rbi/courier/models/bulk_create_job_params.rbi
|
|
548
|
-
- rbi/courier/models/bulk_create_job_response.rbi
|
|
549
|
-
- rbi/courier/models/bulk_list_users_params.rbi
|
|
550
|
-
- rbi/courier/models/bulk_list_users_response.rbi
|
|
551
|
-
- rbi/courier/models/bulk_retrieve_job_params.rbi
|
|
552
|
-
- rbi/courier/models/bulk_retrieve_job_response.rbi
|
|
553
|
-
- rbi/courier/models/bulk_run_job_params.rbi
|
|
554
539
|
- rbi/courier/models/cancel_journey_request.rbi
|
|
555
540
|
- rbi/courier/models/cancel_journey_response.rbi
|
|
556
541
|
- rbi/courier/models/channel.rbi
|
|
@@ -587,10 +572,10 @@ files:
|
|
|
587
572
|
- rbi/courier/models/expo.rbi
|
|
588
573
|
- rbi/courier/models/filter_config.rbi
|
|
589
574
|
- rbi/courier/models/icons.rbi
|
|
590
|
-
- rbi/courier/models/inbound_bulk_message.rbi
|
|
591
|
-
- rbi/courier/models/inbound_bulk_message_user.rbi
|
|
592
575
|
- rbi/courier/models/inbound_track_event_params.rbi
|
|
593
576
|
- rbi/courier/models/inbound_track_event_response.rbi
|
|
577
|
+
- rbi/courier/models/inbox/message_delete_params.rbi
|
|
578
|
+
- rbi/courier/models/inbox/message_restore_params.rbi
|
|
594
579
|
- rbi/courier/models/intercom.rbi
|
|
595
580
|
- rbi/courier/models/intercom_recipient.rbi
|
|
596
581
|
- rbi/courier/models/journey.rbi
|
|
@@ -878,10 +863,11 @@ files:
|
|
|
878
863
|
- rbi/courier/resources/automations.rbi
|
|
879
864
|
- rbi/courier/resources/automations/invoke.rbi
|
|
880
865
|
- rbi/courier/resources/brands.rbi
|
|
881
|
-
- rbi/courier/resources/bulk.rbi
|
|
882
866
|
- rbi/courier/resources/digests.rbi
|
|
883
867
|
- rbi/courier/resources/digests/schedules.rbi
|
|
884
868
|
- rbi/courier/resources/inbound.rbi
|
|
869
|
+
- rbi/courier/resources/inbox.rbi
|
|
870
|
+
- rbi/courier/resources/inbox/messages.rbi
|
|
885
871
|
- rbi/courier/resources/journeys.rbi
|
|
886
872
|
- rbi/courier/resources/journeys/templates.rbi
|
|
887
873
|
- rbi/courier/resources/lists.rbi
|
|
@@ -972,14 +958,6 @@ files:
|
|
|
972
958
|
- sig/courier/models/brand_snippets.rbs
|
|
973
959
|
- sig/courier/models/brand_template.rbs
|
|
974
960
|
- sig/courier/models/brand_update_params.rbs
|
|
975
|
-
- sig/courier/models/bulk_add_users_params.rbs
|
|
976
|
-
- sig/courier/models/bulk_create_job_params.rbs
|
|
977
|
-
- sig/courier/models/bulk_create_job_response.rbs
|
|
978
|
-
- sig/courier/models/bulk_list_users_params.rbs
|
|
979
|
-
- sig/courier/models/bulk_list_users_response.rbs
|
|
980
|
-
- sig/courier/models/bulk_retrieve_job_params.rbs
|
|
981
|
-
- sig/courier/models/bulk_retrieve_job_response.rbs
|
|
982
|
-
- sig/courier/models/bulk_run_job_params.rbs
|
|
983
961
|
- sig/courier/models/cancel_journey_request.rbs
|
|
984
962
|
- sig/courier/models/cancel_journey_response.rbs
|
|
985
963
|
- sig/courier/models/channel.rbs
|
|
@@ -1016,10 +994,10 @@ files:
|
|
|
1016
994
|
- sig/courier/models/expo.rbs
|
|
1017
995
|
- sig/courier/models/filter_config.rbs
|
|
1018
996
|
- sig/courier/models/icons.rbs
|
|
1019
|
-
- sig/courier/models/inbound_bulk_message.rbs
|
|
1020
|
-
- sig/courier/models/inbound_bulk_message_user.rbs
|
|
1021
997
|
- sig/courier/models/inbound_track_event_params.rbs
|
|
1022
998
|
- sig/courier/models/inbound_track_event_response.rbs
|
|
999
|
+
- sig/courier/models/inbox/message_delete_params.rbs
|
|
1000
|
+
- sig/courier/models/inbox/message_restore_params.rbs
|
|
1023
1001
|
- sig/courier/models/intercom.rbs
|
|
1024
1002
|
- sig/courier/models/intercom_recipient.rbs
|
|
1025
1003
|
- sig/courier/models/journey.rbs
|
|
@@ -1307,10 +1285,11 @@ files:
|
|
|
1307
1285
|
- sig/courier/resources/automations.rbs
|
|
1308
1286
|
- sig/courier/resources/automations/invoke.rbs
|
|
1309
1287
|
- sig/courier/resources/brands.rbs
|
|
1310
|
-
- sig/courier/resources/bulk.rbs
|
|
1311
1288
|
- sig/courier/resources/digests.rbs
|
|
1312
1289
|
- sig/courier/resources/digests/schedules.rbs
|
|
1313
1290
|
- sig/courier/resources/inbound.rbs
|
|
1291
|
+
- sig/courier/resources/inbox.rbs
|
|
1292
|
+
- sig/courier/resources/inbox/messages.rbs
|
|
1314
1293
|
- sig/courier/resources/journeys.rbs
|
|
1315
1294
|
- sig/courier/resources/journeys/templates.rbs
|
|
1316
1295
|
- sig/courier/resources/lists.rbs
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#add_users
|
|
6
|
-
class BulkAddUsersParams < Courier::Internal::Type::BaseModel
|
|
7
|
-
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Courier::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute job_id
|
|
11
|
-
#
|
|
12
|
-
# @return [String]
|
|
13
|
-
required :job_id, String
|
|
14
|
-
|
|
15
|
-
# @!attribute users
|
|
16
|
-
#
|
|
17
|
-
# @return [Array<Courier::Models::InboundBulkMessageUser>]
|
|
18
|
-
required :users, -> { Courier::Internal::Type::ArrayOf[Courier::InboundBulkMessageUser] }
|
|
19
|
-
|
|
20
|
-
# @!method initialize(job_id:, users:, request_options: {})
|
|
21
|
-
# @param job_id [String]
|
|
22
|
-
# @param users [Array<Courier::Models::InboundBulkMessageUser>]
|
|
23
|
-
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
|
|
24
|
-
end
|
|
25
|
-
end
|
|
26
|
-
end
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#create_job
|
|
6
|
-
class BulkCreateJobParams < Courier::Internal::Type::BaseModel
|
|
7
|
-
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Courier::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute message
|
|
11
|
-
# Bulk message definition. Supports two formats:
|
|
12
|
-
#
|
|
13
|
-
# - V1 format: Requires `event` field (event ID or notification ID)
|
|
14
|
-
# - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
15
|
-
# content) in addition to `event`
|
|
16
|
-
#
|
|
17
|
-
# @return [Courier::Models::InboundBulkMessage]
|
|
18
|
-
required :message, -> { Courier::InboundBulkMessage }
|
|
19
|
-
|
|
20
|
-
# @!method initialize(message:, request_options: {})
|
|
21
|
-
# Some parameter documentations has been truncated, see
|
|
22
|
-
# {Courier::Models::BulkCreateJobParams} for more details.
|
|
23
|
-
#
|
|
24
|
-
# @param message [Courier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
|
|
25
|
-
#
|
|
26
|
-
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
end
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#create_job
|
|
6
|
-
class BulkCreateJobResponse < Courier::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute job_id
|
|
8
|
-
#
|
|
9
|
-
# @return [String]
|
|
10
|
-
required :job_id, String, api_name: :jobId
|
|
11
|
-
|
|
12
|
-
# @!method initialize(job_id:)
|
|
13
|
-
# @param job_id [String]
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
end
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#list_users
|
|
6
|
-
class BulkListUsersParams < Courier::Internal::Type::BaseModel
|
|
7
|
-
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Courier::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute job_id
|
|
11
|
-
#
|
|
12
|
-
# @return [String]
|
|
13
|
-
required :job_id, String
|
|
14
|
-
|
|
15
|
-
# @!attribute cursor
|
|
16
|
-
# A unique identifier that allows for fetching the next set of users added to the
|
|
17
|
-
# bulk job
|
|
18
|
-
#
|
|
19
|
-
# @return [String, nil]
|
|
20
|
-
optional :cursor, String, nil?: true
|
|
21
|
-
|
|
22
|
-
# @!method initialize(job_id:, cursor: nil, request_options: {})
|
|
23
|
-
# Some parameter documentations has been truncated, see
|
|
24
|
-
# {Courier::Models::BulkListUsersParams} for more details.
|
|
25
|
-
#
|
|
26
|
-
# @param job_id [String]
|
|
27
|
-
#
|
|
28
|
-
# @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the
|
|
29
|
-
#
|
|
30
|
-
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
|
|
31
|
-
end
|
|
32
|
-
end
|
|
33
|
-
end
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#list_users
|
|
6
|
-
class BulkListUsersResponse < Courier::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute items
|
|
8
|
-
#
|
|
9
|
-
# @return [Array<Courier::Models::BulkListUsersResponse::Item>]
|
|
10
|
-
required :items, -> { Courier::Internal::Type::ArrayOf[Courier::Models::BulkListUsersResponse::Item] }
|
|
11
|
-
|
|
12
|
-
# @!attribute paging
|
|
13
|
-
#
|
|
14
|
-
# @return [Courier::Models::Paging]
|
|
15
|
-
required :paging, -> { Courier::Paging }
|
|
16
|
-
|
|
17
|
-
# @!method initialize(items:, paging:)
|
|
18
|
-
# @param items [Array<Courier::Models::BulkListUsersResponse::Item>]
|
|
19
|
-
# @param paging [Courier::Models::Paging]
|
|
20
|
-
|
|
21
|
-
class Item < Courier::Models::InboundBulkMessageUser
|
|
22
|
-
# @!attribute status
|
|
23
|
-
#
|
|
24
|
-
# @return [Symbol, Courier::Models::BulkListUsersResponse::Item::Status]
|
|
25
|
-
required :status, enum: -> { Courier::Models::BulkListUsersResponse::Item::Status }
|
|
26
|
-
|
|
27
|
-
# @!attribute message_id
|
|
28
|
-
#
|
|
29
|
-
# @return [String, nil]
|
|
30
|
-
optional :message_id, String, api_name: :messageId, nil?: true
|
|
31
|
-
|
|
32
|
-
# @!method initialize(status:, message_id: nil)
|
|
33
|
-
# @param status [Symbol, Courier::Models::BulkListUsersResponse::Item::Status]
|
|
34
|
-
# @param message_id [String, nil]
|
|
35
|
-
|
|
36
|
-
module Status
|
|
37
|
-
extend Courier::Internal::Type::Enum
|
|
38
|
-
|
|
39
|
-
PENDING = :PENDING
|
|
40
|
-
ENQUEUED = :ENQUEUED
|
|
41
|
-
ERROR = :ERROR
|
|
42
|
-
|
|
43
|
-
# @!method self.values
|
|
44
|
-
# @return [Array<Symbol>]
|
|
45
|
-
end
|
|
46
|
-
end
|
|
47
|
-
end
|
|
48
|
-
end
|
|
49
|
-
end
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#retrieve_job
|
|
6
|
-
class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel
|
|
7
|
-
extend Courier::Internal::Type::RequestParameters::Converter
|
|
8
|
-
include Courier::Internal::Type::RequestParameters
|
|
9
|
-
|
|
10
|
-
# @!attribute job_id
|
|
11
|
-
#
|
|
12
|
-
# @return [String]
|
|
13
|
-
required :job_id, String
|
|
14
|
-
|
|
15
|
-
# @!method initialize(job_id:, request_options: {})
|
|
16
|
-
# @param job_id [String]
|
|
17
|
-
# @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
-
end
|
|
19
|
-
end
|
|
20
|
-
end
|