twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -28,22 +30,29 @@ module Twilio
               ##
               # Retrieve a single page of TriggerInstance records from the API.
               # Request is executed immediately.
-              # @param [String] callback_url Twilio will make a request to this url when the
-              #   trigger fires.
-              # @param [String] trigger_value The value at which the trigger will fire.  Must be
-              #   a positive numeric value.
-              # @param [trigger.UsageCategory] usage_category The usage category the trigger
-              #   watches
-              # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
-              # @param [trigger.Recurring] recurring How this trigger recurs. Empty for
-              #   non-recurring triggers. One of `daily`, `monthly`, or `yearly` for recurring
-              #   triggers.  A trigger will only fire once during each recurring period. 
-              #   Recurring periods are in GMT.
-              # @param [trigger.TriggerField] trigger_by The field in the UsageRecord that fires
-              #   the trigger. One of `count`, `usage`, or `price`
+              # @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.
+              #   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/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.
+              #   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/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/usage/api/usage-record#usage-count-price).  The default is `usage`.
               # @return [TriggerInstance] Newly 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({
@@ -62,19 +71,22 @@ module Twilio
                     data: data
                 )
 
-                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
               # Lists TriggerInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
-              # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
-              # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   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/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/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
@@ -96,12 +108,15 @@ module Twilio
               # Streams TriggerInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
-              # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
-              # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   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/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/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
@@ -129,7 +144,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],
@@ -139,12 +154,15 @@ module Twilio
               ##
               # Retrieve a single page of TriggerInstance records from the API.
               # Request is executed immediately.
-              # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
-              # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
-              # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   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/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/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
@@ -205,7 +223,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [TriggerInstance] TriggerInstance
               def get_instance(payload)
-                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -219,14 +237,17 @@ module Twilio
               ##
               # Initialize the TriggerContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The usage-trigger 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
+              #   UsageTrigger resource to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   UsageTrigger resource to fetch.
               # @return [TriggerContext] TriggerContext
               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]}/Usage/Triggers/#{@solution[:sid]}.json"
               end
 
@@ -242,17 +263,17 @@ module Twilio
                     params,
                 )
 
-                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
 
               ##
               # Update the TriggerInstance
-              # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
-              # @param [String] callback_url Twilio will make a request to this url when the
-              #   trigger fires.
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
+              # @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] callback_url The URL we should call using `callback_method` when
+              #   the trigger fires.
+              # @param [String] friendly_name A descriptive string that you create to describe
+              #   the resource. It can be up to 64 characters long.
               # @return [TriggerInstance] Updated TriggerInstance
               def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
                 data = Twilio::Values.of({
@@ -267,12 +288,12 @@ module Twilio
                     data: data,
                 )
 
-                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
 
               ##
               # Deletes the TriggerInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -283,6 +304,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
@@ -292,7 +320,8 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   UsageTrigger resource to fetch.
               # @return [TriggerInstance] TriggerInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -319,7 +348,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
 
               ##
@@ -328,91 +357,91 @@ module Twilio
               # @return [TriggerContext] TriggerContext for this TriggerInstance
               def context
                 unless @instance_context
-                  @instance_context = TriggerContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = TriggerContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The account this trigger monitors.
+              # @return [String] The SID of the Account that this trigger monitors
               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 [String] HTTP method to use with callback_url
+              # @return [String] The HTTP method we use to call callback_url
               def callback_method
                 @properties['callback_method']
               end
 
               ##
-              # @return [String] URL Twilio will request when the trigger fires
+              # @return [String] he URL we call when the trigger fires
               def callback_url
                 @properties['callback_url']
               end
 
               ##
-              # @return [String] The current value of the field the trigger is watching.
+              # @return [String] The current value of the field the trigger is watching
               def current_value
                 @properties['current_value']
               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 the trigger was last fired
+              # @return [Time] The RFC 2822 date and time in GMT that the trigger was last fired
               def date_fired
                 @properties['date_fired']
               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] A user-specified, human-readable name for the trigger.
+              # @return [String] The string that you assigned to describe the trigger
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [trigger.Recurring] How this trigger recurs
+              # @return [trigger.Recurring] The frequency of a recurring UsageTrigger
               def recurring
                 @properties['recurring']
               end
 
               ##
-              # @return [String] The trigger's unique Sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [trigger.TriggerField] The field in the UsageRecord that fires the trigger
+              # @return [trigger.TriggerField] The field in the UsageRecord resource that fires the trigger
               def trigger_by
                 @properties['trigger_by']
               end
 
               ##
-              # @return [String] the value at which the trigger will fire
+              # @return [String] The value at which the trigger will fire
               def trigger_value
                 @properties['trigger_value']
               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
@@ -424,7 +453,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The URI of the UsageRecord this trigger is watching
+              # @return [String] The URI of the UsageRecord resource this trigger watches
               def usage_record_uri
                 @properties['usage_record_uri']
               end
@@ -438,12 +467,12 @@ module Twilio
 
               ##
               # Update the TriggerInstance
-              # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
-              # @param [String] callback_url Twilio will make a request to this url when the
-              #   trigger fires.
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
+              # @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] callback_url The URL we should call using `callback_method` when
+              #   the trigger fires.
+              # @param [String] friendly_name A descriptive string that you create to describe
+              #   the resource. It can be up to 64 characters long.
               # @return [TriggerInstance] Updated TriggerInstance
               def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
                 context.update(
@@ -455,7 +484,7 @@ module Twilio
 
               ##
               # Deletes the TriggerInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -32,22 +34,23 @@ module Twilio
             # @return [RecordList]
             # @return [RecordContext]
             def records
-              @records ||= RecordList.new(@version, account_sid: @solution[:account_sid])
+              @records ||= RecordList.new(@version, account_sid: @solution[:account_sid], )
             end
 
             ##
             # Access the triggers
-            # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   UsageTrigger resource to fetch.
             # @return [TriggerList]
             # @return [TriggerContext] if sid was passed.
             def triggers(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return TriggerContext.new(@version, @solution[:account_sid], sid)
+                return TriggerContext.new(@version, @solution[:account_sid], sid, )
               end
 
-                @triggers ||= TriggerList.new(@version, account_sid: @solution[:account_sid])
+                @triggers ||= TriggerList.new(@version, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -76,7 +79,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [UsageInstance] UsageInstance
             def get_instance(payload)
-              UsageInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              UsageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the ValidationRequestList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
+            # @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)
@@ -26,12 +30,22 @@ module Twilio
             ##
             # Retrieve a single page of ValidationRequestInstance records from the API.
             # Request is executed immediately.
-            # @param [String] phone_number The phone_number
-            # @param [String] friendly_name The friendly_name
-            # @param [String] call_delay The call_delay
-            # @param [String] extension The extension
-            # @param [String] status_callback The status_callback
-            # @param [String] status_callback_method The status_callback_method
+            # @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] Newly 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({
@@ -49,7 +63,7 @@ module Twilio
                   data: data
               )
 
-              ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -78,7 +92,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ValidationRequestInstance] ValidationRequestInstance
             def get_instance(payload)
-              ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -93,7 +107,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 account_sid
+            # @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)
@@ -109,31 +125,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The phone_number
+            # @return [String] The phone number to verify in E.164 format
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The validation_code
+            # @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
 
             ##
-            # @return [String] The call_sid
+            # @return [String] The SID of the Call the resource is associated with
             def call_sid
               @properties['call_sid']
             end