Class: Sentdm::Models::MeRetrieveResponse::Data::Profile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/me_retrieve_response.rb

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(id: nil, created_at: nil, description: nil, icon: nil, name: nil, role: nil, settings: nil, short_name: nil, status: nil) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::MeRetrieveResponse::Data::Profile for more details.

Profile (sender profile) response for v3 API

Parameters:

  • id (String) (defaults to: nil) —

    Profile unique identifier

  • created_at (Time) (defaults to: nil) —

    When the profile was created

  • description (String, nil) (defaults to: nil) —

    Profile description

  • icon (String, nil) (defaults to: nil) —

    Profile icon URL

  • name (String) (defaults to: nil) —

    Profile name

  • role (String, nil) (defaults to: nil) —

    User’s role in this profile: admin, billing, developer (inherited from organizat

  • settings (Sentdm::Models::ProfileSettings) (defaults to: nil) —

    Profile configuration settings

  • short_name (String, nil) (defaults to: nil) —

    Profile short name (abbreviation)

  • status (String, nil) (defaults to: nil) —

    Profile setup status: incomplete, pending_review, approved, rejected




# File 'lib/sentdm/models/me_retrieve_response.rb', line 332

Instance Attribute Details

#created_at ⇒ Time?

When the profile was created

Returns:

  • (Time, nil) 


287
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 287

optional :created_at, Time

#description ⇒ String?

Profile description

Returns:

  • (String, nil) 


293
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 293

optional :description, String, nil?: true

#icon ⇒ String?

Profile icon URL

Returns:

  • (String, nil) 


299
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 299

optional :icon, String, nil?: true

#id ⇒ String?

Profile unique identifier

Returns:

  • (String, nil) 


281
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 281

optional :id, String

#name ⇒ String?

Profile name

Returns:

  • (String, nil) 


305
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 305

optional :name, String

#role ⇒ String?

User’s role in this profile: admin, billing, developer (inherited from organization if not explicitly set)

Returns:

  • (String, nil) 


312
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 312

optional :role, String, nil?: true

#settings ⇒ Sentdm::Models::ProfileSettings?

Profile configuration settings

Returns:



318
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 318

optional :settings, -> { Sentdm::ProfileSettings }

#short_name ⇒ String?

Profile short name (abbreviation)

Returns:

  • (String, nil) 


324
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 324

optional :short_name, String, nil?: true

#status ⇒ String?

Profile setup status: incomplete, pending_review, approved, rejected

Returns:

  • (String, nil) 


330
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 330

optional :status, String, nil?: true