class Twilio::ConnectAppsApi
- Twilio::ConnectAppsApi
- Reference
- Object
Defined in:
twilio/api/connect_apps_api.crConstant Summary
-
DELETE_CONNECT_APP_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_CONNECT_APP_MAX_LENGTH_FOR_SID =
34 -
DELETE_CONNECT_APP_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_CONNECT_APP_MIN_LENGTH_FOR_SID =
34 -
DELETE_CONNECT_APP_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
DELETE_CONNECT_APP_PATTERN_FOR_SID =
/^CN[0-9a-fA-F]{32}$/ -
FETCH_CONNECT_APP_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_CONNECT_APP_MAX_LENGTH_FOR_SID =
34 -
FETCH_CONNECT_APP_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_CONNECT_APP_MIN_LENGTH_FOR_SID =
34 -
FETCH_CONNECT_APP_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_CONNECT_APP_PATTERN_FOR_SID =
/^CN[0-9a-fA-F]{32}$/ -
LIST_CONNECT_APP_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_CONNECT_APP_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_CONNECT_APP_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_CONNECT_APP_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_CONNECT_APP_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_CONNECT_APP_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_CONNECT_APP_MAX_LENGTH_FOR_SID =
34 -
UPDATE_CONNECT_APP_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_CONNECT_APP_MIN_LENGTH_FOR_SID =
34 -
UPDATE_CONNECT_APP_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_CONNECT_APP_PATTERN_FOR_SID =
/^CN[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_delete_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_connect_app(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, authorize_redirect_url : String | Nil = nil, company_name : String | Nil = nil, deauthorize_callback_method : Twilio::HttpMethod | Nil = nil, deauthorize_callback_url : String | Nil = nil, description : String | Nil = nil, friendly_name : String | Nil = nil, homepage_url : String | Nil = nil, permissions : Array(ConnectAppEnumPermission) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#delete_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#delete_connect_app_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#fetch_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::ConnectApp
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#fetch_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#fetch_connect_app_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::ConnectApp, Int32, Hash(String, Array(String) | String))
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch.
-
#list_connect_app(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Twilio::ListConnectAppResponse
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read.
-
#list_connect_app(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read.
-
#list_connect_app_with_http_info(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListConnectAppResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read.
-
#update_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, authorize_redirect_url : String | Nil = nil, company_name : String | Nil = nil, deauthorize_callback_method : Twilio::HttpMethod | Nil = nil, deauthorize_callback_url : String | Nil = nil, description : String | Nil = nil, friendly_name : String | Nil = nil, homepage_url : String | Nil = nil, permissions : Array(ConnectAppEnumPermission) | Nil = nil) : Twilio::ConnectApp
Update a connect-app with the specified parameters @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
-
#update_connect_app(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, authorize_redirect_url : String | Nil = nil, company_name : String | Nil = nil, deauthorize_callback_method : Twilio::HttpMethod | Nil = nil, deauthorize_callback_url : String | Nil = nil, description : String | Nil = nil, friendly_name : String | Nil = nil, homepage_url : String | Nil = nil, permissions : Array(ConnectAppEnumPermission) | Nil = nil, &block : Crest::Response -> ) : Nil
Update a connect-app with the specified parameters @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
-
#update_connect_app_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, authorize_redirect_url : String | Nil = nil, company_name : String | Nil = nil, deauthorize_callback_method : Twilio::HttpMethod | Nil = nil, deauthorize_callback_url : String | Nil = nil, description : String | Nil = nil, friendly_name : String | Nil = nil, homepage_url : String | Nil = nil, permissions : Array(ConnectAppEnumPermission) | Nil = nil) : Tuple(Twilio::ConnectApp, Int32, Hash(String, Array(String) | String))
Update a connect-app with the specified parameters @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return [Nil]
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return nil
Delete an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return [Twilio::ConnectApp]
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return nil
Fetch an instance of a connect-app @required @param account_sid [String?] The SID of the Account that created the ConnectApp resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. @return [Tuple(Twilio::ConnectApp, Integer, Hash)] Twilio::ConnectApp, response status code and response headers
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListConnectAppResponse]
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil
Retrieve a list of connect-apps belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListConnectAppResponse, Integer, Hash)] Twilio::ListConnectAppResponse, response status code and response headers
Update a connect-app with the specified parameters
@required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to update.
@optional @param authorize_redirect_url [String?] The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
@optional @param company_name [String?] The company name to set for the Connect App.
@optional @param deauthorize_callback_method [Twilio::HttpMethod?]
@optional @param deauthorize_callback_url [String?] The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
@optional @param description [String?] A description of the Connect App.
@optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@optional @param homepage_url [String?] A public URL where users can obtain more information about this Connect App.
@optional @param permissions [Array(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 [Twilio::ConnectApp]
Update a connect-app with the specified parameters
@required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to update.
@optional @param authorize_redirect_url [String?] The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
@optional @param company_name [String?] The company name to set for the Connect App.
@optional @param deauthorize_callback_method [Twilio::HttpMethod?]
@optional @param deauthorize_callback_url [String?] The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
@optional @param description [String?] A description of the Connect App.
@optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@optional @param homepage_url [String?] A public URL where users can obtain more information about this Connect App.
@optional @param permissions [Array(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 nil
Update a connect-app with the specified parameters
@required @param account_sid [String?] The SID of the Account that created the ConnectApp resources to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the ConnectApp resource to update.
@optional @param authorize_redirect_url [String?] The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
@optional @param company_name [String?] The company name to set for the Connect App.
@optional @param deauthorize_callback_method [Twilio::HttpMethod?]
@optional @param deauthorize_callback_url [String?] The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
@optional @param description [String?] A description of the Connect App.
@optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@optional @param homepage_url [String?] A public URL where users can obtain more information about this Connect App.
@optional @param permissions [Array(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 [Tuple(Twilio::ConnectApp, Integer, Hash)] Twilio::ConnectApp, response status code and response headers