Class: Twilio::REST::Api::V2010::AccountContext::ConnectAppContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ ConnectAppContext

Initialize the ConnectAppContext

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 ConnectApp resources to update.

  • sid (String) —

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



135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 135

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ConnectAppInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



147
148
149
150
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 147

def delete

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

#fetch ⇒ ConnectAppInstance

Fetch the ConnectAppInstance

Returns:



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 155

def fetch

    payload = @version.fetch('GET', @uri)
    ConnectAppInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(authorize_redirect_url: :unset, company_name: :unset, deauthorize_callback_method: :unset, deauthorize_callback_url: :unset, description: :unset, friendly_name: :unset, homepage_url: :unset, permissions: :unset) ⇒ ConnectAppInstance

Update the ConnectAppInstance

Parameters:

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

    The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.

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

    The company name to set for the Connect App.

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

    The HTTP method to use when calling ‘deauthorize_callback_url`.

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

    The URL to call using the ‘deauthorize_callback_method` to de-authorize the Connect App.

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

    A description of the Connect App.

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

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

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

    A public URL where users can obtain more information about this Connect App.

  • permissions (Array[Permission]) (defaults to: :unset) —

    A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: ‘get-all` and `post-all`.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 177

def update(
    authorize_redirect_url: :unset, 
    company_name: :unset, 
    deauthorize_callback_method: :unset, 
    deauthorize_callback_url: :unset, 
    description: :unset, 
    friendly_name: :unset, 
    homepage_url: :unset, 
    permissions: :unset
)

    data = Twilio::Values.of({
        'AuthorizeRedirectUrl' => authorize_redirect_url,
        'CompanyName' => company_name,
        'DeauthorizeCallbackMethod' => deauthorize_callback_method,
        'DeauthorizeCallbackUrl' => deauthorize_callback_url,
        'Description' => description,
        'FriendlyName' => friendly_name,
        'HomepageUrl' => homepage_url,
        'Permissions' => Twilio.serialize_list(permissions) { |e| e },
    })

    payload = @version.update('POST', @uri, data: data)
    ConnectAppInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end