twilio-ruby 5.21.2 → 5.22.0

data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb

@@ -63,8 +63,10 @@ module Twilio
             ##
             # Initialize the NumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] destination_number This fetches the origin-based voice pricing
-            #   information for a phone number
+            # @param [String] destination_number The destination phone number, in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
             # @return [NumberContext] NumberContext
             def initialize(version, destination_number)
               super(version)
@@ -76,7 +78,10 @@ module Twilio
 
             ##
             # Fetch a NumberInstance
-            # @param [String] origination_number The origination_number
+            # @param [String] origination_number The origination phone number, in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
             # @return [NumberInstance] Fetched NumberInstance
             def fetch(origination_number: :unset)
               params = Twilio::Values.of({'OriginationNumber' => origination_number, })
@@ -110,8 +115,10 @@ module Twilio
             # Initialize the NumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] destination_number This fetches the origin-based voice pricing
-            #   information for a phone number
+            # @param [String] destination_number The destination phone number, in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
             # @return [NumberInstance] NumberInstance
             def initialize(version, payload, destination_number: nil)
               super(version)
@@ -145,19 +152,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The destination phone number, in E.164
+            # @return [String] The destination phone number, in E.164 format
             def destination_number
               @properties['destination_number']
             end
 
             ##
-            # @return [String] The origination phone number, in E.164
+            # @return [String] The origination phone number, in E.164 format
             def origination_number
               @properties['origination_number']
             end
 
             ##
-            # @return [String] Name of the country
+            # @return [String] The name of the country
             def country
               @properties['country']
             end
@@ -169,32 +176,35 @@ module Twilio
             end
 
             ##
-            # @return [String] List of OutboundCallPriceWithOrigin records
+            # @return [String] The list of OutboundCallPriceWithOrigin records
             def outbound_call_prices
               @properties['outbound_call_prices']
             end
 
             ##
-            # @return [String] List of InboundCallPrice records
+            # @return [String] The InboundCallPrice record
             def inbound_call_price
               @properties['inbound_call_price']
             end
 
             ##
-            # @return [String] The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy).
+            # @return [String] The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)
             def price_unit
               @properties['price_unit']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
             # Fetch a NumberInstance
-            # @param [String] origination_number The origination_number
+            # @param [String] origination_number The origination phone number, in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
             # @return [NumberInstance] Fetched NumberInstance
             def fetch(origination_number: :unset)
               context.fetch(origination_number: origination_number, )

data/lib/twilio-ruby/rest/pricing/v2/voice.rb

@@ -28,8 +28,9 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country This fetches the origin-based voice pricing
-          #   information for a specific country
+          # @param [String] iso_country The [ISO country
+          #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based voice
+          #   pricing information to fetch.
           # @return [CountryList]
           # @return [CountryContext] if iso_country was passed.
           def countries(iso_country=:unset)
@@ -44,8 +45,10 @@ module Twilio
 
           ##
           # Access the numbers
-          # @param [String] destination_number This fetches the origin-based voice pricing
-          #   information for a phone number
+          # @param [String] destination_number The destination phone number, in
+          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to
+          #   fetch the origin-based voice pricing information. E.164 format consists of a +
+          #   followed by the country code and subscriber number.
           # @return [NumberList]
           # @return [NumberContext] if destination_number was passed.
           def numbers(destination_number=:unset)
@@ -108,19 +111,19 @@ module Twilio
           end
 
           ##
-          # @return [String] The name
+          # @return [String] The resource name
           def name
             @properties['name']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of the related Countries and Numbers resources
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb

@@ -166,7 +166,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The SID of the longest waiting Task
+            # @return [String] The longest_task_waiting_sid
             def longest_task_waiting_sid
               @properties['longest_task_waiting_sid']
             end

data/lib/twilio-ruby/rest/verify/v2/service/verification.rb

@@ -0,0 +1,343 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationList < ListResource
+            ##
+            # Initialize the VerificationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [VerificationList] VerificationList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/Verifications"
+            end
+
+            ##
+            # Retrieve a single page of VerificationInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] to The To phonenumber of the phone being verified
+            # @param [String] channel The method in which the phone will be verified. Either
+            #   sms or call
+            # @param [String] custom_message A character string containing a custom message
+            #   for this verification
+            # @param [String] send_digits Digits to send when a phone call is started, same
+            #   parameters as in Programmable Voice are supported
+            # @param [String] locale Supported values are af, ar, ca, cs, da, de, el, en, es,
+            #   fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nb, nl, pl, pt, pr-BR, ro, ru, sv,
+            #   th, tl, tr, vi, zh, zh-CN, zh-HK
+            # @param [String] custom_code Pass in a pre-generated code. Code length can be
+            #   between 4-10 characters.
+            # @param [String] amount Amount of the associated PSD2 compliant transaction.
+            #   Requires the PSD2 Service flag enabled.
+            # @param [String] payee Payee of the associated PSD2 compliant transaction.
+            #   Requires the PSD2 Service flag enabled.
+            # @return [VerificationInstance] Newly created VerificationInstance
+            def create(to: nil, channel: nil, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset)
+              data = Twilio::Values.of({
+                  'To' => to,
+                  'Channel' => channel,
+                  'CustomMessage' => custom_message,
+                  'SendDigits' => send_digits,
+                  'Locale' => locale,
+                  'CustomCode' => custom_code,
+                  'Amount' => amount,
+                  'Payee' => payee,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              VerificationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Verify.V2.VerificationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationPage < Page
+            ##
+            # Initialize the VerificationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [VerificationPage] VerificationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of VerificationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [VerificationInstance] VerificationInstance
+            def get_instance(payload)
+              VerificationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Verify.V2.VerificationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationContext < InstanceContext
+            ##
+            # Initialize the VerificationContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid A 34 character string that uniquely identifies this
+            #   Verification or the associated phone number.
+            # @return [VerificationContext] VerificationContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:service_sid]}/Verifications/#{@solution[:sid]}"
+            end
+
+            ##
+            # Update the VerificationInstance
+            # @param [verification.Status] status New status to set for the Verification, only
+            #   canceled is allowed at the moment.
+            # @return [VerificationInstance] Updated VerificationInstance
+            def update(status: nil)
+              data = Twilio::Values.of({'Status' => status, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              VerificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Fetch a VerificationInstance
+            # @return [VerificationInstance] Fetched VerificationInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              VerificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.VerificationContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.VerificationContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class VerificationInstance < InstanceResource
+            ##
+            # Initialize the VerificationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid A 34 character string that uniquely identifies this
+            #   Verification or the associated phone number.
+            # @return [VerificationInstance] VerificationInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'service_sid' => payload['service_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'to' => payload['to'],
+                  'channel' => payload['channel'],
+                  'status' => payload['status'],
+                  'valid' => payload['valid'],
+                  'lookup' => payload['lookup'],
+                  'amount' => payload['amount'],
+                  'payee' => payload['payee'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [VerificationContext] VerificationContext for this VerificationInstance
+            def context
+              unless @instance_context
+                @instance_context = VerificationContext.new(@version, @params['service_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Verification.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] To phonenumber
+            def to
+              @properties['to']
+            end
+
+            ##
+            # @return [verification.Channel] sms or call
+            def channel
+              @properties['channel']
+            end
+
+            ##
+            # @return [String] pending, approved, denied or expired
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [Boolean] successful verification
+            def valid
+              @properties['valid']
+            end
+
+            ##
+            # @return [Hash] Info about the phone number
+            def lookup
+              @properties['lookup']
+            end
+
+            ##
+            # @return [String] Amount of the associated PSD2 compliant transaction.
+            def amount
+              @properties['amount']
+            end
+
+            ##
+            # @return [String] Payee of the associated PSD2 compliant transaction.
+            def payee
+              @properties['payee']
+            end
+
+            ##
+            # @return [Time] The date this Verification was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date this Verification was updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the VerificationInstance
+            # @param [verification.Status] status New status to set for the Verification, only
+            #   canceled is allowed at the moment.
+            # @return [VerificationInstance] Updated VerificationInstance
+            def update(status: nil)
+              context.update(status: status, )
+            end
+
+            ##
+            # Fetch a VerificationInstance
+            # @return [VerificationInstance] Fetched VerificationInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.VerificationInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.VerificationInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end