class Twilio::AddressesApi
- Twilio::AddressesApi
- Reference
- Object
Defined in:
twilio/api/addresses_api.crConstant Summary
-
CREATE_ADDRESS_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
CREATE_ADDRESS_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
CREATE_ADDRESS_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
DELETE_ADDRESS_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_ADDRESS_MAX_LENGTH_FOR_SID =
34 -
DELETE_ADDRESS_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_ADDRESS_MIN_LENGTH_FOR_SID =
34 -
DELETE_ADDRESS_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
DELETE_ADDRESS_PATTERN_FOR_SID =
/^AD[0-9a-fA-F]{32}$/ -
FETCH_ADDRESS_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_ADDRESS_MAX_LENGTH_FOR_SID =
34 -
FETCH_ADDRESS_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_ADDRESS_MIN_LENGTH_FOR_SID =
34 -
FETCH_ADDRESS_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_ADDRESS_PATTERN_FOR_SID =
/^AD[0-9a-fA-F]{32}$/ -
LIST_ADDRESS_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_ADDRESS_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_ADDRESS_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_ADDRESS_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_ADDRESS_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
LIST_DEPENDENT_PHONE_NUMBER_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_DEPENDENT_PHONE_NUMBER_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_DEPENDENT_PHONE_NUMBER_MAX_LENGTH_FOR_ADDRESS_SID =
34 -
LIST_DEPENDENT_PHONE_NUMBER_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_DEPENDENT_PHONE_NUMBER_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_DEPENDENT_PHONE_NUMBER_MIN_LENGTH_FOR_ADDRESS_SID =
34 -
LIST_DEPENDENT_PHONE_NUMBER_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
LIST_DEPENDENT_PHONE_NUMBER_PATTERN_FOR_ADDRESS_SID =
/^AD[0-9a-fA-F]{32}$/ -
UPDATE_ADDRESS_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_ADDRESS_MAX_LENGTH_FOR_SID =
34 -
UPDATE_ADDRESS_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_ADDRESS_MIN_LENGTH_FOR_SID =
34 -
UPDATE_ADDRESS_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_ADDRESS_PATTERN_FOR_SID =
/^AD[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_create_address(*, account_sid : String | Nil = @account_sid, city : String | Nil = nil, customer_name : String | Nil = nil, iso_country : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, auto_correct_address : Bool | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, street_secondary : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_address(*, account_sid : String | Nil = @account_sid, customer_name : String | Nil = nil, friendly_name : String | Nil = nil, iso_country : String | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_dependent_phone_number(*, account_sid : String | Nil = @account_sid, address_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, auto_correct_address : Bool | Nil = nil, city : String | Nil = nil, customer_name : String | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, street_secondary : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
-
#create_address(*, account_sid : String | Nil = @account_sid, city : String | Nil = nil, customer_name : String | Nil = nil, iso_country : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, auto_correct_address : Bool | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, street_secondary : String | Nil = nil) : Twilio::Address
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
-
#create_address(*, account_sid : String | Nil = @account_sid, city : String | Nil = nil, customer_name : String | Nil = nil, iso_country : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, auto_correct_address : Bool | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, street_secondary : String | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
-
#create_address_with_http_info(*, account_sid : String | Nil = @account_sid, city : String | Nil = nil, customer_name : String | Nil = nil, iso_country : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, auto_correct_address : Bool | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, street_secondary : String | Nil = nil) : Tuple(Twilio::Address, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to delete.
-
#delete_address(*, 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 is responsible for the Address resource to delete.
-
#delete_address_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 is responsible for the Address resource to delete.
-
#fetch_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::Address
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to fetch.
-
#fetch_address(*, 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 is responsible for the Address resource to fetch.
-
#fetch_address_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::Address, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to fetch.
-
#list_address(*, account_sid : String | Nil = @account_sid, customer_name : String | Nil = nil, friendly_name : String | Nil = nil, iso_country : String | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAddressResponse
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
-
#list_address(*, account_sid : String | Nil = @account_sid, customer_name : String | Nil = nil, friendly_name : String | Nil = nil, iso_country : String | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
-
#list_address_with_http_info(*, account_sid : String | Nil = @account_sid, customer_name : String | Nil = nil, friendly_name : String | Nil = nil, iso_country : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAddressResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
-
#list_dependent_phone_number(*, account_sid : String | Nil = @account_sid, address_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListDependentPhoneNumberResponse
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read.
-
#list_dependent_phone_number(*, account_sid : String | Nil = @account_sid, address_sid : String | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read.
-
#list_dependent_phone_number_with_http_info(*, account_sid : String | Nil = @account_sid, address_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListDependentPhoneNumberResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read.
-
#update_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, auto_correct_address : Bool | Nil = nil, city : String | Nil = nil, customer_name : String | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, street_secondary : String | Nil = nil) : Twilio::Address
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
-
#update_address(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, auto_correct_address : Bool | Nil = nil, city : String | Nil = nil, customer_name : String | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, street_secondary : String | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
-
#update_address_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, auto_correct_address : Bool | Nil = nil, city : String | Nil = nil, customer_name : String | Nil = nil, emergency_enabled : Bool | Nil = nil, friendly_name : String | Nil = nil, postal_code : String | Nil = nil, region : String | Nil = nil, street : String | Nil = nil, street_secondary : String | Nil = nil) : Tuple(Twilio::Address, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
@required @param city [String?] The city of the new address.
@required @param customer_name [String?] The name to associate with the new address.
@required @param iso_country [String?] The ISO country code of the new address.
@required @param postal_code [String?] The postal code of the new address.
@required @param region [String?] The state or region of the new address.
@required @param street [String?] The number and street address of the new address.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the new address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the new address. It can be up to 64 characters long.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return [Twilio::Address]
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
@required @param city [String?] The city of the new address.
@required @param customer_name [String?] The name to associate with the new address.
@required @param iso_country [String?] The ISO country code of the new address.
@required @param postal_code [String?] The postal code of the new address.
@required @param region [String?] The state or region of the new address.
@required @param street [String?] The number and street address of the new address.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the new address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the new address. It can be up to 64 characters long.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return nil
@required @param account_sid [String?] The SID of the Account that will be responsible for the new Address resource.
@required @param city [String?] The city of the new address.
@required @param customer_name [String?] The name to associate with the new address.
@required @param iso_country [String?] The ISO country code of the new address.
@required @param postal_code [String?] The postal code of the new address.
@required @param region [String?] The state or region of the new address.
@required @param street [String?] The number and street address of the new address.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the new address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the new address. It can be up to 64 characters long.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return [Tuple(Twilio::Address, Integer, Hash)] Twilio::Address, response status code and response headers
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to delete. @return [Nil]
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to delete. @return nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to delete. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to fetch. @return [Twilio::Address]
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to fetch. @return nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to fetch. @return [Tuple(Twilio::Address, Integer, Hash)] Twilio::Address, response status code and response headers
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
@optional @param customer_name [String?] The customer_name of the Address resources to read.
@optional @param friendly_name [String?] The string that identifies the Address resources to read.
@optional @param iso_country [String?] The ISO country code of the Address 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::ListAddressResponse]
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
@optional @param customer_name [String?] The customer_name of the Address resources to read.
@optional @param friendly_name [String?] The string that identifies the Address resources to read.
@optional @param iso_country [String?] The ISO country code of the Address 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
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to read.
@optional @param customer_name [String?] The customer_name of the Address resources to read.
@optional @param friendly_name [String?] The string that identifies the Address resources to read.
@optional @param iso_country [String?] The ISO country code of the Address 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::ListAddressResponse, Integer, Hash)] Twilio::ListAddressResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read. @required @param address_sid [String?] The SID of the Address resource associated with the phone number. @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::ListDependentPhoneNumberResponse]
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read. @required @param address_sid [String?] The SID of the Address resource associated with the phone number. @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
@required @param account_sid [String?] The SID of the Account that created the DependentPhoneNumber resources to read. @required @param address_sid [String?] The SID of the Address resource associated with the phone number. @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::ListDependentPhoneNumberResponse, Integer, Hash)] Twilio::ListDependentPhoneNumberResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to update.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param city [String?] The city of the address.
@optional @param customer_name [String?] The name to associate with the address.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the address. It can be up to 64 characters long.
@optional @param postal_code [String?] The postal code of the address.
@optional @param region [String?] The state or region of the address.
@optional @param street [String?] The number and street address of the address.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return [Twilio::Address]
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to update.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param city [String?] The city of the address.
@optional @param customer_name [String?] The name to associate with the address.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the address. It can be up to 64 characters long.
@optional @param postal_code [String?] The postal code of the address.
@optional @param region [String?] The state or region of the address.
@optional @param street [String?] The number and street address of the address.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return nil
@required @param account_sid [String?] The SID of the Account that is responsible for the Address resource to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Address resource to update.
@optional @param auto_correct_address [Bool?] Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won't alter the address you provide.
@optional @param city [String?] The city of the address.
@optional @param customer_name [String?] The name to associate with the address.
@optional @param emergency_enabled [Bool?] Whether to enable emergency calling on the address. Can be: true or false.
@optional @param friendly_name [String?] A descriptive string that you create to describe the address. It can be up to 64 characters long.
@optional @param postal_code [String?] The postal code of the address.
@optional @param region [String?] The state or region of the address.
@optional @param street [String?] The number and street address of the address.
@optional @param street_secondary [String?] The additional number and street address of the address.
@return [Tuple(Twilio::Address, Integer, Hash)] Twilio::Address, response status code and response headers