Class: GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb

Overview

See Also:

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(expires_in:, is_new:, participant:, participant_token:) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse for more details.

Parameters:

  • expires_in (Integer) —

    Token lifetime in seconds.

  • is_new (Boolean) —

    Whether this request created a new participant. Returns false when the participa

  • participant (GrowsurfRuby::Models::Campaign::CampaignParticipant)
  • participant_token (String) —

    Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.




# File 'lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb', line 31

Instance Attribute Details

#expires_in ⇒ Integer

Token lifetime in seconds.

Returns:

  • (Integer) 


11
 
# File 'lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb', line 11

required :expires_in, Integer, api_name: :expiresIn

#is_new ⇒ Boolean

Whether this request created a new participant. Returns false when the participant already existed.

Returns:

  • (Boolean) 


18
 
# File 'lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb', line 18

required :is_new, GrowsurfRuby::Internal::Type::Boolean, api_name: :isNew

#participant ⇒ GrowsurfRuby::Models::Campaign::CampaignParticipant

Returns:



23
 
# File 'lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb', line 23

required :participant, -> { GrowsurfRuby::Campaign::CampaignParticipant }

#participant_token ⇒ String

Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.

Returns:

  • (String) 


29
 
# File 'lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb', line 29

required :participant_token, String, api_name: :participantToken