trycourier 3.4.0.pre.alpha9 → 4.0.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 (15) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +1 -1
  4. data/lib/trycourier/models/recipient.rb +9 -1
  5. data/lib/trycourier/models/user_recipient.rb +9 -1
  6. data/lib/trycourier/models/users/user_token.rb +8 -8
  7. data/lib/trycourier/resources/users/tokens.rb +3 -3
  8. data/lib/trycourier/version.rb +1 -1
  9. data/rbi/trycourier/models/recipient.rbi +8 -0
  10. data/rbi/trycourier/models/user_recipient.rbi +8 -0
  11. data/rbi/trycourier/models/users/user_token.rbi +8 -8
  12. data/rbi/trycourier/resources/users/tokens.rbi +3 -3
  13. data/sig/trycourier/models/recipient.rbs +5 -0
  14. data/sig/trycourier/models/user_recipient.rbs +5 -0
  15. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f6b262d22f8b3baf507f1ec2099fa7e251bcd3af0fa826e18bdfe293082a3c04
4
- data.tar.gz: f5af66fa239ded8e0661050ed18ef5ef7c7064e1acb39a414f78cc1bbf9968de
3
+ metadata.gz: ea2404c89e513c6edbd7266b26273fc582d30ba791ad01c6302c69fa617d9056
4
+ data.tar.gz: 779e524afaab09c6ce8ad61f16f7df393e43c37700e115e4e1ea09f68c494a6e
5
5
  SHA512:
6
- metadata.gz: 5157e487e5316da404b2932baa5750d0e8d2fb59cb55873dae6a9fb140d26b6c953a9e32dc06677aff7a32118a4b721dc162d3e7f87d66f4aa45d562e7a42964
7
- data.tar.gz: 74274de5d022bf22f4a878b15c537a08640c10d04da4b6c1dfd76125aded4becb5e9705966bf9ac95641672055c97966c15a403f43b511c890ed6f149e062580
6
+ metadata.gz: 2a7b4546cb947275415973788acb30e65c80921f3d188f2d0ecd7040236d79bab868f7fb27376893632196cb4144c78e86ab5bbc25284c2efd764e99aa6ec333
7
+ data.tar.gz: 191e3e880ed1fe9a6fc2c402f1f0afef8193fe60f0a1a8f68df3247ff83aafc8210bfa0a8daf49715e8544f4d9dedd47c058615fec3eca59cb83d35c101653f3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## 4.0.0 (2025-11-12)
4
+
5
+ Full Changelog: [v3.4.0-alpha9...v4.0.0](https://github.com/trycourier/courier-ruby/compare/v3.4.0-alpha9...v4.0.0)
6
+
7
+ ### Features
8
+
9
+ * Spec Comment Change ([b567eac](https://github.com/trycourier/courier-ruby/commit/b567eac8556068aa9fea18a1882330e741dda479))
10
+ * Token Prop Description Change ([cb884a1](https://github.com/trycourier/courier-ruby/commit/cb884a1830d2abaf81db27b14c60725c5792f0fa))
11
+
12
+
13
+ ### Chores
14
+
15
+ * update SDK settings ([3ad8ff3](https://github.com/trycourier/courier-ruby/commit/3ad8ff378645ccd3ecdf5a3b64ccfd8694901c67))
16
+
3
17
  ## 3.4.0-alpha9 (2025-11-07)
4
18
 
5
19
  Full Changelog: [v3.4.0-alpha8...v3.4.0-alpha9](https://github.com/trycourier/courier-ruby/compare/v3.4.0-alpha8...v3.4.0-alpha9)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "trycourier", "~> 3.4.0.pre.alpha9"
20
+ gem "trycourier", "~> 4.0.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
data/lib/trycourier/models/recipient.rb CHANGED
@@ -26,6 +26,12 @@ module Trycourier
26
26
  # @return [String, nil]
27
27
  optional :email, String, nil?: true
28
28
 
29
+ # @!attribute list_id
30
+ # The id of the list to send the message to.
31
+ #
32
+ # @return [String, nil]
33
+ optional :list_id, String, nil?: true
34
+
29
35
  # @!attribute locale
30
36
  # The user's preferred ISO 639-1 language code.
31
37
  #
@@ -56,7 +62,7 @@ module Trycourier
56
62
  # @return [String, nil]
57
63
  optional :user_id, String, nil?: true
58
64
 
59
- # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
65
+ # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, list_id: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
60
66
  # Some parameter documentations has been truncated, see
61
67
  # {Trycourier::Models::Recipient} for more details.
62
68
  #
@@ -68,6 +74,8 @@ module Trycourier
68
74
  #
69
75
  # @param email [String, nil] The user's email address.
70
76
  #
77
+ # @param list_id [String, nil] The id of the list to send the message to.
78
+ #
71
79
  # @param locale [String, nil] The user's preferred ISO 639-1 language code.
72
80
  #
73
81
  # @param phone_number [String, nil] The user's phone number.
data/lib/trycourier/models/user_recipient.rb CHANGED
@@ -26,6 +26,12 @@ module Trycourier
26
26
  # @return [String, nil]
27
27
  optional :email, String, nil?: true
28
28
 
29
+ # @!attribute list_id
30
+ # The id of the list to send the message to.
31
+ #
32
+ # @return [String, nil]
33
+ optional :list_id, String, nil?: true
34
+
29
35
  # @!attribute locale
30
36
  # The user's preferred ISO 639-1 language code.
31
37
  #
@@ -56,7 +62,7 @@ module Trycourier
56
62
  # @return [String, nil]
57
63
  optional :user_id, String, nil?: true
58
64
 
59
- # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
65
+ # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, list_id: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
60
66
  # Some parameter documentations has been truncated, see
61
67
  # {Trycourier::Models::UserRecipient} for more details.
62
68
  #
@@ -68,6 +74,8 @@ module Trycourier
68
74
  #
69
75
  # @param email [String, nil] The user's email address.
70
76
  #
77
+ # @param list_id [String, nil] The id of the list to send the message to.
78
+ #
71
79
  # @param locale [String, nil] The user's preferred ISO 639-1 language code.
72
80
  #
73
81
  # @param phone_number [String, nil] The user's phone number.
data/lib/trycourier/models/users/user_token.rb CHANGED
@@ -16,7 +16,7 @@ module Trycourier
16
16
  required :provider_key, enum: -> { Trycourier::Users::UserToken::ProviderKey }
17
17
 
18
18
  # @!attribute device
19
- # Information about the device the token is associated with.
19
+ # Information about the device the token came from.
20
20
  #
21
21
  # @return [Trycourier::Models::Users::UserToken::Device, nil]
22
22
  optional :device, -> { Trycourier::Users::UserToken::Device }, nil?: true
@@ -29,13 +29,13 @@ module Trycourier
29
29
  optional :expiry_date, union: -> { Trycourier::Users::UserToken::ExpiryDate }, nil?: true
30
30
 
31
31
  # @!attribute properties
32
- # Properties sent to the provider along with the token
32
+ # Properties about the token.
33
33
  #
34
34
  # @return [Object, nil]
35
35
  optional :properties, Trycourier::Internal::Type::Unknown
36
36
 
37
37
  # @!attribute tracking
38
- # Information about the device the token is associated with.
38
+ # Tracking information about the device the token came from.
39
39
  #
40
40
  # @return [Trycourier::Models::Users::UserToken::Tracking, nil]
41
41
  optional :tracking, -> { Trycourier::Users::UserToken::Tracking }, nil?: true
@@ -48,13 +48,13 @@ module Trycourier
48
48
  #
49
49
  # @param provider_key [Symbol, Trycourier::Models::Users::UserToken::ProviderKey]
50
50
  #
51
- # @param device [Trycourier::Models::Users::UserToken::Device, nil] Information about the device the token is associated with.
51
+ # @param device [Trycourier::Models::Users::UserToken::Device, nil] Information about the device the token came from.
52
52
  #
53
53
  # @param expiry_date [String, Boolean, nil] ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
54
54
  #
55
- # @param properties [Object] Properties sent to the provider along with the token
55
+ # @param properties [Object] Properties about the token.
56
56
  #
57
- # @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Information about the device the token is associated with.
57
+ # @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Tracking information about the device the token came from.
58
58
 
59
59
  # @see Trycourier::Models::Users::UserToken#provider_key
60
60
  module ProviderKey
@@ -108,7 +108,7 @@ module Trycourier
108
108
  optional :platform, String, nil?: true
109
109
 
110
110
  # @!method initialize(ad_id: nil, app_id: nil, device_id: nil, manufacturer: nil, model: nil, platform: nil)
111
- # Information about the device the token is associated with.
111
+ # Information about the device the token came from.
112
112
  #
113
113
  # @param ad_id [String, nil] Id of the advertising identifier
114
114
  #
@@ -165,7 +165,7 @@ module Trycourier
165
165
  optional :os_version, String, nil?: true
166
166
 
167
167
  # @!method initialize(ip: nil, lat: nil, long: nil, os_version: nil)
168
- # Information about the device the token is associated with.
168
+ # Tracking information about the device the token came from.
169
169
  #
170
170
  # @param ip [String, nil] The IP address of the device
171
171
  #
data/lib/trycourier/resources/users/tokens.rb CHANGED
@@ -143,13 +143,13 @@ module Trycourier
143
143
  #
144
144
  # @param provider_key [Symbol, Trycourier::Models::Users::UserToken::ProviderKey] Body param:
145
145
  #
146
- # @param device [Trycourier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token is associated with.
146
+ # @param device [Trycourier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token came from.
147
147
  #
148
148
  # @param expiry_date [String, Boolean, nil] Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set
149
149
  #
150
- # @param properties [Object] Body param: Properties sent to the provider along with the token
150
+ # @param properties [Object] Body param: Properties about the token.
151
151
  #
152
- # @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Body param: Information about the device the token is associated with.
152
+ # @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Body param: Tracking information about the device the token came from.
153
153
  #
154
154
  # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
155
155
  #
data/lib/trycourier/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Trycourier
4
- VERSION = "3.4.0.pre.alpha9"
4
+ VERSION = "4.0.0"
5
5
  end
data/rbi/trycourier/models/recipient.rbi CHANGED
@@ -28,6 +28,10 @@ module Trycourier
28
28
  sig { returns(T.nilable(String)) }
29
29
  attr_accessor :email
30
30
 
31
+ # The id of the list to send the message to.
32
+ sig { returns(T.nilable(String)) }
33
+ attr_accessor :list_id
34
+
31
35
  # The user's preferred ISO 639-1 language code.
32
36
  sig { returns(T.nilable(String)) }
33
37
  attr_accessor :locale
@@ -61,6 +65,7 @@ module Trycourier
61
65
  context: T.nilable(Trycourier::MessageContext::OrHash),
62
66
  data: T.nilable(T::Hash[Symbol, T.anything]),
63
67
  email: T.nilable(String),
68
+ list_id: T.nilable(String),
64
69
  locale: T.nilable(String),
65
70
  phone_number: T.nilable(String),
66
71
  preferences: T.nilable(Trycourier::Recipient::Preferences::OrHash),
@@ -76,6 +81,8 @@ module Trycourier
76
81
  data: nil,
77
82
  # The user's email address.
78
83
  email: nil,
84
+ # The id of the list to send the message to.
85
+ list_id: nil,
79
86
  # The user's preferred ISO 639-1 language code.
80
87
  locale: nil,
81
88
  # The user's phone number.
@@ -96,6 +103,7 @@ module Trycourier
96
103
  context: T.nilable(Trycourier::MessageContext),
97
104
  data: T.nilable(T::Hash[Symbol, T.anything]),
98
105
  email: T.nilable(String),
106
+ list_id: T.nilable(String),
99
107
  locale: T.nilable(String),
100
108
  phone_number: T.nilable(String),
101
109
  preferences: T.nilable(Trycourier::Recipient::Preferences),
data/rbi/trycourier/models/user_recipient.rbi CHANGED
@@ -28,6 +28,10 @@ module Trycourier
28
28
  sig { returns(T.nilable(String)) }
29
29
  attr_accessor :email
30
30
 
31
+ # The id of the list to send the message to.
32
+ sig { returns(T.nilable(String)) }
33
+ attr_accessor :list_id
34
+
31
35
  # The user's preferred ISO 639-1 language code.
32
36
  sig { returns(T.nilable(String)) }
33
37
  attr_accessor :locale
@@ -61,6 +65,7 @@ module Trycourier
61
65
  context: T.nilable(Trycourier::MessageContext::OrHash),
62
66
  data: T.nilable(T::Hash[Symbol, T.anything]),
63
67
  email: T.nilable(String),
68
+ list_id: T.nilable(String),
64
69
  locale: T.nilable(String),
65
70
  phone_number: T.nilable(String),
66
71
  preferences:
@@ -77,6 +82,8 @@ module Trycourier
77
82
  data: nil,
78
83
  # The user's email address.
79
84
  email: nil,
85
+ # The id of the list to send the message to.
86
+ list_id: nil,
80
87
  # The user's preferred ISO 639-1 language code.
81
88
  locale: nil,
82
89
  # The user's phone number.
@@ -97,6 +104,7 @@ module Trycourier
97
104
  context: T.nilable(Trycourier::MessageContext),
98
105
  data: T.nilable(T::Hash[Symbol, T.anything]),
99
106
  email: T.nilable(String),
107
+ list_id: T.nilable(String),
100
108
  locale: T.nilable(String),
101
109
  phone_number: T.nilable(String),
102
110
  preferences: T.nilable(Trycourier::UserRecipient::Preferences),
data/rbi/trycourier/models/users/user_token.rbi CHANGED
@@ -18,7 +18,7 @@ module Trycourier
18
18
  sig { returns(Trycourier::Users::UserToken::ProviderKey::TaggedSymbol) }
19
19
  attr_accessor :provider_key
20
20
 
21
- # Information about the device the token is associated with.
21
+ # Information about the device the token came from.
22
22
  sig { returns(T.nilable(Trycourier::Users::UserToken::Device)) }
23
23
  attr_reader :device
24
24
 
@@ -36,14 +36,14 @@ module Trycourier
36
36
  end
37
37
  attr_accessor :expiry_date
38
38
 
39
- # Properties sent to the provider along with the token
39
+ # Properties about the token.
40
40
  sig { returns(T.nilable(T.anything)) }
41
41
  attr_reader :properties
42
42
 
43
43
  sig { params(properties: T.anything).void }
44
44
  attr_writer :properties
45
45
 
46
- # Information about the device the token is associated with.
46
+ # Tracking information about the device the token came from.
47
47
  sig { returns(T.nilable(Trycourier::Users::UserToken::Tracking)) }
48
48
  attr_reader :tracking
49
49
 
@@ -69,14 +69,14 @@ module Trycourier
69
69
  # Full body of the token. Must match token in URL path parameter.
70
70
  token:,
71
71
  provider_key:,
72
- # Information about the device the token is associated with.
72
+ # Information about the device the token came from.
73
73
  device: nil,
74
74
  # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
75
75
  # disable expiration.
76
76
  expiry_date: nil,
77
- # Properties sent to the provider along with the token
77
+ # Properties about the token.
78
78
  properties: nil,
79
- # Information about the device the token is associated with.
79
+ # Tracking information about the device the token came from.
80
80
  tracking: nil
81
81
  )
82
82
  end
@@ -167,7 +167,7 @@ module Trycourier
167
167
  sig { returns(T.nilable(String)) }
168
168
  attr_accessor :platform
169
169
 
170
- # Information about the device the token is associated with.
170
+ # Information about the device the token came from.
171
171
  sig do
172
172
  params(
173
173
  ad_id: T.nilable(String),
@@ -251,7 +251,7 @@ module Trycourier
251
251
  sig { returns(T.nilable(String)) }
252
252
  attr_accessor :os_version
253
253
 
254
- # Information about the device the token is associated with.
254
+ # Tracking information about the device the token came from.
255
255
  sig do
256
256
  params(
257
257
  ip: T.nilable(String),
data/rbi/trycourier/resources/users/tokens.rbi CHANGED
@@ -111,14 +111,14 @@ module Trycourier
111
111
  body_token:,
112
112
  # Body param:
113
113
  provider_key:,
114
- # Body param: Information about the device the token is associated with.
114
+ # Body param: Information about the device the token came from.
115
115
  device: nil,
116
116
  # Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set
117
117
  # to false to disable expiration.
118
118
  expiry_date: nil,
119
- # Body param: Properties sent to the provider along with the token
119
+ # Body param: Properties about the token.
120
120
  properties: nil,
121
- # Body param: Information about the device the token is associated with.
121
+ # Body param: Tracking information about the device the token came from.
122
122
  tracking: nil,
123
123
  request_options: {}
124
124
  )
data/sig/trycourier/models/recipient.rbs CHANGED
@@ -6,6 +6,7 @@ module Trycourier
6
6
  context: Trycourier::MessageContext?,
7
7
  data: ::Hash[Symbol, top]?,
8
8
  email: String?,
9
+ list_id: String?,
9
10
  locale: String?,
10
11
  phone_number: String?,
11
12
  preferences: Trycourier::Recipient::Preferences?,
@@ -22,6 +23,8 @@ module Trycourier
22
23
 
23
24
  attr_accessor email: String?
24
25
 
26
+ attr_accessor list_id: String?
27
+
25
28
  attr_accessor locale: String?
26
29
 
27
30
  attr_accessor phone_number: String?
@@ -37,6 +40,7 @@ module Trycourier
37
40
  ?context: Trycourier::MessageContext?,
38
41
  ?data: ::Hash[Symbol, top]?,
39
42
  ?email: String?,
43
+ ?list_id: String?,
40
44
  ?locale: String?,
41
45
  ?phone_number: String?,
42
46
  ?preferences: Trycourier::Recipient::Preferences?,
@@ -49,6 +53,7 @@ module Trycourier
49
53
  context: Trycourier::MessageContext?,
50
54
  data: ::Hash[Symbol, top]?,
51
55
  email: String?,
56
+ list_id: String?,
52
57
  locale: String?,
53
58
  phone_number: String?,
54
59
  preferences: Trycourier::Recipient::Preferences?,
data/sig/trycourier/models/user_recipient.rbs CHANGED
@@ -6,6 +6,7 @@ module Trycourier
6
6
  context: Trycourier::MessageContext?,
7
7
  data: ::Hash[Symbol, top]?,
8
8
  email: String?,
9
+ list_id: String?,
9
10
  locale: String?,
10
11
  phone_number: String?,
11
12
  preferences: Trycourier::UserRecipient::Preferences?,
@@ -22,6 +23,8 @@ module Trycourier
22
23
 
23
24
  attr_accessor email: String?
24
25
 
26
+ attr_accessor list_id: String?
27
+
25
28
  attr_accessor locale: String?
26
29
 
27
30
  attr_accessor phone_number: String?
@@ -37,6 +40,7 @@ module Trycourier
37
40
  ?context: Trycourier::MessageContext?,
38
41
  ?data: ::Hash[Symbol, top]?,
39
42
  ?email: String?,
43
+ ?list_id: String?,
40
44
  ?locale: String?,
41
45
  ?phone_number: String?,
42
46
  ?preferences: Trycourier::UserRecipient::Preferences?,
@@ -49,6 +53,7 @@ module Trycourier
49
53
  context: Trycourier::MessageContext?,
50
54
  data: ::Hash[Symbol, top]?,
51
55
  email: String?,
56
+ list_id: String?,
52
57
  locale: String?,
53
58
  phone_number: String?,
54
59
  preferences: Trycourier::UserRecipient::Preferences?,
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: 3.4.0.pre.alpha9
4
+ version: 4.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Courier
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-11-07 00:00:00.000000000 Z
11
+ date: 2025-11-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool
@@ -726,9 +726,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
726
726
  version: 3.2.0
727
727
  required_rubygems_version: !ruby/object:Gem::Requirement
728
728
  requirements:
729
- - - ">"
729
+ - - ">="
730
730
  - !ruby/object:Gem::Version
731
- version: 1.3.1
731
+ version: '0'
732
732
  requirements: []
733
733
  rubygems_version: 3.4.1
734
734
  signing_key: