Class: Courier::Models::NotificationMetricsResponse

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

Overview

See Also:

  • Courier::Resources::Notifications#get_metrics

Defined Under Namespace

Modules: Granularity Classes: Series

Instance Attribute Summary collapse

Class Method 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(end_:, granularity:, notification_id:, series:, start:) ⇒ Object

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

Parameters:

  • end_ (Time) —

    End of the window actually queried, ceiled onto the granularity grid. Second-pre

  • granularity (Symbol, Courier::Models::NotificationMetricsResponse::Granularity) —

    Bucket size the series was built at.

  • notification_id (String) —

    The template the series describes, echoed from the request.

  • series (Array<Courier::Models::NotificationMetricsResponse::Series>) —

    One entry per bucket between start and end, oldest first, including buckets

  • start (Time) —

    Inclusive start of the window actually queried, floored onto the granularity gri




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

Instance Attribute Details

#end_ ⇒ Time

End of the window actually queried, ceiled onto the granularity grid. Second-precision UTC.

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :end_, Time, api_name: :end

#granularity ⇒ Symbol, Courier::Models::NotificationMetricsResponse::Granularity

Bucket size the series was built at.

Parameters:

  • value (Courier::Models::NotificationMetricsResponse::granularity)

Returns:



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

required :granularity, enum: -> { Courier::NotificationMetricsResponse::Granularity }

#notification_id ⇒ String

The template the series describes, echoed from the request.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :notification_id, String, api_name: :notificationId

#series ⇒ Array<Courier::Models::NotificationMetricsResponse::Series>

One entry per bucket between start and end, oldest first, including buckets with no activity.

Parameters:

  • value (::Array[Courier::NotificationMetricsResponse::Series])

Returns:



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

required :series, -> { Courier::Internal::Type::ArrayOf[Courier::NotificationMetricsResponse::Series] }

#start ⇒ Time

Inclusive start of the window actually queried, floored onto the granularity grid. Second-precision UTC.

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :start, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {