twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -39,7 +39,8 @@ module Twilio
 
             ##
             # 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)

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
 
             ##

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -24,19 +24,14 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of AccountInstance records from the API.
-          # Request is executed immediately.
+          # Create the AccountInstance
           # @param [String] friendly_name A human readable description of the account to
           #   create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`
-          # @return [AccountInstance] Newly created AccountInstance
+          # @return [AccountInstance] Created AccountInstance
           def create(friendly_name: :unset)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             AccountInstance.new(@version, payload, )
           end
@@ -121,11 +116,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             AccountPage.new(@version, response, @solution)
           end
 
@@ -197,6 +190,7 @@ module Twilio
             @applications = nil
             @authorized_connect_apps = nil
             @available_phone_numbers = nil
+            @balance = nil
             @calls = nil
             @conferences = nil
             @connect_apps = nil
@@ -219,16 +213,10 @@ module Twilio
           end
 
           ##
-          # Fetch a AccountInstance
+          # Fetch the AccountInstance
           # @return [AccountInstance] Fetched AccountInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             AccountInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -244,11 +232,7 @@ module Twilio
           def update(friendly_name: :unset, status: :unset)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Status' => status, })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             AccountInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -328,6 +312,18 @@ module Twilio
             @available_phone_numbers
           end
 
+          ##
+          # Access the balance
+          # @return [BalanceList]
+          # @return [BalanceContext]
+          def balance
+            unless @balance
+              @balance = BalanceList.new(@version, account_sid: @solution[:sid], )
+            end
+
+            @balance
+          end
+
           ##
           # Access the calls
           # @return [CallList]
@@ -640,6 +636,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Api.V2010.AccountContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Api.V2010.AccountContext #{context}>"
+          end
         end
 
         class AccountInstance < InstanceResource
@@ -744,7 +747,7 @@ module Twilio
           end
 
           ##
-          # Fetch a AccountInstance
+          # Fetch the AccountInstance
           # @return [AccountInstance] Fetched AccountInstance
           def fetch
             context.fetch
@@ -790,6 +793,13 @@ module Twilio
             context.available_phone_numbers
           end
 
+          ##
+          # Access the balance
+          # @return [balance] balance
+          def balance
+            context.balance
+          end
+
           ##
           # Access the calls
           # @return [calls] calls

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Api::V2010::AccountList]
         def accounts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @accounts ||= AccountList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @accounts ||= AccountList.new self
           else
-            AccountContext.new(self, sid)
+              AccountContext.new(self, sid)
           end
         end
 
@@ -62,6 +63,10 @@ module Twilio
           self.account.available_phone_numbers(country_code)
         end
 
+        def balance
+          self.account.balance()
+        end
+
         def calls(sid=:unset)
           self.account.calls(sid)
         end

data/lib/twilio-ruby/rest/api.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -44,7 +44,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this address.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Address resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressList]
       def addresses(sid=:unset)
@@ -52,8 +53,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Application resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationList]
       def applications(sid=:unset)
@@ -61,8 +62,7 @@ module Twilio
       end
 
       ##
-      # @param [String] connect_app_sid The unique id of the Connect App that was
-      #   authorized.
+      # @param [String] connect_app_sid The SID that we assigned to the Connect App.
       # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance] if connect_app_sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList]
       def authorized_connect_apps(connect_app_sid=:unset)
@@ -70,7 +70,9 @@ module Twilio
       end
 
       ##
-      # @param [String] country_code The ISO Country code to lookup phone numbers for.
+      # @param [String] country_code The
+      #   {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of
+      #   the country.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
       def available_phone_numbers(country_code=:unset)
@@ -78,7 +80,13 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34-character string that uniquely identifies the Call
+      # @return [Twilio::REST::Api::V2010::AccountContext::BalanceInstance]
+      def balance
+        self.account.balance()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify this Call
       #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallList]
@@ -87,8 +95,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   conference.
+      # @param [String] sid The unique string that that we created to identify this
+      #   Conference resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceList]
       def conferences(sid=:unset)
@@ -96,7 +104,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique id of this Connect App.
+      # @param [String] sid The unique string that that we created to identify the
+      #   ConnectApp resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppList]
       def connect_apps(sid=:unset)
@@ -104,8 +113,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify this
+      #   IncomingPhoneNumber resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList]
       def incoming_phone_numbers(sid=:unset)
@@ -113,8 +122,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this API Key.
-      #    You will use this as the basic-auth `user` when authenticating to the API.
+      # @param [String] sid The unique string that that we created to identify the Key
+      #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)
@@ -122,8 +131,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Message resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
@@ -143,8 +152,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Notification resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::NotificationInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::NotificationList]
       def notifications(sid=:unset)
@@ -152,8 +161,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   OutgoingCallerId resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList]
       def outgoing_caller_ids(sid=:unset)
@@ -161,7 +170,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this queue.
+      # @param [String] sid The unique string that that we created to identify this
+      #   Queue resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::QueueInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::QueueList]
       def queues(sid=:unset)
@@ -169,8 +179,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Recording resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
       def recordings(sid=:unset)
@@ -192,8 +202,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify this
+      #   ShortCode resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeList]
       def short_codes(sid=:unset)
@@ -207,7 +217,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A unique 34-character string that identifies this resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Transcription resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)