Class: Twilio::REST::Trusthub::V1::PoliciesInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the PoliciesInstance

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 Policies resource.

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

    The SID of the Call resource to fetch.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 218

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'requirements' => payload['requirements'],
        'url' => payload['url'],
    }

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

Instance Method Details

#context ⇒ PoliciesContext

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

Returns:



238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 238

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

#fetch ⇒ PoliciesInstance

Fetch the PoliciesInstance

Returns:



272
273
274
275
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 272

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy.

Returns:

  • (String) —

    A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy



253
254
255
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 253

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



286
287
288
289
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 286

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

#requirements ⇒ Hash

Returns The SID of an object that holds the policy information.

Returns:

  • (Hash) —

    The SID of an object that holds the policy information



259
260
261
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 259

def requirements
    @properties['requirements']
end

#sid ⇒ String

Returns The unique string that identifies the Policy resource.

Returns:

  • (String) —

    The unique string that identifies the Policy resource.



247
248
249
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 247

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



279
280
281
282
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 279

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

#url ⇒ String

Returns The absolute URL of the Policy resource.

Returns:

  • (String) —

    The absolute URL of the Policy resource.



265
266
267
 
# File 'lib/twilio-ruby/rest/trusthub/v1/policies.rb', line 265

def url
    @properties['url']
end