Class: Twilio::REST::Api::V2010::AccountContext::QueueContext::MemberContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Api::V2010::AccountContext::QueueContext::MemberContext

Defined in:

lib/twilio-ruby/rest/api/v2010/account/queue/member.rb

Instance Method Summary

• #fetch ⇒ MemberInstance

  Fetch the MemberInstance.

• #fetch_with_metadata ⇒ MemberInstance

  Fetch the MemberInstanceMetadata.

• #initialize(version, account_sid, queue_sid, call_sid) ⇒ MemberContext constructor

  Initialize the MemberContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(url: nil, method: :unset) ⇒ MemberInstance

  Update the MemberInstance.

• #update_with_metadata(url: nil, method: :unset) ⇒ MemberInstance

  Update the MemberInstanceMetadata.

Constructor Details

#initialize(version, account_sid, queue_sid, call_sid) ⇒ MemberContext

Initialize the MemberContext

Parameters:

• version (Version) —

  Version that contains the resource

• account_sid (String) —

  The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Member resource(s) to update.

• queue_sid (String) —

  The SID of the Queue in which to find the members to update.

• call_sid (String) —

  The [Call](www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update.

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 172

def initialize(version, account_sid, queue_sid, call_sid)
    super(version)
    

    # Path Solution
    @solution = { account_sid: account_sid, queue_sid: queue_sid, call_sid: call_sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:queue_sid]}/Members/#{@solution[:call_sid]}.json"

    
end

Instance Method Details

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:

• (MemberInstance) —

  Fetched MemberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 185

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    MemberInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        queue_sid: @solution[:queue_sid],
        call_sid: @solution[:call_sid],
    )
end

#fetch_with_metadata ⇒ MemberInstance

Fetch the MemberInstanceMetadata

Returns:

• (MemberInstance) —

  Fetched MemberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 206

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    member_instance = MemberInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        queue_sid: @solution[:queue_sid],
        call_sid: @solution[:call_sid],
    )
    MemberInstanceMetadata.new(
        @version,
        member_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 308

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.MemberContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 301

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.MemberContext #{context}>"
end

#update(url: nil, method: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

• url (String) (defaults to: nil) —

  The absolute URL of the Queue resource.

• method (String) (defaults to: :unset) —

  How to pass the update request data. Can be ‘GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.

Returns:

• (MemberInstance) —

  Updated MemberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 235

def update(
  url: nil, 
  method: :unset
)

    data = Twilio::Values.of({
        'Url' => url,
        'Method' => method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    MemberInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        queue_sid: @solution[:queue_sid],
        call_sid: @solution[:call_sid],
    )
end

#update_with_metadata(url: nil, method: :unset) ⇒ MemberInstance

Update the MemberInstanceMetadata

Parameters:

• url (String) (defaults to: nil) —

  The absolute URL of the Queue resource.

• method (String) (defaults to: :unset) —

  How to pass the update request data. Can be ‘GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.

Returns:

• (MemberInstance) —

  Updated MemberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/queue/member.rb', line 266

def update_with_metadata(
  url: nil, 
  method: :unset
)

    data = Twilio::Values.of({
        'Url' => url,
        'Method' => method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    member_instance = MemberInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        queue_sid: @solution[:queue_sid],
        call_sid: @solution[:call_sid],
    )
    MemberInstanceMetadata.new(
        @version,
        member_instance,
        response.headers,
        response.status_code
    )
end