Class: Telnyx::Resources::Organizations::Users::Actions

Inherits:

Object

• Object
• Telnyx::Resources::Organizations::Users::Actions

Defined in:

lib/telnyx/resources/organizations/users/actions.rb

Overview

Operations related to users in your organization

Instance Method Summary

• #initialize(client:) ⇒ Actions constructor private

  A new instance of Actions.

• #remove(id, request_options: {}) ⇒ Telnyx::Models::Organizations::Users::ActionRemoveResponse

  Deletes a user in your organization.

Constructor Details

#initialize(client:) ⇒ Actions

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 Actions.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/organizations/users/actions.rb', line 32

def initialize(client:)
  @client = client
end

Instance Method Details

#remove(id, request_options: {}) ⇒ Telnyx::Models::Organizations::Users::ActionRemoveResponse

Deletes a user in your organization.

Parameters:

• id (String) —

  Organization User ID

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

Returns:

• (Telnyx::Models::Organizations::Users::ActionRemoveResponse)

See Also:

• Models::Organizations::Users::ActionRemoveParams

# File 'lib/telnyx/resources/organizations/users/actions.rb', line 20

def remove(id, params = {})
  @client.request(
    method: :post,
    path: ["organizations/users/%1$s/actions/remove", id],
    model: Telnyx::Models::Organizations::Users::ActionRemoveResponse,
    options: params[:request_options]
  )
end