Class: SurgeAPI::Models::UserCreateTokenParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/surge_api/models/user_create_token_params.rb,
sig/surge_api/models/user_create_token_params.rbs

Overview

See Also:

  • SurgeAPI::Resources::Users#create_token

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(user_id:, duration_seconds: nil, request_options: {}) ⇒ Object

Parameters:

  • user_id (String) —

    The user for which the token represents authentication.

  • duration_seconds (Integer) (defaults to: nil) —

    For how many seconds the token should be accepted. Defaults to 15 minutes.

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



# File 'lib/surge_api/models/user_create_token_params.rb', line 22

Instance Attribute Details

#duration_seconds ⇒ Integer?

For how many seconds the token should be accepted. Defaults to 15 minutes.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


20
 
# File 'lib/surge_api/models/user_create_token_params.rb', line 20

optional :duration_seconds, Integer

#user_id ⇒ String

The user for which the token represents authentication.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/surge_api/models/user_create_token_params.rb', line 14

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/surge_api/models/user_create_token_params.rbs', line 23

def to_hash: -> {