Class: Sentdm::Models::MeRetrieveResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::MeRetrieveResponse

Defined in:

lib/sentdm/models/me_retrieve_response.rb

Overview

See Also:

• Resources::Me#retrieve

Defined Under Namespace

Classes: Data

Instance Attribute Summary

• #data ⇒ Sentdm::Models::MeRetrieveResponse::Data^?

  Account response for GET /v3/me endpoint.

• #error ⇒ Sentdm::Models::ErrorDetail^?

  Error information.

• #meta ⇒ Sentdm::Models::APIMeta^?

  Request and response metadata.

• #success ⇒ Boolean^?

  Indicates whether the request was successful.

Instance Method Summary

• #initialize(data: nil, error: nil, meta: nil, success: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see MeRetrieveResponse for more details.

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(data: nil, error: nil, meta: nil, success: nil) ⇒ Object

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

Standard API response envelope for all v3 endpoints

Parameters:

• data (Sentdm::Models::MeRetrieveResponse::Data, nil) (defaults to: nil) —

  Account response for GET /v3/me endpoint.

• error (Sentdm::Models::ErrorDetail, nil) (defaults to: nil) —

  Error information

• meta (Sentdm::Models::APIMeta) (defaults to: nil) —

  Request and response metadata

• success (Boolean) (defaults to: nil) —

  Indicates whether the request was successful

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

Instance Attribute Details

#data ⇒ Sentdm::Models::MeRetrieveResponse::Data^?

Account response for GET /v3/me endpoint. Returns organization (with profiles), user (standalone), or profile (child of an organization) data depending on the API key type. Always includes messaging channel configuration.

Returns:

• (Sentdm::Models::MeRetrieveResponse::Data, nil)

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

optional :data, -> { Sentdm::Models::MeRetrieveResponse::Data }, nil?: true

#error ⇒ Sentdm::Models::ErrorDetail^?

Error information

Returns:

• (Sentdm::Models::ErrorDetail, nil)

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

optional :error, -> { Sentdm::ErrorDetail }, nil?: true

#meta ⇒ Sentdm::Models::APIMeta^?

Request and response metadata

Returns:

• (Sentdm::Models::APIMeta, nil)

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

optional :meta, -> { Sentdm::APIMeta }

#success ⇒ Boolean^?

Indicates whether the request was successful

Returns:

• (Boolean, nil)

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

optional :success, Sentdm::Internal::Type::Boolean