class Twilio::OutgoingCallerIdsApi

Defined in:

twilio/api/outgoing_caller_ids_api.cr

Constant Summary

CREATE_VALIDATION_REQUEST_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_VALIDATION_REQUEST_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_VALIDATION_REQUEST_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_SID = 34
DELETE_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_SID = 34
DELETE_OUTGOING_CALLER_ID_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_OUTGOING_CALLER_ID_PATTERN_FOR_SID = /^PN[0-9a-fA-F]{32}$/
FETCH_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_SID = 34
FETCH_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_SID = 34
FETCH_OUTGOING_CALLER_ID_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_OUTGOING_CALLER_ID_PATTERN_FOR_SID = /^PN[0-9a-fA-F]{32}$/
LIST_OUTGOING_CALLER_ID_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_OUTGOING_CALLER_ID_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_OUTGOING_CALLER_ID_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_OUTGOING_CALLER_ID_MAX_LENGTH_FOR_SID = 34
UPDATE_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_OUTGOING_CALLER_ID_MIN_LENGTH_FOR_SID = 34
UPDATE_OUTGOING_CALLER_ID_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_OUTGOING_CALLER_ID_PATTERN_FOR_SID = /^PN[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_validation_request(*, account_sid : String | Nil = @account_sid, phone_number : String | Nil = nil, call_delay : Int32 | Nil = nil, extension : String | Nil = nil, friendly_name : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil) : Crest::Request #

@return Crest::Request


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

@return Crest::Request


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

@return Crest::Request


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

@return Crest::Request


[View source]
def build_api_request_for_update_outgoing_caller_id(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : 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_validation_request(*, account_sid : String | Nil = @account_sid, phone_number : String | Nil = nil, call_delay : Int32 | Nil = nil, extension : String | Nil = nil, friendly_name : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil) : Twilio::ValidationRequest #

@required @param account_sid [String?] The SID of the Account responsible for the new caller ID resource. @required @param phone_number [String?] The phone number to verify in E.164 format, which consists of a + followed by the country code and subscriber number. @optional @param call_delay [Int32?] The number of seconds to delay before initiating the verification call. Can be an integer between 0 and 60, inclusive. The default is 0. @optional @param extension [String?] The digits to dial after connecting the verification call. @optional @param friendly_name [String?] A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information about the verification process to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @return [Twilio::ValidationRequest]


[View source]
def create_validation_request(*, account_sid : String | Nil = @account_sid, phone_number : String | Nil = nil, call_delay : Int32 | Nil = nil, extension : String | Nil = nil, friendly_name : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account responsible for the new caller ID resource. @required @param phone_number [String?] The phone number to verify in E.164 format, which consists of a + followed by the country code and subscriber number. @optional @param call_delay [Int32?] The number of seconds to delay before initiating the verification call. Can be an integer between 0 and 60, inclusive. The default is 0. @optional @param extension [String?] The digits to dial after connecting the verification call. @optional @param friendly_name [String?] A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information about the verification process to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @return nil


[View source]
def create_validation_request_with_http_info(*, account_sid : String | Nil = @account_sid, phone_number : String | Nil = nil, call_delay : Int32 | Nil = nil, extension : String | Nil = nil, friendly_name : String | Nil = nil, status_callback : String | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil) : Tuple(Twilio::ValidationRequest, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account responsible for the new caller ID resource. @required @param phone_number [String?] The phone number to verify in E.164 format, which consists of a + followed by the country code and subscriber number. @optional @param call_delay [Int32?] The number of seconds to delay before initiating the verification call. Can be an integer between 0 and 60, inclusive. The default is 0. @optional @param extension [String?] The digits to dial after connecting the verification call. @optional @param friendly_name [String?] A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number. @optional @param status_callback [String?] The URL we should call using the status_callback_method to send status information about the verification process to your application. @optional @param status_callback_method [Twilio::HttpMethod?] @return [Tuple(Twilio::ValidationRequest, Integer, Hash)] Twilio::ValidationRequest, response status code and response headers


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

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

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

Delete the caller-id specified from the account @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete. @return [Nil]


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

Delete the caller-id specified from the account @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete. @return nil


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

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


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

Fetch an outgoing-caller-id belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch. @return [Twilio::OutgoingCallerId]


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

Fetch an outgoing-caller-id belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch. @return nil


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

Fetch an outgoing-caller-id belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch. @return [Tuple(Twilio::OutgoingCallerId, Integer, Hash)] Twilio::OutgoingCallerId, response status code and response headers


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

Retrieve a list of outgoing-caller-ids belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to read. @optional @param phone_number [String?] The phone number of the OutgoingCallerId resources to read. @optional @param friendly_name [String?] The string that identifies the OutgoingCallerId 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::ListOutgoingCallerIdResponse]


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

Retrieve a list of outgoing-caller-ids belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to read. @optional @param phone_number [String?] The phone number of the OutgoingCallerId resources to read. @optional @param friendly_name [String?] The string that identifies the OutgoingCallerId 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_outgoing_caller_id_with_http_info(*, account_sid : String | Nil = @account_sid, phone_number : String | Nil = nil, friendly_name : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListOutgoingCallerIdResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of outgoing-caller-ids belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to read. @optional @param phone_number [String?] The phone number of the OutgoingCallerId resources to read. @optional @param friendly_name [String?] The string that identifies the OutgoingCallerId 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::ListOutgoingCallerIdResponse, Integer, Hash)] Twilio::ListOutgoingCallerIdResponse, response status code and response headers


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

Updates the caller-id @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return [Twilio::OutgoingCallerId]


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

Updates the caller-id @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return nil


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

Updates the caller-id @required @param account_sid [String?] The SID of the Account that created the OutgoingCallerId resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return [Tuple(Twilio::OutgoingCallerId, Integer, Hash)] Twilio::OutgoingCallerId, response status code and response headers


[View source]