twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/api/v2010/account/token.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the TokenList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that created this
-            #   Token.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token
+            #   resource.
             # @return [TokenList] TokenList
             def initialize(version, account_sid: nil)
               super(version)
@@ -25,21 +28,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TokenInstance records from the API.
-            # Request is executed immediately.
+            # Create the TokenInstance
             # @param [String] ttl The duration in seconds for which the generated credentials
-            #   are valid
-            # @return [TokenInstance] Newly created TokenInstance
+            #   are valid. The default value is 86400 (24 hours).
+            # @return [TokenInstance] Created TokenInstance
             def create(ttl: :unset)
-              data = Twilio::Values.of({'Ttl' => ttl})
+              data = Twilio::Values.of({'Ttl' => ttl, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -68,7 +66,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TokenInstance] TokenInstance
             def get_instance(payload)
-              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -83,8 +81,9 @@ module Twilio
             # Initialize the TokenInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The unique id of the Account that created this
-            #   Token.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token
+            #   resource.
             # @return [TokenInstance] TokenInstance
             def initialize(version, payload, account_sid: nil)
               super(version)
@@ -102,25 +101,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] An array representing the ephemeral credentials
+            # @return [Array[String]] An array representing the ephemeral credentials
             def ice_servers
               @properties['ice_servers']
             end
@@ -138,7 +137,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The temporary username that uniquely identifies a Token.
+            # @return [String] The temporary username that uniquely identifies a Token
             def username
               @properties['username']
             end

data/lib/twilio-ruby/rest/api/v2010/account/transcription.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the TranscriptionList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   transcription.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Transcription resource.
             # @return [TranscriptionList] TranscriptionList
             def initialize(version, account_sid: nil)
               super(version)
@@ -53,7 +56,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -65,7 +68,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -85,11 +88,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TranscriptionPage.new(@version, response, @solution)
             end
 
@@ -132,7 +133,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TranscriptionInstance] TranscriptionInstance
             def get_instance(payload)
-              TranscriptionInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              TranscriptionInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -146,28 +147,25 @@ module Twilio
             ##
             # Initialize the TranscriptionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The transcription Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Transcription resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Transcription resource to fetch.
             # @return [TranscriptionContext] TranscriptionContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/Transcriptions/#{@solution[:sid]}.json"
             end
 
             ##
-            # Fetch a TranscriptionInstance
+            # Fetch the TranscriptionInstance
             # @return [TranscriptionInstance] Fetched TranscriptionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TranscriptionInstance.new(
                   @version,
@@ -178,10 +176,10 @@ module Twilio
             end
 
             ##
-            # Deletes the TranscriptionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TranscriptionInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -190,6 +188,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
+            end
           end
 
           class TranscriptionInstance < InstanceResource
@@ -197,9 +202,11 @@ module Twilio
             # Initialize the TranscriptionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   transcription.
-            # @param [String] sid The transcription Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Transcription resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Transcription resource to fetch.
             # @return [TranscriptionInstance] TranscriptionInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -223,7 +230,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -232,61 +239,61 @@ module Twilio
             # @return [TranscriptionContext] TranscriptionContext for this TranscriptionInstance
             def context
               unless @instance_context
-                @instance_context = TranscriptionContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = TranscriptionContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The api_version
+            # @return [String] The API version used to create the transcription
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The duration of the transcribed audio, in seconds.
+            # @return [String] The duration of the transcribed audio in seconds.
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [String] The charge for this transcription
+            # @return [String] The charge for the transcription
             def price
               @properties['price']
             end
 
             ##
-            # @return [String] The currency in which Price is measured
+            # @return [String] The currency in which price is measured
             def price_unit
               @properties['price_unit']
             end
 
             ##
-            # @return [String] The string that uniquely identifies the recording
+            # @return [String] The SID that identifies the transcription's recording
             def recording_sid
               @properties['recording_sid']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this transcription
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
@@ -304,27 +311,27 @@ module Twilio
             end
 
             ##
-            # @return [String] The type
+            # @return [String] The transcription type
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # Fetch a TranscriptionInstance
+            # Fetch the TranscriptionInstance
             # @return [TranscriptionInstance] Fetched TranscriptionInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the TranscriptionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TranscriptionInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -30,9 +32,22 @@ module Twilio
                 # Lists AllTimeInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [all_time.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [all_time.Category] category The {usage
+                #   category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]
+                #   of the UsageRecord resources to read. Only UsageRecord resources in the
+                #   specified category are retrieved.
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify
+                #   offsets from the current date, such as: `-30days`, which will set the start date
+                #   to be 30 days before the current date.
+                # @param [Date] end_date Only include usage that occurred on or before this date.
+                #   Specify the date in GMT and format as `YYYY-MM-DD`.  You can also specify
+                #   offsets from the current date, such as: `+30days`, which will set the end date
+                #   to 30 days from the current date.
+                # @param [Boolean] include_subaccounts Whether to include usage from the master
+                #   account and all its subaccounts. Can be: `true` (the default) to include usage
+                #   from the master account and all subaccounts or `false` to retrieve usage from
+                #   only the specified account.
                 # @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
@@ -40,11 +55,12 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Array] Array of up to limit results
-                def list(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                def list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil)
                   self.stream(
                       category: category,
                       start_date: start_date,
                       end_date: end_date,
+                      include_subaccounts: include_subaccounts,
                       limit: limit,
                       page_size: page_size
                   ).entries
@@ -54,9 +70,22 @@ module Twilio
                 # Streams AllTimeInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [all_time.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [all_time.Category] category The {usage
+                #   category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]
+                #   of the UsageRecord resources to read. Only UsageRecord resources in the
+                #   specified category are retrieved.
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify
+                #   offsets from the current date, such as: `-30days`, which will set the start date
+                #   to be 30 days before the current date.
+                # @param [Date] end_date Only include usage that occurred on or before this date.
+                #   Specify the date in GMT and format as `YYYY-MM-DD`.  You can also specify
+                #   offsets from the current date, such as: `+30days`, which will set the end date
+                #   to 30 days from the current date.
+                # @param [Boolean] include_subaccounts Whether to include usage from the master
+                #   account and all its subaccounts. Can be: `true` (the default) to include usage
+                #   from the master account and all subaccounts or `false` to retrieve usage from
+                #   only the specified account.
                 # @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
@@ -64,13 +93,14 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Enumerable] Enumerable that will yield up to limit results
-                def stream(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                def stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil)
                   limits = @version.read_limits(limit, page_size)
 
                   page = self.page(
                       category: category,
                       start_date: start_date,
                       end_date: end_date,
+                      include_subaccounts: include_subaccounts,
                       page_size: limits[:page_size],
                   )
 
@@ -84,7 +114,7 @@ module Twilio
                 def each
                   limits = @version.read_limits
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page,
                                   limit: limits[:limit],
@@ -94,27 +124,39 @@ module Twilio
                 ##
                 # Retrieve a single page of AllTimeInstance records from the API.
                 # Request is executed immediately.
-                # @param [all_time.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [all_time.Category] category The {usage
+                #   category}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]
+                #   of the UsageRecord resources to read. Only UsageRecord resources in the
+                #   specified category are retrieved.
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify
+                #   offsets from the current date, such as: `-30days`, which will set the start date
+                #   to be 30 days before the current date.
+                # @param [Date] end_date Only include usage that occurred on or before this date.
+                #   Specify the date in GMT and format as `YYYY-MM-DD`.  You can also specify
+                #   offsets from the current date, such as: `+30days`, which will set the end date
+                #   to 30 days from the current date.
+                # @param [Boolean] include_subaccounts Whether to include usage from the master
+                #   account and all its subaccounts. Can be: `true` (the default) to include usage
+                #   from the master account and all subaccounts or `false` to retrieve usage from
+                #   only the specified account.
                 # @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 AllTimeInstance
-                def page(category: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                def page(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                   params = Twilio::Values.of({
                       'Category' => category,
                       'StartDate' => Twilio.serialize_iso8601_date(start_date),
                       'EndDate' => Twilio.serialize_iso8601_date(end_date),
+                      'IncludeSubaccounts' => include_subaccounts,
                       'PageToken' => page_token,
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   AllTimePage.new(@version, response, @solution)
                 end
 
@@ -157,7 +199,7 @@ module Twilio
                 # @param [Hash] payload Payload response from the API
                 # @return [AllTimeInstance] AllTimeInstance
                 def get_instance(payload)
-                  AllTimeInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                  AllTimeInstance.new(@version, payload, account_sid: @solution[:account_sid], )
                 end
 
                 ##
@@ -182,6 +224,7 @@ module Twilio
                   @properties = {
                       'account_sid' => payload['account_sid'],
                       'api_version' => payload['api_version'],
+                      'as_of' => payload['as_of'],
                       'category' => payload['category'],
                       'count' => payload['count'],
                       'count_unit' => payload['count_unit'],
@@ -198,85 +241,91 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The SID of the Account accrued the usage
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The api_version
+                # @return [String] The API version used to create the resource
                 def api_version
                   @properties['api_version']
                 end
 
                 ##
-                # @return [all_time.Category] The category
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
+                ##
+                # @return [all_time.Category] The category of usage
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The count
+                # @return [String] The number of usage events
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The count_unit
+                # @return [String] The units in which count is measured
                 def count_unit
                   @properties['count_unit']
                 end
 
                 ##
-                # @return [String] The description
+                # @return [String] A plain-language description of the usage category
                 def description
                   @properties['description']
                 end
 
                 ##
-                # @return [Date] The end_date
+                # @return [Date] The last date for which usage is included in the UsageRecord
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The price
+                # @return [String] The total price of the usage
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The price_unit
+                # @return [String] The currency in which `price` is measured
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The start_date
+                # @return [Date] The first date for which usage is included in this UsageRecord
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] A list of related resources identified by their relative URIs
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The usage
+                # @return [String] The amount of usage
                 def usage
                   @properties['usage']
                 end
 
                 ##
-                # @return [String] The usage_unit
+                # @return [String] The units in which usage is measured
                 def usage_unit
                   @properties['usage_unit']
                 end