twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/{preview/acc_security → authy/v1}/service.rb

@@ -3,11 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class AccSecurity < Version
+    class Authy < Domain
+      class V1 < Version
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
         class ServiceList < ListResource
@@ -26,12 +28,15 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @param [String] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
           # @return [ServiceInstance] Newly created ServiceInstance
-          def create(name: nil, code_length: :unset)
-            data = Twilio::Values.of({'Name' => name, 'CodeLength' => code_length})
+          def create(friendly_name: nil, push: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Push' => push, })
 
             payload = @version.create(
                 'POST',
@@ -39,7 +44,7 @@ module Twilio
                 data: data
             )
 
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -71,7 +76,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -83,7 +88,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],
@@ -127,7 +132,7 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.AccSecurity.ServiceList>'
+            '#<Twilio.Authy.V1.ServiceList>'
           end
         end
 
@@ -152,13 +157,13 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ServiceInstance] ServiceInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.AccSecurity.ServicePage>'
+            '<Twilio.Authy.V1.ServicePage>'
           end
         end
 
@@ -168,18 +173,24 @@ module Twilio
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The unique SID identifier of Verification Service Instance.
+          # @param [String] sid A 34 character string that uniquely identifies this Service.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Services/#{@solution[:sid]}"
 
             # Dependents
-            @verifications = nil
-            @verification_checks = nil
+            @entities = nil
+          end
+
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            @version.delete('delete', @uri)
           end
 
           ##
@@ -194,17 +205,20 @@ module Twilio
                 params,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @param [String] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(name: :unset, code_length: :unset)
-            data = Twilio::Values.of({'Name' => name, 'CodeLength' => code_length})
+          def update(friendly_name: :unset, push: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Push' => push, })
 
             payload = @version.update(
                 'POST',
@@ -212,38 +226,39 @@ module Twilio
                 data: data,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Access the verifications
-          # @return [VerificationList]
-          # @return [VerificationContext]
-          def verifications
-            unless @verifications
-              @verifications = VerificationList.new(@version, service_sid: @solution[:sid])
-            end
+          # Access the entities
+          # @return [EntityList]
+          # @return [EntityContext] if identity was passed.
+          def entities(identity=:unset)
+            raise ArgumentError, 'identity cannot be nil' if identity.nil?
 
-            @verifications
-          end
+            if identity != :unset
+              return EntityContext.new(@version, @solution[:sid], identity, )
+            end
 
-          ##
-          # Access the verification_checks
-          # @return [VerificationCheckList]
-          # @return [VerificationCheckContext]
-          def verification_checks
-            unless @verification_checks
-              @verification_checks = VerificationCheckList.new(@version, service_sid: @solution[:sid])
+            unless @entities
+              @entities = EntityList.new(@version, service_sid: @solution[:sid], )
             end
 
-            @verification_checks
+            @entities
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.AccSecurity.ServiceContext #{context}>"
+            "#<Twilio.Authy.V1.ServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Authy.V1.ServiceContext #{context}>"
           end
         end
 
@@ -254,7 +269,7 @@ module Twilio
           # Initialize the ServiceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The unique SID identifier of Verification Service Instance.
+          # @param [String] sid A 34 character string that uniquely identifies this Service.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -262,18 +277,18 @@ module Twilio
             # Marshaled Properties
             @properties = {
                 'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
                 'account_sid' => payload['account_sid'],
-                'name' => payload['name'],
-                'code_length' => payload['code_length'].to_i,
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
                 'links' => payload['links'],
+                'configuration' => payload['configuration'],
             }
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -282,7 +297,7 @@ module Twilio
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'])
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -294,21 +309,15 @@ module Twilio
           end
 
           ##
-          # @return [String] Account Sid.
-          def account_sid
-            @properties['account_sid']
+          # @return [String] A human readable description of this resource.
+          def friendly_name
+            @properties['friendly_name']
           end
 
           ##
-          # @return [String] Friendly name of the service
-          def name
-            @properties['name']
-          end
-
-          ##
-          # @return [String] Length of verification code. Valid values are 4-10
-          def code_length
-            @properties['code_length']
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
           end
 
           ##
@@ -324,17 +333,30 @@ module Twilio
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
 
+          ##
+          # @return [Hash] The service level configuration of all the factor types.
+          def configuration
+            @properties['configuration']
+          end
+
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
           ##
           # Fetch a ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
@@ -344,40 +366,36 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @param [String] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(name: :unset, code_length: :unset)
-            context.update(name: name, code_length: code_length)
-          end
-
-          ##
-          # Access the verifications
-          # @return [verifications] verifications
-          def verifications
-            context.verifications
+          def update(friendly_name: :unset, push: :unset)
+            context.update(friendly_name: friendly_name, push: push, )
           end
 
           ##
-          # Access the verification_checks
-          # @return [verification_checks] verification_checks
-          def verification_checks
-            context.verification_checks
+          # Access the entities
+          # @return [entities] entities
+          def entities
+            context.entities
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+            "<Twilio.Authy.V1.ServiceInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+            "<Twilio.Authy.V1.ServiceInstance #{values}>"
           end
         end
       end

data/lib/twilio-ruby/rest/authy/v1.rb

@@ -0,0 +1,59 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Authy
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @forms = nil
+          @services = nil
+        end
+
+        ##
+        # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
+        #   `form-sms` or `form-totp`.
+        # @return [Twilio::REST::Authy::V1::FormContext] if form_type was passed.
+        # @return [Twilio::REST::Authy::V1::FormList]
+        def forms(form_type=:unset)
+          if form_type.nil?
+            raise ArgumentError, 'form_type cannot be nil'
+          elsif form_type == :unset
+            @forms ||= FormList.new self
+          else
+            FormContext.new(self, form_type)
+          end
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this Service.
+        # @return [Twilio::REST::Authy::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Authy::V1::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @services ||= ServiceList.new self
+          else
+            ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Authy::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy < Domain
+      ##
+      # Initialize the Authy Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://authy.twilio.com'
+        @host = 'authy.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of authy
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
+      #   `form-sms` or `form-totp`.
+      # @return [Twilio::REST::Authy::V1::FormInstance] if form_type was passed.
+      # @return [Twilio::REST::Authy::V1::FormList]
+      def forms(form_type=:unset)
+        self.v1.forms(form_type)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @return [Twilio::REST::Authy::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Authy::V1::ServiceList]
+      def services(sid=:unset)
+        self.v1.services(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Authy>'
+      end
+    end
+  end
+end