twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -32,8 +32,8 @@ module Twilio
                 # Lists YearlyInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yearly.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yearly.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
@@ -70,8 +70,8 @@ module Twilio
                 # Streams YearlyInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yearly.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yearly.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
@@ -124,8 +124,8 @@ module Twilio
                 ##
                 # Retrieve a single page of YearlyInstance records from the API.
                 # Request is executed immediately.
-                # @param [yearly.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yearly.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
@@ -154,11 +154,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   YearlyPage.new(@version, response, @solution)
                 end
 
@@ -226,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'],
@@ -253,6 +252,12 @@ module Twilio
                   @properties['api_version']
                 end
 
+                ##
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
                 ##
                 # @return [yearly.Category] The category of usage
                 def category

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -32,8 +32,8 @@ module Twilio
                 # Lists YesterdayInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yesterday.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yesterday.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
@@ -70,8 +70,8 @@ module Twilio
                 # Streams YesterdayInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yesterday.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yesterday.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
@@ -124,8 +124,8 @@ module Twilio
                 ##
                 # Retrieve a single page of YesterdayInstance records from the API.
                 # Request is executed immediately.
-                # @param [yesterday.Category] category The [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+                # @param [yesterday.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
@@ -154,11 +154,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   YesterdayPage.new(@version, response, @solution)
                 end
 
@@ -226,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'],
@@ -253,6 +252,12 @@ module Twilio
                   @properties['api_version']
                 end
 
+                ##
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
                 ##
                 # @return [yesterday.Category] The category of usage
                 def category

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -28,32 +28,32 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of TriggerInstance records from the API.
-              # Request is executed immediately.
+              # Create the TriggerInstance
               # @param [String] callback_url The URL we should call using `callback_method` when
               #   the trigger fires.
-              # @param [String] trigger_value The usage value at which the trigger should fire. 
+              # @param [String] trigger_value The usage value at which the trigger should fire.
               #   For convenience, you can use an offset value such as `+30` to specify a
               #   trigger_value that is 30 units more than the current usage value. Be sure to
               #   urlencode a `+` as `%2B`.
               # @param [trigger.UsageCategory] usage_category The usage category that the
-              #   trigger should watch.  Use one of the supported [usage
-              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories)
+              #   trigger should watch.  Use one of the supported {usage
+              #   categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories]
               #   for this value.
               # @param [String] callback_method The HTTP method we should use to call
               #   `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
               # @param [String] friendly_name A descriptive string that you create to describe
               #   the resource. It can be up to 64 characters long.
-              # @param [trigger.Recurring] recurring The frequency of a recurring UsageTrigger. 
+              # @param [trigger.Recurring] recurring The frequency of a recurring UsageTrigger.
               #   Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for
               #   non-recurring triggers. A trigger will only fire once during each period.
               #   Recurring times are in GMT.
               # @param [trigger.TriggerField] trigger_by The field in the
-              #   [UsageRecord](https://www.twilio.com/docs/api/rest/usage-records) resource that
+              #   {UsageRecord}[https://www.twilio.com/docs/usage/api/usage-record] resource that
               #   should fire the trigger.  Can be: `count`, `usage`, or `price` as described in
-              #   the [UsageRecords
-              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).  The default is `usage`.
-              # @return [TriggerInstance] Newly created TriggerInstance
+              #   the {UsageRecords
+              #   documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price].
+              #    The default is `usage`.
+              # @return [TriggerInstance] Created TriggerInstance
               def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset)
                 data = Twilio::Values.of({
                     'CallbackUrl' => callback_url,
@@ -65,11 +65,7 @@ module Twilio
                     'TriggerBy' => trigger_by,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
@@ -82,11 +78,11 @@ module Twilio
               #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
               #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
               # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
-              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
-              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the {UsageRecords
+              #   documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price].
               # @param [trigger.UsageCategory] usage_category The usage category of the
-              #   UsageTriggers to read. Must be a supported [usage
-              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+              #   UsageTriggers to read. Must be a supported {usage
+              #   categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories].
               # @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
@@ -112,11 +108,11 @@ module Twilio
               #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
               #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
               # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
-              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
-              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the {UsageRecords
+              #   documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price].
               # @param [trigger.UsageCategory] usage_category The usage category of the
-              #   UsageTriggers to read. Must be a supported [usage
-              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+              #   UsageTriggers to read. Must be a supported {usage
+              #   categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories].
               # @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
@@ -158,11 +154,11 @@ module Twilio
               #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
               #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
               # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
-              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
-              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the {UsageRecords
+              #   documentation}[https://www.twilio.com/docs/usage/api/usage-record#usage-count-price].
               # @param [trigger.UsageCategory] usage_category The usage category of the
-              #   UsageTriggers to read. Must be a supported [usage
-              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+              #   UsageTriggers to read. Must be a supported {usage
+              #   categories}[https://www.twilio.com/docs/usage/api/usage-record#usage-categories].
               # @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
@@ -176,11 +172,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 TriggerPage.new(@version, response, @solution)
               end
 
@@ -238,7 +232,7 @@ module Twilio
               # Initialize the TriggerContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
               #   UsageTrigger resource to fetch.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
               #   UsageTrigger resource to fetch.
@@ -252,16 +246,10 @@ module Twilio
               end
 
               ##
-              # Fetch a TriggerInstance
+              # Fetch the TriggerInstance
               # @return [TriggerInstance] Fetched TriggerInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
@@ -282,20 +270,16 @@ module Twilio
                     'FriendlyName' => friendly_name,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
 
               ##
-              # Deletes the TriggerInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the TriggerInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -304,6 +288,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.TriggerContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.TriggerContext #{context}>"
+              end
             end
 
             class TriggerInstance < InstanceResource
@@ -452,7 +443,7 @@ module Twilio
               end
 
               ##
-              # Fetch a TriggerInstance
+              # Fetch the TriggerInstance
               # @return [TriggerInstance] Fetched TriggerInstance
               def fetch
                 context.fetch
@@ -476,8 +467,8 @@ module Twilio
               end
 
               ##
-              # Deletes the TriggerInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the TriggerInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the ValidationRequestList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique ID of the
-            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-            #   Caller Id.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for the
+            #   Caller ID.
             # @return [ValidationRequestList] ValidationRequestList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,25 +28,24 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ValidationRequestInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] phone_number The phone number to verify. Should be formatted
-            #   with a '+' and country code e.g., +16175551212
-            #   ([E.164](http://en.wikipedia.org/wiki/E.164) format).  Twilio will also accept
-            #   unformatted US numbers e.g., (415) 555-1212, 415-555-1212.
-            # @param [String] friendly_name A human readable description for the new caller ID
-            #   with maximum length 64 characters. Defaults to a nicely formatted version of the
-            #   number.
-            # @param [String] call_delay The number of seconds, between 0 and 60, to delay
-            #   before initiating the verification call. Defaults to 0.
-            # @param [String] extension Digits to dial after connecting the verification call.
-            # @param [String] status_callback A URL that Twilio will request when the
-            #   verification call ends to notify your app if the verification process was
-            #   successful or not. See [StatusCallback
-            #   parameter](https://www.twilio.com/docs/api/voice/outgoing-caller-ids#statuscallback-parameter) below.
-            # @param [String] status_callback_method The HTTP method Twilio should use when
-            #   requesting the above URL. Defaults to POST.
-            # @return [ValidationRequestInstance] Newly created ValidationRequestInstance
+            # Create the ValidationRequestInstance
+            # @param [String] phone_number The phone number to verify in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
+            #   of a + followed by the country code and subscriber number.
+            # @param [String] friendly_name 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.
+            # @param [String] call_delay The number of seconds to delay before initiating the
+            #   verification call. Can be an integer between `0` and `60`, inclusive. The
+            #   default is `0`.
+            # @param [String] extension The digits to dial after connecting the verification
+            #   call.
+            # @param [String] status_callback The URL we should call using the
+            #   `status_callback_method` to send status information about the verification
+            #   process to your application.
+            # @param [String] status_callback_method The HTTP method we should use to call
+            #   `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.
+            # @return [ValidationRequestInstance] Created ValidationRequestInstance
             def create(phone_number: nil, friendly_name: :unset, call_delay: :unset, extension: :unset, status_callback: :unset, status_callback_method: :unset)
               data = Twilio::Values.of({
                   'PhoneNumber' => phone_number,
@@ -57,11 +56,7 @@ module Twilio
                   'StatusCallbackMethod' => status_callback_method,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -107,9 +102,9 @@ module Twilio
             # Initialize the ValidationRequestInstance
             # @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](https://www.twilio.com/docs/api/rest/account) responsible for this
-            #   Caller Id.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for the
+            #   Caller ID.
             # @return [ValidationRequestInstance] ValidationRequestInstance
             def initialize(version, payload, account_sid: nil)
               super(version)
@@ -117,41 +112,41 @@ module Twilio
               # Marshaled Properties
               @properties = {
                   'account_sid' => payload['account_sid'],
-                  'phone_number' => payload['phone_number'],
-                  'friendly_name' => payload['friendly_name'],
-                  'validation_code' => payload['validation_code'].to_i,
                   'call_sid' => payload['call_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'phone_number' => payload['phone_number'],
+                  'validation_code' => payload['validation_code'],
               }
             end
 
             ##
-            # @return [String] The unique ID of the Account responsible for this Caller Id.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The incoming phone number.
-            def phone_number
-              @properties['phone_number']
+            # @return [String] The SID of the Call the resource is associated with
+            def call_sid
+              @properties['call_sid']
             end
 
             ##
-            # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The 6 digit validation code that must be entered via the phone to validate this phone number for Caller ID.
-            def validation_code
-              @properties['validation_code']
+            # @return [String] The phone number to verify in E.164 format
+            def phone_number
+              @properties['phone_number']
             end
 
             ##
-            # @return [String] The unique id of the Call created for this validation attempt.
-            def call_sid
-              @properties['call_sid']
+            # @return [String] The 6 digit validation code that someone must enter to validate the Caller ID  when `phone_number` is called
+            def validation_code
+              @properties['validation_code']
             end
 
             ##