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

Inherits:
InstanceResource 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, payload, domain_sid: nil) ⇒ DomainCertsInstance

Initialize the DomainCertsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 137

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'],
      'validated' => payload['validated'],
  }

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

Instance Method Details

#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.



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

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:



161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 161

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

#date_created ⇒ Time

Returns Date this Domain SID was created.

Returns:

  • (Time) —

    Date this Domain SID was created.



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns Expiration date for your private certificate.

Returns:

  • (Time) —

    Expiration date for your private certificate.



182
183
184
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 182

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.



176
177
178
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 176

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DomainCertsInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



236
237
238
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 236

def delete
  context.delete
end

#domain_name ⇒ String

Returns Full url path for this domain.

Returns:

  • (String) —

    Full url path for this domain.



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

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.



170
171
172
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 170

def domain_sid
  @properties['domain_sid']
end

#fetch ⇒ DomainCertsInstance

Fetch the DomainCertsInstance

Returns:



229
230
231
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 229

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



242
243
244
245
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_cert.rb', line 242

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:



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

def update(tls_cert: nil)
  context.update(tls_cert: tls_cert, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#validated ⇒ Boolean

Returns Certificate validation field.

Returns:

  • (Boolean) —

    Certificate validation field



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

def validated
  @properties['validated']
end