trycourier 5.0.0 → 6.1.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.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/courier/internal/type/union.rb +7 -7
  5. data/lib/courier/models/apn.rb +19 -0
  6. data/lib/courier/models/automation_run_list_item.rb +57 -0
  7. data/lib/courier/models/automation_run_list_response.rb +25 -0
  8. data/lib/courier/models/automation_run_step.rb +64 -0
  9. data/lib/courier/models/automation_run_steps_response.rb +17 -0
  10. data/lib/courier/models/automations/run_list_params.rb +71 -0
  11. data/lib/courier/models/automations/run_list_steps_params.rb +22 -0
  12. data/lib/courier/models/create_journey_request.rb +2 -2
  13. data/lib/courier/models/expo.rb +1 -0
  14. data/lib/courier/models/journey_audience_trigger_node.rb +77 -0
  15. data/lib/courier/models/journey_node.rb +8 -2
  16. data/lib/courier/models/journey_response.rb +2 -2
  17. data/lib/courier/models/journey_run.rb +66 -0
  18. data/lib/courier/models/journey_run_list_item.rb +50 -0
  19. data/lib/courier/models/journey_run_list_response.rb +33 -0
  20. data/lib/courier/models/journey_run_response.rb +22 -0
  21. data/lib/courier/models/journey_run_step.rb +65 -0
  22. data/lib/courier/models/journey_run_steps_response.rb +17 -0
  23. data/lib/courier/models/journey_segment_trigger_node.rb +5 -1
  24. data/lib/courier/models/journey_webhook_trigger_node.rb +85 -0
  25. data/lib/courier/models/journeys/run_list_params.rb +71 -0
  26. data/lib/courier/models/journeys/run_list_steps_params.rb +22 -0
  27. data/lib/courier/models/journeys/run_retrieve_params.rb +22 -0
  28. data/lib/courier/models/multiple_tokens.rb +26 -3
  29. data/lib/courier/models/user_profile.rb +8 -4
  30. data/lib/courier/models/users/topic_preference.rb +21 -1
  31. data/lib/courier/models.rb +26 -2
  32. data/lib/courier/resources/automations/runs.rb +80 -0
  33. data/lib/courier/resources/automations.rb +6 -0
  34. data/lib/courier/resources/journeys/runs.rb +104 -0
  35. data/lib/courier/resources/journeys.rb +8 -2
  36. data/lib/courier/resources/notifications.rb +0 -22
  37. data/lib/courier/version.rb +1 -1
  38. data/lib/courier.rb +20 -1
  39. data/rbi/courier/models/apn.rbi +18 -0
  40. data/rbi/courier/models/automation_run_list_item.rbi +87 -0
  41. data/rbi/courier/models/automation_run_list_response.rbi +47 -0
  42. data/rbi/courier/models/automation_run_step.rbi +96 -0
  43. data/rbi/courier/models/automation_run_steps_response.rbi +28 -0
  44. data/rbi/courier/models/automations/run_list_params.rbi +114 -0
  45. data/rbi/courier/models/automations/run_list_steps_params.rbi +40 -0
  46. data/rbi/courier/models/create_journey_request.rbi +6 -0
  47. data/rbi/courier/models/expo.rbi +1 -0
  48. data/rbi/courier/models/journey_audience_trigger_node.rbi +162 -0
  49. data/rbi/courier/models/journey_node.rbi +2 -0
  50. data/rbi/courier/models/journey_response.rbi +2 -0
  51. data/rbi/courier/models/journey_run.rbi +97 -0
  52. data/rbi/courier/models/journey_run_list_item.rbi +79 -0
  53. data/rbi/courier/models/journey_run_list_response.rbi +58 -0
  54. data/rbi/courier/models/journey_run_response.rbi +33 -0
  55. data/rbi/courier/models/journey_run_step.rbi +97 -0
  56. data/rbi/courier/models/journey_run_steps_response.rbi +28 -0
  57. data/rbi/courier/models/journey_segment_trigger_node.rbi +9 -1
  58. data/rbi/courier/models/journey_webhook_trigger_node.rbi +174 -0
  59. data/rbi/courier/models/journeys/run_list_params.rbi +111 -0
  60. data/rbi/courier/models/journeys/run_list_steps_params.rbi +40 -0
  61. data/rbi/courier/models/journeys/run_retrieve_params.rbi +40 -0
  62. data/rbi/courier/models/multiple_tokens.rbi +32 -4
  63. data/rbi/courier/models/user_profile.rbi +14 -3
  64. data/rbi/courier/models/users/topic_preference.rbi +33 -3
  65. data/rbi/courier/models.rbi +26 -2
  66. data/rbi/courier/resources/automations/runs.rbi +69 -0
  67. data/rbi/courier/resources/automations.rbi +5 -0
  68. data/rbi/courier/resources/journeys/runs.rbi +87 -0
  69. data/rbi/courier/resources/journeys.rbi +9 -0
  70. data/rbi/courier/resources/notifications.rbi +0 -16
  71. data/sig/courier/models/apn.rbs +11 -0
  72. data/sig/courier/models/automation_run_list_item.rbs +46 -0
  73. data/sig/courier/models/automation_run_list_response.rbs +24 -0
  74. data/sig/courier/models/automation_run_step.rbs +53 -0
  75. data/sig/courier/models/automation_run_steps_response.rbs +14 -0
  76. data/sig/courier/models/automations/run_list_params.rbs +65 -0
  77. data/sig/courier/models/automations/run_list_steps_params.rbs +22 -0
  78. data/sig/courier/models/journey_audience_trigger_node.rbs +66 -0
  79. data/sig/courier/models/journey_node.rbs +2 -0
  80. data/sig/courier/models/journey_run.rbs +53 -0
  81. data/sig/courier/models/journey_run_list_item.rbs +46 -0
  82. data/sig/courier/models/journey_run_list_response.rbs +34 -0
  83. data/sig/courier/models/journey_run_response.rbs +13 -0
  84. data/sig/courier/models/journey_run_step.rbs +53 -0
  85. data/sig/courier/models/journey_run_steps_response.rbs +14 -0
  86. data/sig/courier/models/journey_segment_trigger_node.rbs +2 -1
  87. data/sig/courier/models/journey_webhook_trigger_node.rbs +73 -0
  88. data/sig/courier/models/journeys/run_list_params.rbs +65 -0
  89. data/sig/courier/models/journeys/run_list_steps_params.rbs +25 -0
  90. data/sig/courier/models/journeys/run_retrieve_params.rbs +25 -0
  91. data/sig/courier/models/multiple_tokens.rbs +14 -4
  92. data/sig/courier/models/user_profile.rbs +4 -4
  93. data/sig/courier/models/users/topic_preference.rbs +17 -3
  94. data/sig/courier/models.rbs +26 -2
  95. data/sig/courier/resources/automations/runs.rbs +24 -0
  96. data/sig/courier/resources/automations.rbs +2 -0
  97. data/sig/courier/resources/journeys/runs.rbs +29 -0
  98. data/sig/courier/resources/journeys.rbs +2 -0
  99. data/sig/courier/resources/notifications.rbs +0 -5
  100. metadata +62 -5
  101. data/lib/courier/models/notification_duplicate_params.rb +0 -20
  102. data/rbi/courier/models/notification_duplicate_params.rbi +0 -38
  103. data/sig/courier/models/notification_duplicate_params.rbs +0 -20
@@ -0,0 +1,73 @@
1
+ module Courier
2
+ module Models
3
+ type journey_webhook_trigger_node =
4
+ {
5
+ event_source: String,
6
+ trigger_type: Courier::Models::JourneyWebhookTriggerNode::trigger_type,
7
+ type: Courier::Models::JourneyWebhookTriggerNode::type_,
8
+ id: String,
9
+ conditions: Courier::Models::journey_conditions_field,
10
+ event_id: String
11
+ }
12
+
13
+ class JourneyWebhookTriggerNode < Courier::Internal::Type::BaseModel
14
+ attr_accessor event_source: String
15
+
16
+ attr_accessor trigger_type: Courier::Models::JourneyWebhookTriggerNode::trigger_type
17
+
18
+ attr_accessor type: Courier::Models::JourneyWebhookTriggerNode::type_
19
+
20
+ attr_reader id: String?
21
+
22
+ def id=: (String) -> String
23
+
24
+ attr_reader conditions: Courier::Models::journey_conditions_field?
25
+
26
+ def conditions=: (
27
+ Courier::Models::journey_conditions_field
28
+ ) -> Courier::Models::journey_conditions_field
29
+
30
+ attr_reader event_id: String?
31
+
32
+ def event_id=: (String) -> String
33
+
34
+ def initialize: (
35
+ event_source: String,
36
+ trigger_type: Courier::Models::JourneyWebhookTriggerNode::trigger_type,
37
+ type: Courier::Models::JourneyWebhookTriggerNode::type_,
38
+ ?id: String,
39
+ ?conditions: Courier::Models::journey_conditions_field,
40
+ ?event_id: String
41
+ ) -> void
42
+
43
+ def to_hash: -> {
44
+ event_source: String,
45
+ trigger_type: Courier::Models::JourneyWebhookTriggerNode::trigger_type,
46
+ type: Courier::Models::JourneyWebhookTriggerNode::type_,
47
+ id: String,
48
+ conditions: Courier::Models::journey_conditions_field,
49
+ event_id: String
50
+ }
51
+
52
+ type trigger_type = :webhook
53
+
54
+ module TriggerType
55
+ extend Courier::Internal::Type::Enum
56
+
57
+ WEBHOOK: :webhook
58
+
59
+ def self?.values: -> ::Array[Courier::Models::JourneyWebhookTriggerNode::trigger_type]
60
+ end
61
+
62
+ type type_ = :trigger
63
+
64
+ module Type
65
+ extend Courier::Internal::Type::Enum
66
+
67
+ TRIGGER: :trigger
68
+
69
+ def self?.values: -> ::Array[Courier::Models::JourneyWebhookTriggerNode::type_]
70
+ end
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,65 @@
1
+ module Courier
2
+ module Models
3
+ module Journeys
4
+ type run_list_params =
5
+ {
6
+ cursor: String,
7
+ end_date: String,
8
+ limit: String,
9
+ start_date: String,
10
+ status: String,
11
+ template_id: String
12
+ }
13
+ & Courier::Internal::Type::request_parameters
14
+
15
+ class RunListParams < Courier::Internal::Type::BaseModel
16
+ extend Courier::Internal::Type::RequestParameters::Converter
17
+ include Courier::Internal::Type::RequestParameters
18
+
19
+ attr_reader cursor: String?
20
+
21
+ def cursor=: (String) -> String
22
+
23
+ attr_reader end_date: String?
24
+
25
+ def end_date=: (String) -> String
26
+
27
+ attr_reader limit: String?
28
+
29
+ def limit=: (String) -> String
30
+
31
+ attr_reader start_date: String?
32
+
33
+ def start_date=: (String) -> String
34
+
35
+ attr_reader status: String?
36
+
37
+ def status=: (String) -> String
38
+
39
+ attr_reader template_id: String?
40
+
41
+ def template_id=: (String) -> String
42
+
43
+ def initialize: (
44
+ ?cursor: String,
45
+ ?end_date: String,
46
+ ?limit: String,
47
+ ?start_date: String,
48
+ ?status: String,
49
+ ?template_id: String,
50
+ ?request_options: Courier::request_opts
51
+ ) -> void
52
+
53
+ def to_hash: -> {
54
+ cursor: String,
55
+ end_date: String,
56
+ limit: String,
57
+ start_date: String,
58
+ status: String,
59
+ template_id: String,
60
+ request_options: Courier::RequestOptions
61
+ }
62
+ end
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,25 @@
1
+ module Courier
2
+ module Models
3
+ module Journeys
4
+ type run_list_steps_params =
5
+ { run_id: String } & Courier::Internal::Type::request_parameters
6
+
7
+ class RunListStepsParams < Courier::Internal::Type::BaseModel
8
+ extend Courier::Internal::Type::RequestParameters::Converter
9
+ include Courier::Internal::Type::RequestParameters
10
+
11
+ attr_accessor run_id: String
12
+
13
+ def initialize: (
14
+ run_id: String,
15
+ ?request_options: Courier::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ run_id: String,
20
+ request_options: Courier::RequestOptions
21
+ }
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,25 @@
1
+ module Courier
2
+ module Models
3
+ module Journeys
4
+ type run_retrieve_params =
5
+ { run_id: String } & Courier::Internal::Type::request_parameters
6
+
7
+ class RunRetrieveParams < Courier::Internal::Type::BaseModel
8
+ extend Courier::Internal::Type::RequestParameters::Converter
9
+ include Courier::Internal::Type::RequestParameters
10
+
11
+ attr_accessor run_id: String
12
+
13
+ def initialize: (
14
+ run_id: String,
15
+ ?request_options: Courier::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ run_id: String,
20
+ request_options: Courier::RequestOptions
21
+ }
22
+ end
23
+ end
24
+ end
25
+ end
@@ -1,13 +1,23 @@
1
1
  module Courier
2
2
  module Models
3
- type multiple_tokens = { tokens: ::Array[Courier::Token] }
3
+ type multiple_tokens = { tokens: Courier::Models::MultipleTokens::tokens }
4
4
 
5
5
  class MultipleTokens < Courier::Internal::Type::BaseModel
6
- attr_accessor tokens: ::Array[Courier::Token]
6
+ attr_accessor tokens: Courier::Models::MultipleTokens::tokens
7
7
 
8
- def initialize: (tokens: ::Array[Courier::Token]) -> void
8
+ def initialize: (tokens: Courier::Models::MultipleTokens::tokens) -> void
9
9
 
10
- def to_hash: -> { tokens: ::Array[Courier::Token] }
10
+ def to_hash: -> { tokens: Courier::Models::MultipleTokens::tokens }
11
+
12
+ type tokens = String | ::Array[String]
13
+
14
+ module Tokens
15
+ extend Courier::Internal::Type::Union
16
+
17
+ def self?.variants: -> ::Array[Courier::Models::MultipleTokens::tokens]
18
+
19
+ StringArray: Courier::Internal::Type::Converter
20
+ end
11
21
  end
12
22
  end
13
23
  end
@@ -4,7 +4,7 @@ module Courier
4
4
  {
5
5
  address: Courier::UserProfile::Address?,
6
6
  airship: Courier::AirshipProfile?,
7
- apn: String?,
7
+ apn: Courier::Models::apn?,
8
8
  aws_sns: Courier::AwsSns?,
9
9
  birthdate: String?,
10
10
  custom: ::Hash[Symbol, top]?,
@@ -40,7 +40,7 @@ module Courier
40
40
 
41
41
  attr_accessor airship: Courier::AirshipProfile?
42
42
 
43
- attr_accessor apn: String?
43
+ attr_accessor apn: Courier::Models::apn?
44
44
 
45
45
  attr_accessor aws_sns: Courier::AwsSns?
46
46
 
@@ -101,7 +101,7 @@ module Courier
101
101
  def initialize: (
102
102
  ?address: Courier::UserProfile::Address?,
103
103
  ?airship: Courier::AirshipProfile?,
104
- ?apn: String?,
104
+ ?apn: Courier::Models::apn?,
105
105
  ?aws_sns: Courier::AwsSns?,
106
106
  ?birthdate: String?,
107
107
  ?custom: ::Hash[Symbol, top]?,
@@ -135,7 +135,7 @@ module Courier
135
135
  def to_hash: -> {
136
136
  address: Courier::UserProfile::Address?,
137
137
  airship: Courier::AirshipProfile?,
138
- apn: String?,
138
+ apn: Courier::Models::apn?,
139
139
  aws_sns: Courier::AwsSns?,
140
140
  birthdate: String?,
141
141
  custom: ::Hash[Symbol, top]?,
@@ -8,7 +8,9 @@ module Courier
8
8
  topic_id: String,
9
9
  topic_name: String,
10
10
  custom_routing: ::Array[Courier::Models::channel_classification]?,
11
- has_custom_routing: bool?
11
+ has_custom_routing: bool?,
12
+ section_id: String,
13
+ section_name: String
12
14
  }
13
15
 
14
16
  class TopicPreference < Courier::Internal::Type::BaseModel
@@ -24,13 +26,23 @@ module Courier
24
26
 
25
27
  attr_accessor has_custom_routing: bool?
26
28
 
29
+ attr_reader section_id: String?
30
+
31
+ def section_id=: (String) -> String
32
+
33
+ attr_reader section_name: String?
34
+
35
+ def section_name=: (String) -> String
36
+
27
37
  def initialize: (
28
38
  default_status: Courier::Models::preference_status,
29
39
  status: Courier::Models::preference_status,
30
40
  topic_id: String,
31
41
  topic_name: String,
32
42
  ?custom_routing: ::Array[Courier::Models::channel_classification]?,
33
- ?has_custom_routing: bool?
43
+ ?has_custom_routing: bool?,
44
+ ?section_id: String,
45
+ ?section_name: String
34
46
  ) -> void
35
47
 
36
48
  def to_hash: -> {
@@ -39,7 +51,9 @@ module Courier
39
51
  topic_id: String,
40
52
  topic_name: String,
41
53
  custom_routing: ::Array[Courier::Models::channel_classification]?,
42
- has_custom_routing: bool?
54
+ has_custom_routing: bool?,
55
+ section_id: String,
56
+ section_name: String
43
57
  }
44
58
  end
45
59
  end
@@ -5,6 +5,8 @@ module Courier
5
5
 
6
6
  module Alignment = Courier::Models::Alignment
7
7
 
8
+ module Apn = Courier::Models::Apn
9
+
8
10
  class AssociatedNotificationListResponse = Courier::Models::AssociatedNotificationListResponse
9
11
 
10
12
  class Audience = Courier::Models::Audience
@@ -37,6 +39,14 @@ module Courier
37
39
 
38
40
  class AutomationListParams = Courier::Models::AutomationListParams
39
41
 
42
+ class AutomationRunListItem = Courier::Models::AutomationRunListItem
43
+
44
+ class AutomationRunListResponse = Courier::Models::AutomationRunListResponse
45
+
46
+ class AutomationRunStep = Courier::Models::AutomationRunStep
47
+
48
+ class AutomationRunStepsResponse = Courier::Models::AutomationRunStepsResponse
49
+
40
50
  module Automations = Courier::Models::Automations
41
51
 
42
52
  class AutomationTemplate = Courier::Models::AutomationTemplate
@@ -203,6 +213,8 @@ module Courier
203
213
 
204
214
  class JourneyArchiveParams = Courier::Models::JourneyArchiveParams
205
215
 
216
+ class JourneyAudienceTriggerNode = Courier::Models::JourneyAudienceTriggerNode
217
+
206
218
  class JourneyCancelParams = Courier::Models::JourneyCancelParams
207
219
 
208
220
  JourneyConditionAtom: Courier::Internal::Type::Converter
@@ -249,6 +261,18 @@ module Courier
249
261
 
250
262
  class JourneyRetrieveParams = Courier::Models::JourneyRetrieveParams
251
263
 
264
+ class JourneyRun = Courier::Models::JourneyRun
265
+
266
+ class JourneyRunListItem = Courier::Models::JourneyRunListItem
267
+
268
+ class JourneyRunListResponse = Courier::Models::JourneyRunListResponse
269
+
270
+ class JourneyRunResponse = Courier::Models::JourneyRunResponse
271
+
272
+ class JourneyRunStep = Courier::Models::JourneyRunStep
273
+
274
+ class JourneyRunStepsResponse = Courier::Models::JourneyRunStepsResponse
275
+
252
276
  module Journeys = Courier::Models::Journeys
253
277
 
254
278
  class JourneySegmentTriggerNode = Courier::Models::JourneySegmentTriggerNode
@@ -283,6 +307,8 @@ module Courier
283
307
 
284
308
  class JourneyVersionsListResponse = Courier::Models::JourneyVersionsListResponse
285
309
 
310
+ class JourneyWebhookTriggerNode = Courier::Models::JourneyWebhookTriggerNode
311
+
286
312
  class ListDeleteParams = Courier::Models::ListDeleteParams
287
313
 
288
314
  class ListFilter = Courier::Models::ListFilter
@@ -349,8 +375,6 @@ module Courier
349
375
 
350
376
  class NotificationCreateParams = Courier::Models::NotificationCreateParams
351
377
 
352
- class NotificationDuplicateParams = Courier::Models::NotificationDuplicateParams
353
-
354
378
  class NotificationElementPutRequest = Courier::Models::NotificationElementPutRequest
355
379
 
356
380
  class NotificationGetContent = Courier::Models::NotificationGetContent
@@ -0,0 +1,24 @@
1
+ module Courier
2
+ module Resources
3
+ class Automations
4
+ class Runs
5
+ def list: (
6
+ ?cursor: String,
7
+ ?end_date: String,
8
+ ?limit: String,
9
+ ?start_date: String,
10
+ ?status: String,
11
+ ?template_id: String,
12
+ ?request_options: Courier::request_opts
13
+ ) -> Courier::AutomationRunListResponse
14
+
15
+ def list_steps: (
16
+ String id,
17
+ ?request_options: Courier::request_opts
18
+ ) -> Courier::AutomationRunStepsResponse
19
+
20
+ def initialize: (client: Courier::Client) -> void
21
+ end
22
+ end
23
+ end
24
+ end
@@ -3,6 +3,8 @@ module Courier
3
3
  class Automations
4
4
  attr_reader invoke: Courier::Resources::Automations::Invoke
5
5
 
6
+ attr_reader runs: Courier::Resources::Automations::Runs
7
+
6
8
  def list: (
7
9
  ?cursor: String,
8
10
  ?version: Courier::Models::AutomationListParams::version,
@@ -0,0 +1,29 @@
1
+ module Courier
2
+ module Resources
3
+ class Journeys
4
+ class Runs
5
+ def retrieve: (
6
+ String run_id,
7
+ ?request_options: Courier::request_opts
8
+ ) -> Courier::JourneyRunResponse
9
+
10
+ def list: (
11
+ ?cursor: String,
12
+ ?end_date: String,
13
+ ?limit: String,
14
+ ?start_date: String,
15
+ ?status: String,
16
+ ?template_id: String,
17
+ ?request_options: Courier::request_opts
18
+ ) -> Courier::JourneyRunListResponse
19
+
20
+ def list_steps: (
21
+ String run_id,
22
+ ?request_options: Courier::request_opts
23
+ ) -> Courier::JourneyRunStepsResponse
24
+
25
+ def initialize: (client: Courier::Client) -> void
26
+ end
27
+ end
28
+ end
29
+ end
@@ -3,6 +3,8 @@ module Courier
3
3
  class Journeys
4
4
  attr_reader templates: Courier::Resources::Journeys::Templates
5
5
 
6
+ attr_reader runs: Courier::Resources::Journeys::Runs
7
+
6
8
  def create: (
7
9
  name: String,
8
10
  nodes: ::Array[Courier::Models::journey_node],
@@ -26,11 +26,6 @@ module Courier
26
26
 
27
27
  def archive: (String id, ?request_options: Courier::request_opts) -> nil
28
28
 
29
- def duplicate: (
30
- String id,
31
- ?request_options: Courier::request_opts
32
- ) -> Courier::NotificationTemplateResponse
33
-
34
29
  def list_versions: (
35
30
  String id,
36
31
  ?cursor: String,