Class: Sentdm::Models::ProfileDetail

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

Defined Under Namespace

Classes: Settings

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, email: nil, icon: nil, name: nil, organization_id: nil, settings: nil, short_name: nil, status: nil, updated_at: nil) ⇒ Object

Detailed 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

  • email (String, nil) (defaults to: nil)

    Profile email (inherited from organization)

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

    Profile icon URL

  • name (String) (defaults to: nil)

    Profile name

  • organization_id (String, nil) (defaults to: nil)

    Parent organization ID

  • settings (Sentdm::Models::ProfileDetail::Settings) (defaults to: nil)

    Profile configuration settings

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

    Profile short name (abbreviation)

  • status (String) (defaults to: nil)

    Profile setup status: incomplete, pending_review, approved, rejected

  • updated_at (Time, nil) (defaults to: nil)

    When the profile was last updated



# File 'lib/sentdm/models/profile_detail.rb', line 72

Instance Attribute Details

#created_atTime?

When the profile was created

Returns:

  • (Time, nil)


16
# File 'lib/sentdm/models/profile_detail.rb', line 16

optional :created_at, Time

#descriptionString?

Profile description

Returns:

  • (String, nil)


22
# File 'lib/sentdm/models/profile_detail.rb', line 22

optional :description, String, nil?: true

#emailString?

Profile email (inherited from organization)

Returns:

  • (String, nil)


28
# File 'lib/sentdm/models/profile_detail.rb', line 28

optional :email, String, nil?: true

#iconString?

Profile icon URL

Returns:

  • (String, nil)


34
# File 'lib/sentdm/models/profile_detail.rb', line 34

optional :icon, String, nil?: true

#idString?

Profile unique identifier

Returns:

  • (String, nil)


10
# File 'lib/sentdm/models/profile_detail.rb', line 10

optional :id, String

#nameString?

Profile name

Returns:

  • (String, nil)


40
# File 'lib/sentdm/models/profile_detail.rb', line 40

optional :name, String

#organization_idString?

Parent organization ID

Returns:

  • (String, nil)


46
# File 'lib/sentdm/models/profile_detail.rb', line 46

optional :organization_id, String, nil?: true

#settingsSentdm::Models::ProfileDetail::Settings?

Profile configuration settings



52
# File 'lib/sentdm/models/profile_detail.rb', line 52

optional :settings, -> { Sentdm::ProfileDetail::Settings }

#short_nameString?

Profile short name (abbreviation)

Returns:

  • (String, nil)


58
# File 'lib/sentdm/models/profile_detail.rb', line 58

optional :short_name, String, nil?: true

#statusString?

Profile setup status: incomplete, pending_review, approved, rejected

Returns:

  • (String, nil)


64
# File 'lib/sentdm/models/profile_detail.rb', line 64

optional :status, String

#updated_atTime?

When the profile was last updated

Returns:

  • (Time, nil)


70
# File 'lib/sentdm/models/profile_detail.rb', line 70

optional :updated_at, Time, nil?: true