trycourier 4.20.0 → 4.21.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 +8 -0
- data/lib/courier/client.rb +0 -4
- data/lib/courier/models.rb +0 -14
- data/lib/courier/version.rb +1 -1
- data/lib/courier.rb +0 -11
- data/rbi/courier/client.rbi +0 -3
- data/rbi/courier/models.rbi +0 -14
- data/sig/courier/client.rbs +0 -2
- data/sig/courier/models.rbs +0 -14
- metadata +2 -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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f4dccb5834ee91963f2ed28cf943aebb50d899bf774a84ed87189fe523b1eeba
|
|
4
|
+
data.tar.gz: 8630a527df2d788a325a9643a76aa4d8d26258c20e77ec9d2b52b939374b4f36
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a3ae8f118cc4b01a50bd327fb2cd17b7790aa5863fff758c0a012c83273597a89a877f8ef307cec1820556ef808b65f7e6ee3206bbcc2a2be8b06516aad32daf
|
|
7
|
+
data.tar.gz: 0544e5259f039217d1666a2272926d9bca77faa8896012f50d18bd0d042b52408384af662a8f5a1df43b4d25b94f54429babf438d5e96fd2a50d40615609a906
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 4.21.0 (2026-07-23)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v4.20.0...v4.21.0](https://github.com/trycourier/courier-ruby/compare/v4.20.0...v4.21.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Remove /bulk endpoints from api-spec (C-19507) ([#171](https://github.com/trycourier/courier-ruby/issues/171)) ([e10d767](https://github.com/trycourier/courier-ruby/commit/e10d767174c28e0ae756041d7d2f1f78f2c72241))
|
|
10
|
+
|
|
3
11
|
## 4.20.0 (2026-07-20)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v4.19.2...v4.20.0](https://github.com/trycourier/courier-ruby/compare/v4.19.2...v4.20.0)
|
data/lib/courier/client.rb
CHANGED
|
@@ -42,9 +42,6 @@ module Courier
|
|
|
42
42
|
# @return [Courier::Resources::Brands]
|
|
43
43
|
attr_reader :brands
|
|
44
44
|
|
|
45
|
-
# @return [Courier::Resources::Bulk]
|
|
46
|
-
attr_reader :bulk
|
|
47
|
-
|
|
48
45
|
# @return [Courier::Resources::Digests]
|
|
49
46
|
attr_reader :digests
|
|
50
47
|
|
|
@@ -150,7 +147,6 @@ module Courier
|
|
|
150
147
|
@automations = Courier::Resources::Automations.new(client: self)
|
|
151
148
|
@journeys = Courier::Resources::Journeys.new(client: self)
|
|
152
149
|
@brands = Courier::Resources::Brands.new(client: self)
|
|
153
|
-
@bulk = Courier::Resources::Bulk.new(client: self)
|
|
154
150
|
@digests = Courier::Resources::Digests.new(client: self)
|
|
155
151
|
@inbound = Courier::Resources::Inbound.new(client: self)
|
|
156
152
|
@lists = Courier::Resources::Lists.new(client: self)
|
data/lib/courier/models.rb
CHANGED
|
@@ -113,16 +113,6 @@ module Courier
|
|
|
113
113
|
|
|
114
114
|
BrandUpdateParams = Courier::Models::BrandUpdateParams
|
|
115
115
|
|
|
116
|
-
BulkAddUsersParams = Courier::Models::BulkAddUsersParams
|
|
117
|
-
|
|
118
|
-
BulkCreateJobParams = Courier::Models::BulkCreateJobParams
|
|
119
|
-
|
|
120
|
-
BulkListUsersParams = Courier::Models::BulkListUsersParams
|
|
121
|
-
|
|
122
|
-
BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
|
|
123
|
-
|
|
124
|
-
BulkRunJobParams = Courier::Models::BulkRunJobParams
|
|
125
|
-
|
|
126
116
|
CancelJourneyRequest = Courier::Models::CancelJourneyRequest
|
|
127
117
|
|
|
128
118
|
CancelJourneyResponse = Courier::Models::CancelJourneyResponse
|
|
@@ -193,10 +183,6 @@ module Courier
|
|
|
193
183
|
|
|
194
184
|
Icons = Courier::Models::Icons
|
|
195
185
|
|
|
196
|
-
InboundBulkMessage = Courier::Models::InboundBulkMessage
|
|
197
|
-
|
|
198
|
-
InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
|
|
199
|
-
|
|
200
186
|
InboundTrackEventParams = Courier::Models::InboundTrackEventParams
|
|
201
187
|
|
|
202
188
|
Intercom = Courier::Models::Intercom
|
data/lib/courier/version.rb
CHANGED
data/lib/courier.rb
CHANGED
|
@@ -54,7 +54,6 @@ require_relative "courier/internal/transport/pooled_net_requester"
|
|
|
54
54
|
require_relative "courier/client"
|
|
55
55
|
require_relative "courier/models/elemental_base_node"
|
|
56
56
|
require_relative "courier/models/brand_template"
|
|
57
|
-
require_relative "courier/models/inbound_bulk_message_user"
|
|
58
57
|
require_relative "courier/models/base_check"
|
|
59
58
|
require_relative "courier/models/subscription_topic_new"
|
|
60
59
|
require_relative "courier/models/elemental_channel_node"
|
|
@@ -125,14 +124,6 @@ require_relative "courier/models/brand_settings_in_app"
|
|
|
125
124
|
require_relative "courier/models/brand_snippet"
|
|
126
125
|
require_relative "courier/models/brand_snippets"
|
|
127
126
|
require_relative "courier/models/brand_update_params"
|
|
128
|
-
require_relative "courier/models/bulk_add_users_params"
|
|
129
|
-
require_relative "courier/models/bulk_create_job_params"
|
|
130
|
-
require_relative "courier/models/bulk_create_job_response"
|
|
131
|
-
require_relative "courier/models/bulk_list_users_params"
|
|
132
|
-
require_relative "courier/models/bulk_list_users_response"
|
|
133
|
-
require_relative "courier/models/bulk_retrieve_job_params"
|
|
134
|
-
require_relative "courier/models/bulk_retrieve_job_response"
|
|
135
|
-
require_relative "courier/models/bulk_run_job_params"
|
|
136
127
|
require_relative "courier/models/cancel_journey_response"
|
|
137
128
|
require_relative "courier/models/channel"
|
|
138
129
|
require_relative "courier/models/channel_classification"
|
|
@@ -165,7 +156,6 @@ require_relative "courier/models/email_header"
|
|
|
165
156
|
require_relative "courier/models/expo"
|
|
166
157
|
require_relative "courier/models/filter_config"
|
|
167
158
|
require_relative "courier/models/icons"
|
|
168
|
-
require_relative "courier/models/inbound_bulk_message"
|
|
169
159
|
require_relative "courier/models/inbound_track_event_params"
|
|
170
160
|
require_relative "courier/models/inbound_track_event_response"
|
|
171
161
|
require_relative "courier/models/intercom"
|
|
@@ -431,7 +421,6 @@ require_relative "courier/resources/auth"
|
|
|
431
421
|
require_relative "courier/resources/automations"
|
|
432
422
|
require_relative "courier/resources/automations/invoke"
|
|
433
423
|
require_relative "courier/resources/brands"
|
|
434
|
-
require_relative "courier/resources/bulk"
|
|
435
424
|
require_relative "courier/resources/digests"
|
|
436
425
|
require_relative "courier/resources/digests/schedules"
|
|
437
426
|
require_relative "courier/resources/inbound"
|
data/rbi/courier/client.rbi
CHANGED
data/rbi/courier/models.rbi
CHANGED
|
@@ -77,16 +77,6 @@ module Courier
|
|
|
77
77
|
|
|
78
78
|
BrandUpdateParams = Courier::Models::BrandUpdateParams
|
|
79
79
|
|
|
80
|
-
BulkAddUsersParams = Courier::Models::BulkAddUsersParams
|
|
81
|
-
|
|
82
|
-
BulkCreateJobParams = Courier::Models::BulkCreateJobParams
|
|
83
|
-
|
|
84
|
-
BulkListUsersParams = Courier::Models::BulkListUsersParams
|
|
85
|
-
|
|
86
|
-
BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
|
|
87
|
-
|
|
88
|
-
BulkRunJobParams = Courier::Models::BulkRunJobParams
|
|
89
|
-
|
|
90
80
|
CancelJourneyRequest = Courier::Models::CancelJourneyRequest
|
|
91
81
|
|
|
92
82
|
CancelJourneyResponse = Courier::Models::CancelJourneyResponse
|
|
@@ -157,10 +147,6 @@ module Courier
|
|
|
157
147
|
|
|
158
148
|
Icons = Courier::Models::Icons
|
|
159
149
|
|
|
160
|
-
InboundBulkMessage = Courier::Models::InboundBulkMessage
|
|
161
|
-
|
|
162
|
-
InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
|
|
163
|
-
|
|
164
150
|
InboundTrackEventParams = Courier::Models::InboundTrackEventParams
|
|
165
151
|
|
|
166
152
|
Intercom = Courier::Models::Intercom
|
data/sig/courier/client.rbs
CHANGED
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,10 +143,6 @@ 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
|
|
|
162
148
|
class Intercom = Courier::Models::Intercom
|
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.21.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-23 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,8 +149,6 @@ 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
|
|
164
154
|
- lib/courier/models/intercom.rb
|
|
@@ -448,7 +438,6 @@ files:
|
|
|
448
438
|
- lib/courier/resources/automations.rb
|
|
449
439
|
- lib/courier/resources/automations/invoke.rb
|
|
450
440
|
- lib/courier/resources/brands.rb
|
|
451
|
-
- lib/courier/resources/bulk.rb
|
|
452
441
|
- lib/courier/resources/digests.rb
|
|
453
442
|
- lib/courier/resources/digests/schedules.rb
|
|
454
443
|
- lib/courier/resources/inbound.rb
|
|
@@ -543,14 +532,6 @@ files:
|
|
|
543
532
|
- rbi/courier/models/brand_snippets.rbi
|
|
544
533
|
- rbi/courier/models/brand_template.rbi
|
|
545
534
|
- 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
535
|
- rbi/courier/models/cancel_journey_request.rbi
|
|
555
536
|
- rbi/courier/models/cancel_journey_response.rbi
|
|
556
537
|
- rbi/courier/models/channel.rbi
|
|
@@ -587,8 +568,6 @@ files:
|
|
|
587
568
|
- rbi/courier/models/expo.rbi
|
|
588
569
|
- rbi/courier/models/filter_config.rbi
|
|
589
570
|
- rbi/courier/models/icons.rbi
|
|
590
|
-
- rbi/courier/models/inbound_bulk_message.rbi
|
|
591
|
-
- rbi/courier/models/inbound_bulk_message_user.rbi
|
|
592
571
|
- rbi/courier/models/inbound_track_event_params.rbi
|
|
593
572
|
- rbi/courier/models/inbound_track_event_response.rbi
|
|
594
573
|
- rbi/courier/models/intercom.rbi
|
|
@@ -878,7 +857,6 @@ files:
|
|
|
878
857
|
- rbi/courier/resources/automations.rbi
|
|
879
858
|
- rbi/courier/resources/automations/invoke.rbi
|
|
880
859
|
- rbi/courier/resources/brands.rbi
|
|
881
|
-
- rbi/courier/resources/bulk.rbi
|
|
882
860
|
- rbi/courier/resources/digests.rbi
|
|
883
861
|
- rbi/courier/resources/digests/schedules.rbi
|
|
884
862
|
- rbi/courier/resources/inbound.rbi
|
|
@@ -972,14 +950,6 @@ files:
|
|
|
972
950
|
- sig/courier/models/brand_snippets.rbs
|
|
973
951
|
- sig/courier/models/brand_template.rbs
|
|
974
952
|
- 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
953
|
- sig/courier/models/cancel_journey_request.rbs
|
|
984
954
|
- sig/courier/models/cancel_journey_response.rbs
|
|
985
955
|
- sig/courier/models/channel.rbs
|
|
@@ -1016,8 +986,6 @@ files:
|
|
|
1016
986
|
- sig/courier/models/expo.rbs
|
|
1017
987
|
- sig/courier/models/filter_config.rbs
|
|
1018
988
|
- sig/courier/models/icons.rbs
|
|
1019
|
-
- sig/courier/models/inbound_bulk_message.rbs
|
|
1020
|
-
- sig/courier/models/inbound_bulk_message_user.rbs
|
|
1021
989
|
- sig/courier/models/inbound_track_event_params.rbs
|
|
1022
990
|
- sig/courier/models/inbound_track_event_response.rbs
|
|
1023
991
|
- sig/courier/models/intercom.rbs
|
|
@@ -1307,7 +1275,6 @@ files:
|
|
|
1307
1275
|
- sig/courier/resources/automations.rbs
|
|
1308
1276
|
- sig/courier/resources/automations/invoke.rbs
|
|
1309
1277
|
- sig/courier/resources/brands.rbs
|
|
1310
|
-
- sig/courier/resources/bulk.rbs
|
|
1311
1278
|
- sig/courier/resources/digests.rbs
|
|
1312
1279
|
- sig/courier/resources/digests/schedules.rbs
|
|
1313
1280
|
- sig/courier/resources/inbound.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
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#retrieve_job
|
|
6
|
-
class BulkRetrieveJobResponse < Courier::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute job
|
|
8
|
-
#
|
|
9
|
-
# @return [Courier::Models::BulkRetrieveJobResponse::Job]
|
|
10
|
-
required :job, -> { Courier::Models::BulkRetrieveJobResponse::Job }
|
|
11
|
-
|
|
12
|
-
# @!method initialize(job:)
|
|
13
|
-
# @param job [Courier::Models::BulkRetrieveJobResponse::Job]
|
|
14
|
-
|
|
15
|
-
# @see Courier::Models::BulkRetrieveJobResponse#job
|
|
16
|
-
class Job < Courier::Internal::Type::BaseModel
|
|
17
|
-
# @!attribute definition
|
|
18
|
-
# Bulk message definition. Supports two formats:
|
|
19
|
-
#
|
|
20
|
-
# - V1 format: Requires `event` field (event ID or notification ID)
|
|
21
|
-
# - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
|
|
22
|
-
# content) in addition to `event`
|
|
23
|
-
#
|
|
24
|
-
# @return [Courier::Models::InboundBulkMessage]
|
|
25
|
-
required :definition, -> { Courier::InboundBulkMessage }
|
|
26
|
-
|
|
27
|
-
# @!attribute enqueued
|
|
28
|
-
#
|
|
29
|
-
# @return [Integer]
|
|
30
|
-
required :enqueued, Integer
|
|
31
|
-
|
|
32
|
-
# @!attribute failures
|
|
33
|
-
#
|
|
34
|
-
# @return [Integer]
|
|
35
|
-
required :failures, Integer
|
|
36
|
-
|
|
37
|
-
# @!attribute received
|
|
38
|
-
#
|
|
39
|
-
# @return [Integer]
|
|
40
|
-
required :received, Integer
|
|
41
|
-
|
|
42
|
-
# @!attribute status
|
|
43
|
-
#
|
|
44
|
-
# @return [Symbol, Courier::Models::BulkRetrieveJobResponse::Job::Status]
|
|
45
|
-
required :status, enum: -> { Courier::Models::BulkRetrieveJobResponse::Job::Status }
|
|
46
|
-
|
|
47
|
-
# @!method initialize(definition:, enqueued:, failures:, received:, status:)
|
|
48
|
-
# Some parameter documentations has been truncated, see
|
|
49
|
-
# {Courier::Models::BulkRetrieveJobResponse::Job} for more details.
|
|
50
|
-
#
|
|
51
|
-
# @param definition [Courier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
|
|
52
|
-
#
|
|
53
|
-
# @param enqueued [Integer]
|
|
54
|
-
#
|
|
55
|
-
# @param failures [Integer]
|
|
56
|
-
#
|
|
57
|
-
# @param received [Integer]
|
|
58
|
-
#
|
|
59
|
-
# @param status [Symbol, Courier::Models::BulkRetrieveJobResponse::Job::Status]
|
|
60
|
-
|
|
61
|
-
# @see Courier::Models::BulkRetrieveJobResponse::Job#status
|
|
62
|
-
module Status
|
|
63
|
-
extend Courier::Internal::Type::Enum
|
|
64
|
-
|
|
65
|
-
CREATED = :CREATED
|
|
66
|
-
PROCESSING = :PROCESSING
|
|
67
|
-
COMPLETED = :COMPLETED
|
|
68
|
-
ERROR = :ERROR
|
|
69
|
-
|
|
70
|
-
# @!method self.values
|
|
71
|
-
# @return [Array<Symbol>]
|
|
72
|
-
end
|
|
73
|
-
end
|
|
74
|
-
end
|
|
75
|
-
end
|
|
76
|
-
end
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Courier
|
|
4
|
-
module Models
|
|
5
|
-
# @see Courier::Resources::Bulk#run_job
|
|
6
|
-
class BulkRunJobParams < 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
|