Class: Twilio::REST::FlexApi::V1::InsightsSessionInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/insights_session.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ InsightsSessionInstance

Initialize the InsightsSessionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this InsightsSession resource.

  • sid (String) —

    The SID of the Call resource to fetch.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 132

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'workspace_id' => payload['workspace_id'],
        'session_expiry' => payload['session_expiry'],
        'session_id' => payload['session_id'],
        'base_url' => payload['base_url'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = {  }
end

Instance Method Details

#base_url ⇒ String

Returns The base URL to fetch reports and dashboards.

Returns:

  • (String) —

    The base URL to fetch reports and dashboards



180
181
182
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 180

def base_url
    @properties['base_url']
end

#context ⇒ InsightsSessionContext

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

Returns:



153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 153

def context
    unless @instance_context
        @instance_context = InsightsSessionContext.new(@version )
    end
    @instance_context
end

#create(authorization: :unset) ⇒ InsightsSessionInstance

Create the InsightsSessionInstance

Parameters:

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

    The Authorization HTTP request header

Returns:



194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 194

def create(
    authorization: :unset
)

    context.create(
        authorization: authorization, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



212
213
214
215
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 212

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

#session_expiry ⇒ String

Returns The session expiry date and time, given in ISO 8601 format.

Returns:

  • (String) —

    The session expiry date and time, given in ISO 8601 format.



168
169
170
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 168

def session_expiry
    @properties['session_expiry']
end

#session_id ⇒ String

Returns The unique ID for the session.

Returns:

  • (String) —

    The unique ID for the session



174
175
176
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 174

def session_id
    @properties['session_id']
end

#to_s ⇒ Object

Provide a user friendly representation



205
206
207
208
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 205

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



186
187
188
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 186

def url
    @properties['url']
end

#workspace_id ⇒ String

Returns Unique ID to identify the user’s workspace.

Returns:

  • (String) —

    Unique ID to identify the user’s workspace



162
163
164
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_session.rb', line 162

def workspace_id
    @properties['workspace_id']
end