Class: Twilio::REST::Api::V2010::AccountContext::KeyContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ KeyContext

Initialize the KeyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Key resources to update.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Key resource to update.



139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 139

def initialize(version, , sid)
    super(version)

    # Path Solution
    @solution = { account_sid: , sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Keys/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the KeyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 151

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ KeyInstance

Fetch the KeyInstance

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 163

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



217
218
219
220
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 217

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

#to_s ⇒ Object

Provide a user friendly representation



210
211
212
213
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 210

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.KeyContext #{context}>"
end

#update(friendly_name: :unset) ⇒ KeyInstance

Update the KeyInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 184

def update(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

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