lib/twilio-ruby/rest/api/v2010/account.rb in twilio-ruby-5.9.0 vs lib/twilio-ruby/rest/api/v2010/account.rb in twilio-ruby-5.10.0
- old
+ new
@@ -45,12 +45,12 @@
# Lists AccountInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [String] friendly_name Only return the Account resources with friendly
# names that exactly match this name.
- # @param [String] status Only return Account resources with the given status. Can
- # be `closed`, `suspended` or `active`.
+ # @param [account.Status] status Only return Account resources with the given
+ # status. Can be `closed`, `suspended` or `active`.
# @param [Integer] limit Upper limit for the number of records to return. stream()
# guarantees to never return more than limit. Default is no limit
# @param [Integer] page_size Number of records to fetch per request, when
# not set will use the default value of 50 records. If no page_size is defined
# but a limit is defined, stream() will attempt to read the limit with the most
@@ -69,12 +69,12 @@
# Streams AccountInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] friendly_name Only return the Account resources with friendly
# names that exactly match this name.
- # @param [String] status Only return Account resources with the given status. Can
- # be `closed`, `suspended` or `active`.
+ # @param [account.Status] status Only return Account resources with the given
+ # status. Can be `closed`, `suspended` or `active`.
# @param [Integer] limit Upper limit for the number of records to return. stream()
# guarantees to never return more than limit. Default is no limit.
# @param [Integer] page_size Number of records to fetch per request, when
# not set will use the default value of 50 records. If no page_size is defined
# but a limit is defined, stream() will attempt to read the limit with the most
@@ -105,12 +105,12 @@
##
# Retrieve a single page of AccountInstance records from the API.
# Request is executed immediately.
# @param [String] friendly_name Only return the Account resources with friendly
# names that exactly match this name.
- # @param [String] status Only return Account resources with the given status. Can
- # be `closed`, `suspended` or `active`.
+ # @param [account.Status] status Only return Account resources with the given
+ # status. Can be `closed`, `suspended` or `active`.
# @param [String] page_token PageToken provided by the API
# @param [Integer] page_number Page Number, this value is simply for client state
# @param [Integer] page_size Number of records to return, defaults to 50
# @return [Page] Page of AccountInstance
def page(friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
@@ -235,11 +235,13 @@
##
# Update the AccountInstance
# @param [String] friendly_name Update the human-readable description of this
# Account
- # @param [String] status Alter the status of this account with a given Status
+ # @param [account.Status] status Alter the status of this account: use `closed` to
+ # irreversibly close this account, `suspended` to temporarily suspend it, or
+ # `active` to reactivate it.
# @return [AccountInstance] Updated AccountInstance
def update(friendly_name: :unset, status: :unset)
data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Status' => status, })
payload = @version.update(
@@ -716,11 +718,11 @@
def sid
@properties['sid']
end
##
- # @return [String] The status of this account
+ # @return [account.Status] The status of this account
def status
@properties['status']
end
##
@@ -750,10 +752,12 @@
##
# Update the AccountInstance
# @param [String] friendly_name Update the human-readable description of this
# Account
- # @param [String] status Alter the status of this account with a given Status
+ # @param [account.Status] status Alter the status of this account: use `closed` to
+ # irreversibly close this account, `suspended` to temporarily suspend it, or
+ # `active` to reactivate it.
# @return [AccountInstance] Updated AccountInstance
def update(friendly_name: :unset, status: :unset)
context.update(friendly_name: friendly_name, status: status, )
end
\ No newline at end of file