Skip to content

Latest commit

 

History

History
146 lines (82 loc) · 6.19 KB

Api20100401ConnectAppApi.md

File metadata and controls

146 lines (82 loc) · 6.19 KB
Raw

\Api20100401ConnectAppApi

All URIs are relative to https://api.twilio.com

Method HTTP request Description
delete_connect_app DELETE /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json
fetch_connect_app GET /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json
list_connect_app GET /2010-04-01/Accounts/{AccountSid}/ConnectApps.json
update_connect_app POST /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json

delete_connect_app

delete_connect_app(account_sid, sid)

Delete an instance of a connect-app

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the ConnectApp resource to fetch. [required]
sid String The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. [required]

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_connect_app

crate::models::ApiPeriodV2010PeriodAccountPeriodConnectApp fetch_connect_app(account_sid, sid)

Fetch an instance of a connect-app

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the ConnectApp resource to fetch. [required]
sid String The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. [required]

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodConnectApp

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_connect_app

crate::models::ListConnectAppResponse list_connect_app(account_sid, page_size, page, page_token)

Retrieve a list of connect-apps belonging to the account used to make the request

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the ConnectApp resources to read. [required]
page_size Option<i32> How many resources to return in each list page. The default is 50, and the maximum is 1000.
page Option<i32> The page index. This value is simply for client state.
page_token Option<String> The page token. This is provided by the API.

Return type

crate::models::ListConnectAppResponse

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_connect_app

crate::models::ApiPeriodV2010PeriodAccountPeriodConnectApp update_connect_app(account_sid, sid, authorize_redirect_url, company_name, deauthorize_callback_method, deauthorize_callback_url, description, friendly_name, homepage_url, permissions)

Update a connect-app with the specified parameters

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the ConnectApp resources to update. [required]
sid String The Twilio-provided string that uniquely identifies the ConnectApp resource to update. [required]
authorize_redirect_url Option<String> The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
company_name Option<String> The company name to set for the Connect App.
deauthorize_callback_method Option<String> The HTTP method to use when calling deauthorize_callback_url.
deauthorize_callback_url Option<String> The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
description Option<String> A description of the Connect App.
friendly_name Option<String> A descriptive string that you create to describe the resource. It can be up to 64 characters long.
homepage_url Option<String> A public URL where users can obtain more information about this Connect App.
permissions Option<Veccrate::models::ConnectAppEnumPermission> A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: get-all and post-all.

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodConnectApp

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]