Class: Twilio::REST::Preview::TrustedComms::BusinessInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/trusted_comms/business.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the BusinessInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    A 34 character string that uniquely identifies this Business.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 131

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'sid' => payload['sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



160
161
162
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 160

def 
  @properties['account_sid']
end

#context ⇒ BusinessContext

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

Returns:



151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 151

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

#fetch ⇒ BusinessInstance

Fetch the BusinessInstance

Returns:



185
186
187
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 185

def fetch
  context.fetch
end

#insights ⇒ insights

Access the insights

Returns:



192
193
194
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 192

def insights
  context.insights
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



205
206
207
208
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 205

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



178
179
180
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 178

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Business.

Returns:

  • (String) —

    A string that uniquely identifies this Business.



166
167
168
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 166

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



198
199
200
201
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 198

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



172
173
174
 
# File 'lib/twilio-ruby/rest/preview/trusted_comms/business.rb', line 172

def url
  @properties['url']
end