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

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

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.



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

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
68
69
70
71
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 63

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the DomainCertsInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 76

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      domainCerts_instance = DomainCertsInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      DomainCertsInstanceMetadata.new(@version, domainCerts_instance, response.headers, response.status_code)
end

#fetch ⇒ DomainCertsInstance

Fetch the DomainCertsInstance

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 95

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    DomainCertsInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end

#fetch_with_metadata ⇒ DomainCertsInstance

Fetch the DomainCertsInstanceMetadata

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 114

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    domain_certs_instance = DomainCertsInstance.new(
        @version,
        response.body,
        domain_sid: @solution[:domain_sid],
    )
    DomainCertsInstanceMetadata.new(
        @version,
        domain_certs_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 140

def update(
    tls_cert: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    DomainCertsInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end

#update_with_metadata(tls_cert: nil) ⇒ DomainCertsInstance

Update the DomainCertsInstanceMetadata

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:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_certs.rb', line 166

def update_with_metadata(
  tls_cert: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    domain_certs_instance = DomainCertsInstance.new(
        @version,
        response.body,
        domain_sid: @solution[:domain_sid],
    )
    DomainCertsInstanceMetadata.new(
        @version,
        domain_certs_instance,
        response.headers,
        response.status_code
    )
end