class Twilio::ApplicationsApi

Defined in:

twilio/api/applications_api.cr

Constant Summary

CREATE_APPLICATION_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_APPLICATION_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_APPLICATION_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_APPLICATION_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_APPLICATION_MAX_LENGTH_FOR_SID = 34
DELETE_APPLICATION_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_APPLICATION_MIN_LENGTH_FOR_SID = 34
DELETE_APPLICATION_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_APPLICATION_PATTERN_FOR_SID = /^AP[0-9a-fA-F]{32}$/
FETCH_APPLICATION_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_APPLICATION_MAX_LENGTH_FOR_SID = 34
FETCH_APPLICATION_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_APPLICATION_MIN_LENGTH_FOR_SID = 34
FETCH_APPLICATION_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_APPLICATION_PATTERN_FOR_SID = /^AP[0-9a-fA-F]{32}$/
LIST_APPLICATION_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_APPLICATION_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_APPLICATION_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_APPLICATION_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_APPLICATION_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_APPLICATION_MAX_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_APPLICATION_MAX_LENGTH_FOR_SID = 34
UPDATE_APPLICATION_MIN_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_APPLICATION_MIN_LENGTH_FOR_SID = 34
UPDATE_APPLICATION_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_APPLICATION_PATTERN_FOR_SID = /^AP[0-9a-fA-F]{32}$/

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Twilio::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def account_sid : String #

[View source]
def account_sid=(account_sid : String) #

[View source]
def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_create_application(*, account_sid : String | Nil = @account_sid, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_fetch_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_application(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_update_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def create_application(*, account_sid : String | Nil = @account_sid, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Twilio::Application #

Create a new application within your account @required @param account_sid [String?] The SID of the Account that will create the resource. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is the account's default API version. @optional @param friendly_name [String?] A descriptive string that you create to describe the new application. It can be up to 64 characters long. @optional @param message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] The URL we should call using a POST method to send status information about SMS messages sent by the application. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return [Twilio::Application]


[View source]
def create_application(*, account_sid : String | Nil = @account_sid, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Create a new application within your account @required @param account_sid [String?] The SID of the Account that will create the resource. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is the account's default API version. @optional @param friendly_name [String?] A descriptive string that you create to describe the new application. It can be up to 64 characters long. @optional @param message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] The URL we should call using a POST method to send status information about SMS messages sent by the application. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return nil


[View source]
def create_application_with_http_info(*, account_sid : String | Nil = @account_sid, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Tuple(Twilio::Application, Int32, Hash(String, Array(String) | String)) #

Create a new application within your account @required @param account_sid [String?] The SID of the Account that will create the resource. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is the account's default API version. @optional @param friendly_name [String?] A descriptive string that you create to describe the new application. It can be up to 64 characters long. @optional @param message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] The URL we should call using a POST method to send status information about SMS messages sent by the application. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return [Tuple(Twilio::Application, Integer, Hash)] Twilio::Application, response status code and response headers


[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil #

Delete the application by the specified application sid @required @param account_sid [String?] The SID of the Account that created the Application resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to delete. @return [Nil]


[View source]
def delete_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Delete the application by the specified application sid @required @param account_sid [String?] The SID of the Account that created the Application resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to delete. @return nil


[View source]
def delete_application_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Delete the application by the specified application sid @required @param account_sid [String?] The SID of the Account that created the Application resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to delete. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def fetch_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::Application #

Fetch the application specified by the provided sid @required @param account_sid [String?] The SID of the Account that created the Application resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to fetch. @return [Twilio::Application]


[View source]
def fetch_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Fetch the application specified by the provided sid @required @param account_sid [String?] The SID of the Account that created the Application resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to fetch. @return nil


[View source]
def fetch_application_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::Application, Int32, Hash(String, Array(String) | String)) #

Fetch the application specified by the provided sid @required @param account_sid [String?] The SID of the Account that created the Application resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to fetch. @return [Tuple(Twilio::Application, Integer, Hash)] Twilio::Application, response status code and response headers


[View source]
def list_application(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListApplicationResponse #

Retrieve a list of applications representing an application within the requesting account @required @param account_sid [String?] The SID of the Account that created the Application resources to read. @optional @param friendly_name [String?] The string that identifies the Application 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::ListApplicationResponse]


[View source]
def list_application(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Retrieve a list of applications representing an application within the requesting account @required @param account_sid [String?] The SID of the Account that created the Application resources to read. @optional @param friendly_name [String?] The string that identifies the Application 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


[View source]
def list_application_with_http_info(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListApplicationResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of applications representing an application within the requesting account @required @param account_sid [String?] The SID of the Account that created the Application resources to read. @optional @param friendly_name [String?] The string that identifies the Application 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::ListApplicationResponse, Integer, Hash)] Twilio::ListApplicationResponse, response status code and response headers


[View source]
def update_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Twilio::Application #

Updates the application's properties @required @param account_sid [String?] The SID of the Account that created the Application resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to update. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is your account's default API version. @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 message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return [Twilio::Application]


[View source]
def update_application(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Updates the application's properties @required @param account_sid [String?] The SID of the Account that created the Application resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to update. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is your account's default API version. @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 message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return nil


[View source]
def update_application_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, api_version : String | Nil = nil, friendly_name : String | Nil = nil, message_status_callback : String | Nil = nil, sms_fallback_method : Twilio::HttpMethod | Nil = nil, sms_fallback_url : String | Nil = nil, sms_method : Twilio::HttpMethod | Nil = nil, sms_status_callback : String | Nil = nil, sms_url : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, voice_caller_id_lookup : Bool | Nil = nil, voice_fallback_method : Twilio::HttpMethod | Nil = nil, voice_fallback_url : String | Nil = nil, voice_method : Twilio::HttpMethod | Nil = nil, voice_url : String | Nil = nil) : Tuple(Twilio::Application, Int32, Hash(String, Array(String) | String)) #

Updates the application's properties @required @param account_sid [String?] The SID of the Account that created the Application resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Application resource to update. @optional @param api_version [String?] The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is your account's default API version. @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 message_status_callback [String?] The URL we should call using a POST method to send message status information to your application. @optional @param sms_fallback_method [Twilio::HttpMethod?] @optional @param sms_fallback_url [String?] The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. @optional @param sms_method [Twilio::HttpMethod?] @optional @param sms_status_callback [String?] Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility. @optional @param sms_url [String?] The URL we should call when the phone number receives an incoming SMS message. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @optional @param voice_caller_id_lookup [Bool?] Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. @optional @param voice_fallback_method [Twilio::HttpMethod?] @optional @param voice_fallback_url [String?] The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. @optional @param voice_method [Twilio::HttpMethod?] @optional @param voice_url [String?] The URL we should call when the phone number assigned to this application receives a call. @return [Tuple(Twilio::Application, Integer, Hash)] Twilio::Application, response status code and response headers


[View source]