twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/verify/v2/safelist.rb

@@ -0,0 +1,231 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Verify
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Verify < VerifyBase
+            class V2 < Version
+                class SafelistList < ListResource
+                    ##
+                    # Initialize the SafelistList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SafelistList] SafelistList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/SafeList/Numbers"
+                        
+                    end
+                    ##
+                    # Create the SafelistInstance
+                    # @param [String] phone_number The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @return [SafelistInstance] Created SafelistInstance
+                    def create(
+                        phone_number: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        SafelistInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Verify.V2.SafelistList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class SafelistContext < InstanceContext
+                    ##
+                    # Initialize the SafelistContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] phone_number The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+                    # @return [SafelistContext] SafelistContext
+                    def initialize(version, phone_number)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { phone_number: phone_number,  }
+                        @uri = "/SafeList/Numbers/#{@solution[:phone_number]}"
+
+                        
+                    end
+                    ##
+                    # Delete the SafelistInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the SafelistInstance
+                    # @return [SafelistInstance] Fetched SafelistInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        SafelistInstance.new(
+                            @version,
+                            payload,
+                            phone_number: @solution[:phone_number],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Verify.V2.SafelistContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Verify.V2.SafelistContext #{context}>"
+                    end
+                end
+
+                class SafelistPage < Page
+                    ##
+                    # Initialize the SafelistPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SafelistPage] SafelistPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SafelistInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SafelistInstance] SafelistInstance
+                    def get_instance(payload)
+                        SafelistInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Verify.V2.SafelistPage>'
+                    end
+                end
+                class SafelistInstance < InstanceResource
+                    ##
+                    # Initialize the SafelistInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Safelist
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SafelistInstance] SafelistInstance
+                    def initialize(version, payload , phone_number: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'phone_number' => payload['phone_number'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'phone_number' => phone_number  || @properties['phone_number']  , }
+                    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 [SafelistContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = SafelistContext.new(@version , @params['phone_number'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the SafeList resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The phone number in SafeList.
+                    def phone_number
+                        @properties['phone_number']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the SafeList resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Delete the SafelistInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the SafelistInstance
+                    # @return [SafelistInstance] Fetched SafelistInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Verify.V2.SafelistInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Verify.V2.SafelistInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,279 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Verify
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Verify < VerifyBase
+            class V2 < Version
+                class ServiceContext < InstanceContext
+
+                     class AccessTokenList < ListResource
+                    ##
+                    # Initialize the AccessTokenList
+                    # @param [Version] version Version that contains the resource
+                    # @return [AccessTokenList] AccessTokenList
+                    def initialize(version, service_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { service_sid: service_sid }
+                        @uri = "/Services/#{@solution[:service_sid]}/AccessTokens"
+                        
+                    end
+                    ##
+                    # Create the AccessTokenInstance
+                    # @param [String] identity The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID.
+                    # @param [FactorTypes] factor_type 
+                    # @param [String] factor_friendly_name The friendly name of the factor that is going to be created with this access token
+                    # @param [String] ttl How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60.
+                    # @return [AccessTokenInstance] Created AccessTokenInstance
+                    def create(
+                        identity: nil, 
+                        factor_type: nil, 
+                        factor_friendly_name: :unset, 
+                        ttl: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                            'FactorType' => factor_type,
+                            'FactorFriendlyName' => factor_friendly_name,
+                            'Ttl' => ttl,
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        AccessTokenInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Verify.V2.AccessTokenList>'
+                    end
+                end
+
+
+                class AccessTokenContext < InstanceContext
+                    ##
+                    # Initialize the AccessTokenContext
+                    # @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 Access Token.
+                    # @return [AccessTokenContext] AccessTokenContext
+                    def initialize(version, service_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { service_sid: service_sid, sid: sid,  }
+                        @uri = "/Services/#{@solution[:service_sid]}/AccessTokens/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the AccessTokenInstance
+                    # @return [AccessTokenInstance] Fetched AccessTokenInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        AccessTokenInstance.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.AccessTokenContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Verify.V2.AccessTokenContext #{context}>"
+                    end
+                end
+
+                class AccessTokenPage < Page
+                    ##
+                    # Initialize the AccessTokenPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [AccessTokenPage] AccessTokenPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of AccessTokenInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [AccessTokenInstance] AccessTokenInstance
+                    def get_instance(payload)
+                        AccessTokenInstance.new(@version, payload, service_sid: @solution[:service_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Verify.V2.AccessTokenPage>'
+                    end
+                end
+                class AccessTokenInstance < InstanceResource
+                    ##
+                    # Initialize the AccessTokenInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this AccessToken
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [AccessTokenInstance] AccessTokenInstance
+                    def initialize(version, payload , service_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'entity_identity' => payload['entity_identity'],
+                            'factor_type' => payload['factor_type'],
+                            'factor_friendly_name' => payload['factor_friendly_name'],
+                            'token' => payload['token'],
+                            'url' => payload['url'],
+                            'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'service_sid' => service_sid  || @properties['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 [AccessTokenContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = AccessTokenContext.new(@version , @params['service_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Access Token.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Verify Service.
+                    def service_sid
+                        @properties['service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique external identifier for the Entity of the Service.
+                    def entity_identity
+                        @properties['entity_identity']
+                    end
+                    
+                    ##
+                    # @return [FactorTypes] 
+                    def factor_type
+                        @properties['factor_type']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name.
+                    def factor_friendly_name
+                        @properties['factor_friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The access token generated for enrollment, this is an encrypted json web token.
+                    def token
+                        @properties['token']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [String] How long, in seconds, the access token is valid. Max: 5 minutes
+                    def ttl
+                        @properties['ttl']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this access token was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # Fetch the AccessTokenInstance
+                    # @return [AccessTokenInstance] Fetched AccessTokenInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Verify.V2.AccessTokenInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+