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.



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

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



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

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.



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

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:



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

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.



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

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.



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

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.



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainCertsInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#domain_name ⇒ String

Returns Full url path for this domain.

Returns:

  • (String) —

    Full url path for this domain.



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

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.



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

def domain_sid
    @properties['domain_sid']
end

#fetch ⇒ DomainCertsInstance

Fetch the DomainCertsInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

def update(
    tls_cert: nil
)

    context.update(
        tls_cert: tls_cert, 
    )
end

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end