Class: Telnyx::Resources::Messaging10dlc::Campaign::Osr

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/messaging_10dlc/campaign/osr.rb,
sig/telnyx/resources/messaging_10dlc/campaign/osr.rbs

Overview

Campaign operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Osr

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

Parameters:



34
35
36
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign/osr.rb', line 34

def initialize(client:)
  @client = client
end

Instance Method Details

#get_attributes(campaign_id, request_options: {}) ⇒ Hash{Symbol=>Object}

Returns the optional shared-responsibility attributes recorded for the campaign. Use these values to inspect the campaign configuration submitted to the registry.

Parameters:

  • campaign_id (String) —

    Unique identifier of the campaign.

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

Returns:

  • (Hash{Symbol=>Object})

See Also:



22
23
24
25
26
27
28
29
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign/osr.rb', line 22

def get_attributes(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["10dlc/campaign/%1$s/osr/attributes", campaign_id],
    model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
    options: params[:request_options]
  )
end