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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/sentdm/models/me_retrieve_response.rb', line 117

class Profile < Sentdm::Internal::Type::BaseModel
  # @!attribute id
  #   Profile unique identifier
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute created_at
  #   When the profile was created
  #
  #   @return [Time, nil]
  optional :created_at, Time

  # @!attribute description
  #   Profile description
  #
  #   @return [String, nil]
  optional :description, String, nil?: true

  # @!attribute icon
  #   Profile icon URL
  #
  #   @return [String, nil]
  optional :icon, String, nil?: true

  # @!attribute name
  #   Profile name
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute role
  #   User's role in this profile: admin, billing, developer (inherited from
  #   organization if not explicitly set)
  #
  #   @return [String, nil]
  optional :role, String, nil?: true

  # @!attribute settings
  #   Profile configuration settings
  #
  #   @return [Sentdm::Models::ProfileSettings, nil]
  optional :settings, -> { Sentdm::ProfileSettings }

  # @!attribute short_name
  #   Profile short name (abbreviation)
  #
  #   @return [String, nil]
  optional :short_name, String, nil?: true

  # @!attribute status
  #   Profile setup status: incomplete, pending_review, approved, rejected
  #
  #   @return [String, nil]
  optional :status, String, nil?: true

  # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, role: nil, settings: nil, short_name: nil, status: nil)
  #   Some parameter documentations has been truncated, see
  #   {Sentdm::Models::MeRetrieveResponse::Data::Profile} for more details.
  #
  #   Profile (sender profile) response for v3 API
  #
  #   @param id [String] Profile unique identifier
  #
  #   @param created_at [Time] When the profile was created
  #
  #   @param description [String, nil] Profile description
  #
  #   @param icon [String, nil] Profile icon URL
  #
  #   @param name [String] Profile name
  #
  #   @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
  #
  #   @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
  #
  #   @param short_name [String, nil] Profile short name (abbreviation)
  #
  #   @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
end

Instance Attribute Details

#created_at ⇒ Time?

When the profile was created

Returns:

  • (Time, nil) 


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

optional :created_at, Time

#description ⇒ String?

Profile description

Returns:

  • (String, nil) 


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

optional :description, String, nil?: true

#icon ⇒ String?

Profile icon URL

Returns:

  • (String, nil) 


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

optional :icon, String, nil?: true

#id ⇒ String?

Profile unique identifier

Returns:

  • (String, nil) 


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

optional :id, String

#name ⇒ String?

Profile name

Returns:

  • (String, nil) 


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

optional :name, String

#role ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :role, String, nil?: true

#settings ⇒ Sentdm::Models::ProfileSettings?

Profile configuration settings

Returns:



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

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

#short_name ⇒ String?

Profile short name (abbreviation)

Returns:

  • (String, nil) 


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

optional :short_name, String, nil?: true

#status ⇒ String?

Profile setup status: incomplete, pending_review, approved, rejected

Returns:

  • (String, nil) 


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

optional :status, String, nil?: true