class Twilio::KeysApi

Defined in:

twilio/api/keys_api.cr

Constant Summary

CREATE_NEW_KEY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_NEW_KEY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_NEW_KEY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_KEY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_KEY_MAX_LENGTH_FOR_SID = 34
DELETE_KEY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_KEY_MIN_LENGTH_FOR_SID = 34
DELETE_KEY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_KEY_PATTERN_FOR_SID = /^SK[0-9a-fA-F]{32}$/
FETCH_KEY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_KEY_MAX_LENGTH_FOR_SID = 34
FETCH_KEY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_KEY_MIN_LENGTH_FOR_SID = 34
FETCH_KEY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_KEY_PATTERN_FOR_SID = /^SK[0-9a-fA-F]{32}$/
LIST_KEY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_KEY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_KEY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_KEY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_KEY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_KEY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_KEY_MAX_LENGTH_FOR_SID = 34
UPDATE_KEY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_KEY_MIN_LENGTH_FOR_SID = 34
UPDATE_KEY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_KEY_PATTERN_FOR_SID = /^SK[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_new_key(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil) : Crest::Request #

@return Crest::Request


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

@return Crest::Request


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

@return Crest::Request


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

@return Crest::Request


[View source]
def build_api_request_for_update_key(*, 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_new_key(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil) : Twilio::NewKey #

@required @param account_sid [String?] The SID of the Account that will be responsible for the new Key resource. @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::NewKey]


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

@required @param account_sid [String?] The SID of the Account that will be responsible for the new Key resource. @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 create_new_key_with_http_info(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil) : Tuple(Twilio::NewKey, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that will be responsible for the new Key resource. @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::NewKey, Integer, Hash)] Twilio::NewKey, response status code and response headers


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

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

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

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


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

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


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

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


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

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


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

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


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

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


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

@required @param account_sid [String?] The SID of the Account that created the Key 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::ListKeyResponse]


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

@required @param account_sid [String?] The SID of the Account that created the Key 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_key_with_http_info(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListKeyResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the Key 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::ListKeyResponse, Integer, Hash)] Twilio::ListKeyResponse, response status code and response headers


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

@required @param account_sid [String?] The SID of the Account that created the Key resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Key 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::Key]


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

@required @param account_sid [String?] The SID of the Account that created the Key resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Key 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_key_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : String | Nil = nil) : Tuple(Twilio::Key, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the Key resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Key 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::Key, Integer, Hash)] Twilio::Key, response status code and response headers


[View source]