Class: Courier::Models::NotificationMetricsResponse::Series::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/notification_metrics_response.rb,
sig/courier/models/notification_metrics_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(channel:, clicked:, delivered:, errors:, opened:, provider:, sent:, undeliverable:) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::NotificationMetricsResponse::Series::Data for more details.

Parameters:

  • channel (String) —

    Channel the provider delivered on, e.g. email.

  • clicked (Integer) —

    Messages with at least one tracked link click.

  • delivered (Integer) —

    Messages the provider confirmed as delivered.

  • errors (Integer) —

    Messages the provider rejected or failed on, including ones a later provider the

  • opened (Integer) —

    Messages opened at least once. Always 0 on channels with no open tracking.

  • provider (String) —

    Provider that handled the messages, e.g. sendgrid.

  • sent (Integer) —

    Messages handed to the provider.

  • undeliverable (Integer) —

    Messages Courier could not deliver on any provider for the channel.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/courier/models/notification_metrics_response.rb', line 92

class Data < Courier::Internal::Type::BaseModel
  # @!attribute channel
  #   Channel the provider delivered on, e.g. `email`.
  #
  #   @return [String]
  required :channel, String

  # @!attribute clicked
  #   Messages with at least one tracked link click.
  #
  #   @return [Integer]
  required :clicked, Integer

  # @!attribute delivered
  #   Messages the provider confirmed as delivered.
  #
  #   @return [Integer]
  required :delivered, Integer

  # @!attribute errors
  #   Messages the provider rejected or failed on, including ones a later provider
  #   then delivered.
  #
  #   @return [Integer]
  required :errors, Integer

  # @!attribute opened
  #   Messages opened at least once. Always `0` on channels with no open tracking.
  #
  #   @return [Integer]
  required :opened, Integer

  # @!attribute provider
  #   Provider that handled the messages, e.g. `sendgrid`.
  #
  #   @return [String]
  required :provider, String

  # @!attribute sent
  #   Messages handed to the provider.
  #
  #   @return [Integer]
  required :sent, Integer

  # @!attribute undeliverable
  #   Messages Courier could not deliver on any provider for the channel.
  #
  #   @return [Integer]
  required :undeliverable, Integer

  # @!method initialize(channel:, clicked:, delivered:, errors:, opened:, provider:, sent:, undeliverable:)
  #   Some parameter documentations has been truncated, see
  #   {Courier::Models::NotificationMetricsResponse::Series::Data} for more details.
  #
  #   @param channel [String] Channel the provider delivered on, e.g. `email`.
  #
  #   @param clicked [Integer] Messages with at least one tracked link click.
  #
  #   @param delivered [Integer] Messages the provider confirmed as delivered.
  #
  #   @param errors [Integer] Messages the provider rejected or failed on, including ones a later provider the
  #
  #   @param opened [Integer] Messages opened at least once. Always `0` on channels with no open tracking.
  #
  #   @param provider [String] Provider that handled the messages, e.g. `sendgrid`.
  #
  #   @param sent [Integer] Messages handed to the provider.
  #
  #   @param undeliverable [Integer] Messages Courier could not deliver on any provider for the channel.
end

Instance Attribute Details

#channel ⇒ String

Channel the provider delivered on, e.g. email.

Parameters:

  • value (String)

Returns:

  • (String) 


97
 
# File 'lib/courier/models/notification_metrics_response.rb', line 97

required :channel, String

#clicked ⇒ Integer

Messages with at least one tracked link click.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


103
 
# File 'lib/courier/models/notification_metrics_response.rb', line 103

required :clicked, Integer

#delivered ⇒ Integer

Messages the provider confirmed as delivered.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


109
 
# File 'lib/courier/models/notification_metrics_response.rb', line 109

required :delivered, Integer

#errors ⇒ Integer

Messages the provider rejected or failed on, including ones a later provider then delivered.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


116
 
# File 'lib/courier/models/notification_metrics_response.rb', line 116

required :errors, Integer

#opened ⇒ Integer

Messages opened at least once. Always 0 on channels with no open tracking.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


122
 
# File 'lib/courier/models/notification_metrics_response.rb', line 122

required :opened, Integer

#provider ⇒ String

Provider that handled the messages, e.g. sendgrid.

Parameters:

  • value (String)

Returns:

  • (String) 


128
 
# File 'lib/courier/models/notification_metrics_response.rb', line 128

required :provider, String

#sent ⇒ Integer

Messages handed to the provider.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


134
 
# File 'lib/courier/models/notification_metrics_response.rb', line 134

required :sent, Integer

#undeliverable ⇒ Integer

Messages Courier could not deliver on any provider for the channel.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


140
 
# File 'lib/courier/models/notification_metrics_response.rb', line 140

required :undeliverable, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


113
 
# File 'sig/courier/models/notification_metrics_response.rbs', line 113

def to_hash: -> {