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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/domain_cert.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.



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

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

#deleteBoolean

Delete the DomainCertsInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise



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

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

#fetchDomainCertsInstance

Fetch the DomainCertsInstance

Returns:



99
100
101
102
103
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 99

def fetch
  payload = @version.fetch('GET', @uri)

  DomainCertsInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
end

#inspectObject

Provide a detailed, user friendly representation



121
122
123
124
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 121

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

#to_sObject

Provide a user friendly representation



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

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:



88
89
90
91
92
93
94
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 88

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