Class: Twilio::REST::Iam::V1::KeyInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/iam/v1/key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ KeyInstance

Initialize the KeyInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 110

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'secret' => payload['secret'],
        'policy' => payload['policy'],
    }
end

Instance Method Details

#date_created ⇒ Time

Returns The date and time in GMT that the API Key was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



139
140
141
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 139

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the new API Key was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



145
146
147
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 145

def date_updated
    @properties['date_updated']
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



133
134
135
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 133

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



169
170
171
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 169

def inspect
    "<Twilio.Iam.V1.KeyInstance>"
end

#policy ⇒ Hash

Returns Collection of allow assertions.

Returns:

  • (Hash) —

    Collection of allow assertions.



157
158
159
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 157

def policy
    @properties['policy']
end

#secret ⇒ String

Returns The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth ‘password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**.

Returns:

  • (String) —

    The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth ‘password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**



151
152
153
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 151

def secret
    @properties['secret']
end

#sid ⇒ String

Returns The unique string that that we created to identify the NewKey resource. You will use this as the basic-auth ‘user` when authenticating to the API.

Returns:

  • (String) —

    The unique string that that we created to identify the NewKey resource. You will use this as the basic-auth ‘user` when authenticating to the API.



127
128
129
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 127

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



163
164
165
 
# File 'lib/twilio-ruby/rest/iam/v1/key.rb', line 163

def to_s
    "<Twilio.Iam.V1.KeyInstance>"
end