Class: Twilio::REST::FlexApi::V1::WebChannelInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::FlexApi::V1::WebChannelInstance

Defined in:

lib/twilio-ruby/rest/flex_api/v1/web_channel.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource and owns this Workflow.

• #context ⇒ WebChannelContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the WebChannelInstance.

• #fetch ⇒ WebChannelInstance

  Fetch the WebChannelInstance.

• #flex_flow_sid ⇒ String

  The SID of the Flex Flow.

• #initialize(version, payload, sid: nil) ⇒ WebChannelInstance constructor

  Initialize the WebChannelInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  The unique string that identifies the WebChannel resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(chat_status: :unset, post_engagement_data: :unset) ⇒ WebChannelInstance

  Update the WebChannelInstance.

• #url ⇒ String

  The absolute URL of the WebChannel resource.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ WebChannelInstance

Initialize the WebChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 235

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'flex_flow_sid' => payload['flex_flow_sid'],
      'sid' => payload['sid'],
      'url' => payload['url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 266

def account_sid
  @properties['account_sid']
end

#context ⇒ WebChannelContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 257

def context
  unless @instance_context
    @instance_context = WebChannelContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 290

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 296

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 320

def delete
  context.delete
end

#fetch ⇒ WebChannelInstance

Fetch the WebChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 303

def fetch
  context.fetch
end

#flex_flow_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 272

def flex_flow_sid
  @properties['flex_flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 333

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.WebChannelInstance #{values}>"
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 278

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 326

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.WebChannelInstance #{values}>"
end

#update(chat_status: :unset, post_engagement_data: :unset) ⇒ WebChannelInstance

Update the WebChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 313

def update(chat_status: :unset, post_engagement_data: :unset)
  context.update(chat_status: chat_status, post_engagement_data: post_engagement_data, )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 284

def url
  @properties['url']
end