Class: Twilio::REST::Messaging::V1::DomainCertsContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/domain_certs.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, domain_sid) ⇒ DomainCertsContext

Initialize the DomainCertsContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • domain_sid (String) —

    Unique string used to identify the domain that this certificate should be associated with.



51
52
53
54
55
56
57
58
59
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 51

def initialize(version, domain_sid)
    super(version)

    # Path Solution
    @solution = { domain_sid: domain_sid,  }
    @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/Certificate"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the DomainCertsInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 63

def delete

    
    @version.delete('DELETE', @uri)
end

#fetch ⇒ DomainCertsInstance

Fetch the DomainCertsInstance

Returns:



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 72

def fetch

    
    payload = @version.fetch('GET', @uri)
    DomainCertsInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



114
115
116
117
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 114

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.DomainCertsContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



107
108
109
110
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 107

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.DomainCertsContext #{context}>"
end

#update(tls_cert: nil) ⇒ DomainCertsInstance

Update the DomainCertsInstance

Parameters:

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

    Contains the full TLS certificate and private for this domain in PEM format: en.wikipedia.org/wiki/Privacy-Enhanced_Mail. Twilio uses this information to process HTTPS traffic sent to your domain.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 87

def update(
    tls_cert: nil
)

    data = Twilio::Values.of({
        'TlsCert' => tls_cert,
    })

    
    payload = @version.update('POST', @uri, data: data)
    DomainCertsInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end