Class: Twilio::REST::Messaging::V1::DomainCertsInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, domain_sid: nil) ⇒ DomainCertsInstance

Initialize the DomainCertsInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 158

def initialize(version, payload , domain_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'domain_sid' => payload['domain_sid'],
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'domain_name' => payload['domain_name'],
        'certificate_sid' => payload['certificate_sid'],
        'url' => payload['url'],
        'cert_in_validation' => payload['cert_in_validation'],
    }

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

Instance Method Details

#cert_in_validation ⇒ Hash

Returns Optional JSON field describing the status and upload date of a new certificate in the process of validation.

Returns:

  • (Hash) —

    Optional JSON field describing the status and upload date of a new certificate in the process of validation



233
234
235
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 233

def cert_in_validation
    @properties['cert_in_validation']
end

#certificate_sid ⇒ String

Returns The unique string that we created to identify this Certificate resource.

Returns:

  • (String) —

    The unique string that we created to identify this Certificate resource.



221
222
223
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 221

def certificate_sid
    @properties['certificate_sid']
end

#context ⇒ DomainCertsContext

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

Returns:



182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 182

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

#date_created ⇒ Time

Returns Date that this Domain was registered to the Twilio platform to create a new Domain object.

Returns:

  • (Time) —

    Date that this Domain was registered to the Twilio platform to create a new Domain object.



209
210
211
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 209

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

Returns Date that the private certificate associated with this domain expires. You will need to update the certificate before that date to ensure your shortened links will continue to work.

Returns:

  • (Time) —

    Date that the private certificate associated with this domain expires. You will need to update the certificate before that date to ensure your shortened links will continue to work.



203
204
205
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 203

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time

Returns Date that this Domain was last updated.

Returns:

  • (Time) —

    Date that this Domain was last updated.



197
198
199
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 197

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainCertsInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



240
241
242
243
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 240

def delete

    context.delete
end

#domain_name ⇒ String

Returns Full url path for this domain.

Returns:

  • (String) —

    Full url path for this domain.



215
216
217
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 215

def domain_name
    @properties['domain_name']
end

#domain_sid ⇒ String

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

Returns:

  • (String) —

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



191
192
193
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 191

def domain_sid
    @properties['domain_sid']
end

#fetch ⇒ DomainCertsInstance

Fetch the DomainCertsInstance

Returns:



248
249
250
251
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 248

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



275
276
277
278
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 275

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

#to_s ⇒ Object

Provide a user friendly representation



268
269
270
271
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 268

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.DomainCertsInstance #{values}>"
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:



257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 257

def update(
    tls_cert: nil
)

    context.update(
        tls_cert: tls_cert, 
    )
end

#url ⇒ String

Returns:

  • (String) 


227
228
229
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 227

def url
    @properties['url']
end