Class: Sentdm::Resources::Me

Inherits:

Object

• Object
• Sentdm::Resources::Me

Defined in:

lib/sentdm/resources/me.rb

Overview

Retrieve account details

Instance Method Summary

• #initialize(client:) ⇒ Me constructor private

  A new instance of Me.

• #retrieve(request_options: {}) ⇒ Sentdm::Models::MeRetrieveResponse

  Returns the account associated with the API key.

Constructor Details

#initialize(client:) ⇒ Me

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Me.

Parameters:

• client (Sentdm::Client)

# File 'lib/sentdm/resources/me.rb', line 30

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Sentdm::Models::MeRetrieveResponse

Returns the account associated with the API key. For organization API keys, returns the organization with its profiles. For profile API keys, returns the profile with its settings.

Parameters:

• request_options (Sentdm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Sentdm::Models::MeRetrieveResponse)

See Also:

• Models::MeRetrieveParams

# File 'lib/sentdm/resources/me.rb', line 18

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "v3/me",
    model: Sentdm::Models::MeRetrieveResponse,
    options: params[:request_options]
  )
end