Class: Twilio::REST::Content::V1::ContentInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ContentInstance

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

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

    The SID of the Call resource to fetch.



1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1538

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'language' => payload['language'],
        'variables' => payload['variables'],
        'types' => payload['types'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/usage/api/account) that created Content resource.

Returns:



1591
1592
1593
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1591

def 
    @properties['account_sid']
end

#approval_create ⇒ approval_create

Access the approval_create

Returns:



1661
1662
1663
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1661

def approval_create
    context.approval_create
end

#approval_fetch ⇒ approval_fetch

Access the approval_fetch

Returns:



1668
1669
1670
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1668

def approval_fetch
    context.approval_fetch
end

#context ⇒ ContentContext

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

Returns:



1564
1565
1566
1567
1568
1569
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1564

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



1573
1574
1575
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1573

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



1579
1580
1581
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1579

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ContentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



1634
1635
1636
1637
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1634

def delete

    context.delete
end

#fetch ⇒ ContentInstance

Fetch the ContentInstance

Returns:



1642
1643
1644
1645
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1642

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A string name used to describe the Content resource. Not visible to the end recipient.

Returns:

  • (String) —

    A string name used to describe the Content resource. Not visible to the end recipient.



1597
1598
1599
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1597

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



1681
1682
1683
1684
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1681

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

#language ⇒ String

Returns Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in.

Returns:

  • (String) —

    Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in.



1603
1604
1605
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1603

def language
    @properties['language']
end

#links ⇒ Hash

Returns A list of links related to the Content resource, such as approval_fetch and approval_create.

Returns:

  • (Hash) —

    A list of links related to the Content resource, such as approval_fetch and approval_create



1627
1628
1629
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1627

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Content resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Content resource.



1585
1586
1587
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1585

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



1674
1675
1676
1677
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1674

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

#types ⇒ Hash

Returns The [Content types](www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource.

Returns:



1615
1616
1617
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1615

def types
    @properties['types']
end

#update(content_update_request: nil) ⇒ ContentInstance

Update the ContentInstance

Parameters:

  • content_update_request (ContentUpdateRequest) (defaults to: nil)

Returns:



1651
1652
1653
1654
1655
1656
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1651

def update(content_update_request: nil
)

    context.update(
    )
end

#url ⇒ String

Returns The URL of the resource, relative to ‘content.twilio.com`.

Returns:



1621
1622
1623
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1621

def url
    @properties['url']
end

#variables ⇒ Hash

Returns Defines the default placeholder values for variables included in the Content resource. e.g. "Customer_Name".

Returns:

  • (Hash) —

    Defines the default placeholder values for variables included in the Content resource. e.g. "Customer_Name".



1609
1610
1611
 
# File 'lib/twilio-ruby/rest/content/v1/content.rb', line 1609

def variables
    @properties['variables']
end