Class: Twilio::REST::Accounts::V1::SecondaryAuthTokenContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SecondaryAuthTokenContext

Initialize the SecondaryAuthTokenContext

Parameters:

  • version (Version) —

    Version that contains the resource



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 49

def initialize(version)
    super(version)
    

    # Path Solution
    @solution = {  }
    @uri = "/AuthTokens/Secondary"

    
end

Instance Method Details

#create(suppress_email_notification: :unset) ⇒ SecondaryAuthTokenInstance

Create the SecondaryAuthTokenInstance

Parameters:

  • suppress_email_notification (Boolean) (defaults to: :unset) —

    Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to false, so Twilio sends the email. Set to true when rotating Auth Tokens across many subaccounts.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 63

def create(
  suppress_email_notification: :unset
)

    data = Twilio::Values.of({
        'SuppressEmailNotification' => suppress_email_notification,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    SecondaryAuthTokenInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(suppress_email_notification: :unset) ⇒ SecondaryAuthTokenInstance

Create the SecondaryAuthTokenInstanceMetadata

Parameters:

  • suppress_email_notification (Boolean) (defaults to: :unset) —

    Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to false, so Twilio sends the email. Set to true when rotating Auth Tokens across many subaccounts.

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 88

def create_with_metadata(
  suppress_email_notification: :unset
)

    data = Twilio::Values.of({
        'SuppressEmailNotification' => suppress_email_notification,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    secondary_auth_token_instance = SecondaryAuthTokenInstance.new(
        @version,
        response.body,
    )
    SecondaryAuthTokenInstanceMetadata.new(
        @version,
        secondary_auth_token_instance,
        response.headers,
        response.status_code
    )
end

#delete(suppress_email_notification: :unset) ⇒ Boolean

Delete the SecondaryAuthTokenInstance

Parameters:

  • suppress_email_notification (Boolean) (defaults to: :unset) —

    Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to false, so Twilio sends the email. Set to true when rotating Auth Tokens across many subaccounts.

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 119

def delete(
  suppress_email_notification: :unset
)

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

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

#delete_with_metadata(suppress_email_notification: :unset) ⇒ Boolean

Delete the SecondaryAuthTokenInstanceMetadata

Parameters:

  • suppress_email_notification (Boolean) (defaults to: :unset) —

    Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to false, so Twilio sends the email. Set to true when rotating Auth Tokens across many subaccounts.

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete_with_metadata(
  suppress_email_notification: :unset
)

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



169
170
171
172
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 169

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

#to_s ⇒ Object

Provide a user friendly representation



162
163
164
165
 
# File 'lib/twilio-ruby/rest/accounts/v1/secondary_auth_token.rb', line 162

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