Module: Courier::Models::Users::TokenAddSingleParams::ProviderKey

Extended by:

Internal::Type::Enum

Defined in:

lib/courier/models/users/token_add_single_params.rb,
sig/courier/models/users/token_add_single_params.rbs

Constant Summary

FIREBASE_FCM =

Returns:

• (:"firebase-fcm")

:"firebase-fcm"

APN =

Returns:

• (:apn)

:apn

EXPO =

Returns:

• (:expo)

:expo

ONESIGNAL =

Returns:

• (:onesignal)

:onesignal

Instance Method Summary

• #initialize(user_id:, token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) ⇒ Object

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

• #self?.values ⇒ ::Array[Courier::Models::Users::TokenAddSingleParams::provider_key]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Instance Method Details

#initialize(user_id:, token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) ⇒ Object

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

Parameters:

• user_id (String)
• token (String)
• provider_key (Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey)
• device (Courier::Models::Users::TokenAddSingleParams::Device, nil) (defaults to: nil) —

  Information about the device the token came from.

• expiry_date (String, Boolean, nil) (defaults to: nil) —

  ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to

• properties (Object) (defaults to: nil) —

  Properties about the token.

• tracking (Courier::Models::Users::TokenAddSingleParams::Tracking, nil) (defaults to: nil) —

  Tracking information about the device the token came from.

• request_options (Courier::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/courier/models/users/token_add_single_params.rb', line 71

module ProviderKey
  extend Courier::Internal::Type::Enum

  FIREBASE_FCM = :"firebase-fcm"
  APN = :apn
  EXPO = :expo
  ONESIGNAL = :onesignal

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Courier::Models::Users::TokenAddSingleParams::provider_key]

Returns:

• (::Array[Courier::Models::Users::TokenAddSingleParams::provider_key])

# File 'sig/courier/models/users/token_add_single_params.rbs', line 68

def self?.values: -> ::Array[Courier::Models::Users::TokenAddSingleParams::provider_key]