twilio-ruby 7.4.4 → 7.10.4

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

@@ -0,0 +1,402 @@
+##
+#    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 ApproveChallengeList < ListResource
+                
+                    class ApprovePasskeysChallengeRequest
+                            # @param [id]: [String] A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.
+                            # @param [raw_id]: [String] The globally unique identifier for this `PublicKeyCredential`.
+                            # @param [authenticator_attachment]: [String] A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated `navigator.credentials.create()` or `navigator.credentials.get()` call completes.
+                            # @param [type]: [String] The valid credential types supported by the API. The values of this enumeration are used for versioning the `AuthenticatorAssertion` and `AuthenticatorAttestation` structures according to the type of the authenticator.
+                            # @param [response]: [ApproveChallengeList.ApprovePasskeysChallengeRequestResponse] 
+                        attr_accessor :id, :raw_id, :authenticator_attachment, :type, :response
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @raw_id = payload["raw_id"]
+                                @authenticator_attachment = payload["authenticator_attachment"]
+                                @type = payload["type"]
+                                @response = payload["response"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "rawId": @raw_id,
+                                "authenticatorAttachment": @authenticator_attachment,
+                                "type": @type,
+                                "response": @response,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ApprovePasskeysChallengeRequestResponse
+                            # @param [authenticator_data]: [String] The [authenticator data](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API/Authenticator_data) structure contains information from the authenticator about the processing of a credential creation or authentication request.
+                            # @param [client_data_json]: [String] This property contains the JSON-compatible serialization of the data passed from the browser to the authenticator in order to generate this credential.
+                            # @param [signature]: [String] An assertion signature over `authenticatorData` and `clientDataJSON`. The assertion signature is created with the private key of the key pair that was created during the originating `navigator.credentials.create()` call and verified using the public key of that same key pair.
+                            # @param [user_handle]: [String] The user handle stored in the authenticator, specified as `user.id` in the options passed to the originating `navigator.credentials.create()` call. This property should contain a base64url-encoded entity SID.
+                        attr_accessor :authenticator_data, :client_data_json, :signature, :user_handle
+                        def initialize(payload)
+                                @authenticator_data = payload["authenticator_data"]
+                                @client_data_json = payload["client_data_json"]
+                                @signature = payload["signature"]
+                                @user_handle = payload["user_handle"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "authenticatorData": @authenticator_data,
+                                "clientDataJSON": @client_data_json,
+                                "signature": @signature,
+                                "userHandle": @user_handle,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ApproveChallengeList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ApproveChallengeList] ApproveChallengeList
+                    def initialize(version, service_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { service_sid: service_sid }
+                        @uri = "/Services/#{@solution[:service_sid]}/Passkeys/ApproveChallenge"
+                        
+                    end
+                    ##
+                    # Update the ApproveChallengeInstance
+                    # @param [ApprovePasskeysChallengeRequest] approve_passkeys_challenge_request 
+                    # @return [ApproveChallengeInstance] Updated ApproveChallengeInstance
+                    def update(approve_passkeys_challenge_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, headers: headers, data: approve_passkeys_challenge_request.to_json)
+                        ApproveChallengeInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                        )
+                    end
+
+                    ##
+                    # Update the ApproveChallengeInstanceMetadata
+                    # @param [ApprovePasskeysChallengeRequest] approve_passkeys_challenge_request 
+                    # @return [ApproveChallengeInstance] Updated ApproveChallengeInstance
+                    def update_with_metadata(approve_passkeys_challenge_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, headers: headers, data: approve_passkeys_challenge_request.to_json)
+                        approve_challenge_instance = ApproveChallengeInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        ApproveChallengeInstanceMetadata.new(
+                            @version,
+                            approve_challenge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Verify.V2.ApproveChallengeList>'
+                    end
+                end
+
+                class ApproveChallengePage < Page
+                    ##
+                    # Initialize the ApproveChallengePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ApproveChallengePage] ApproveChallengePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ApproveChallengeInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ApproveChallengeInstance] ApproveChallengeInstance
+                    def get_instance(payload)
+                        ApproveChallengeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Verify.V2.ApproveChallengePage>'
+                    end
+                end
+
+                class ApproveChallengePageMetadata < PageMetadata
+                    attr_reader :approve_challenge_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @approve_challenge_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @approve_challenge_page << ApproveChallengeListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @approve_challenge_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class ApproveChallengeListResponse < InstanceListResource
+
+                    # @param [Array<ApproveChallengeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @approve_challenge = data_list.map do |data|
+                        ApproveChallengeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def approve_challenge
+                        @approve_challenge
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ApproveChallengeInstance < InstanceResource
+                    ##
+                    # Initialize the ApproveChallengeInstance
+                    # @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 ApproveChallenge
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ApproveChallengeInstance] ApproveChallengeInstance
+                    def initialize(version, payload , service_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'options' => payload['options'],
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'entity_sid' => payload['entity_sid'],
+                            'identity' => payload['identity'],
+                            'factor_sid' => payload['factor_sid'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'date_responded' => Twilio.deserialize_iso8601_datetime(payload['date_responded']),
+                            'expiration_date' => Twilio.deserialize_iso8601_datetime(payload['expiration_date']),
+                            'status' => payload['status'],
+                            'responded_reason' => payload['responded_reason'],
+                            'details' => payload['details'],
+                            'hidden_details' => payload['hidden_details'],
+                            'metadata' => payload['metadata'],
+                            'factor_type' => payload['factor_type'],
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Hash] An object that contains challenge options. Currently only used for `passkeys`.
+                    def options
+                        @properties['options']
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Challenge.
+                    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 Service.
+                    def service_sid
+                        @properties['service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Entity.
+                    def entity_sid
+                        @properties['entity_sid']
+                    end
+                    
+                    ##
+                    # @return [String] Customer unique identity for the Entity owner of the Challenge.
+                    def identity
+                        @properties['identity']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Factor.
+                    def factor_sid
+                        @properties['factor_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_responded
+                        @properties['date_responded']
+                    end
+                    
+                    ##
+                    # @return [Time] The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def expiration_date
+                        @properties['expiration_date']
+                    end
+                    
+                    ##
+                    # @return [String] The Status of this Challenge. One of `pending`, `expired`, `approved` or `denied`.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] Reason for the Challenge to be in certain `status`. One of `none`, `not_needed` or `not_requested`.
+                    def responded_reason
+                        @properties['responded_reason']
+                    end
+                    
+                    ##
+                    # @return [Hash] Details provided to give context about the Challenge.
+                    def details
+                        @properties['details']
+                    end
+                    
+                    ##
+                    # @return [Hash] Details provided to give context about the Challenge.
+                    def hidden_details
+                        @properties['hidden_details']
+                    end
+                    
+                    ##
+                    # @return [Hash] Custom metadata associated with the challenge.
+                    def metadata
+                        @properties['metadata']
+                    end
+                    
+                    ##
+                    # @return [String] The Factor Type of this Challenge. Currently `push` and `totp` are supported.
+                    def factor_type
+                        @properties['factor_type']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] Contains a dictionary of URL links to nested resources of this Challenge.
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Verify.V2.ApproveChallengeInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Verify.V2.ApproveChallengeInstance>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb

@@ -29,6 +29,7 @@ module Twilio
                     # @return [NotificationList] NotificationList
                     def initialize(version, service_sid: nil, identity: nil, challenge_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, identity: identity, challenge_sid: challenge_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges/#{@solution[:challenge_sid]}/Notifications"
@@ -62,6 +63,40 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the NotificationInstanceMetadata
+                    # @param [String] ttl How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery.
+                    # @return [NotificationInstance] Created NotificationInstance
+                    def create_with_metadata(
+                      ttl: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Ttl' => ttl,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        notification_instance = NotificationInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            identity: @solution[:identity],
+                            challenge_sid: @solution[:challenge_sid],
+                        )
+                        NotificationInstanceMetadata.new(
+                            @version,
+                            notification_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -80,6 +115,7 @@ module Twilio
                     # @return [NotificationPage] NotificationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -99,6 +135,66 @@ module Twilio
                         '<Twilio.Verify.V2.NotificationPage>'
                     end
                 end
+
+                class NotificationPageMetadata < PageMetadata
+                    attr_reader :notification_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @notification_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @notification_page << NotificationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @notification_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class NotificationListResponse < InstanceListResource
+
+                    # @param [Array<NotificationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @notification = data_list.map do |data|
+                        NotificationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def notification
+                        @notification
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class NotificationInstance < InstanceResource
                     ##
                     # Initialize the NotificationInstance
@@ -112,6 +208,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, identity: nil, challenge_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],