twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,199 +1,302 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# frozen_string_literal: true
+
 
 module Twilio
-  module REST
-    class Verify < Domain
-      class V2 < Version
-        class ServiceContext < InstanceContext
-          class EntityContext < InstanceContext
-            class ChallengeContext < InstanceContext
-              class NotificationList < ListResource
-                ##
-                # Initialize the NotificationList
-                # @param [Version] version Version that contains the resource
-                # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] identity Customer unique identity for the Entity owner of the
-                #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
-                #   characters, and generated by your external system, such as your user's UUID,
-                #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
-                # @param [String] challenge_sid The unique SID identifier of the Challenge.
-                # @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"
-                end
+    module REST
+        class Verify < VerifyBase
+            class V2 < Version
+                class ServiceContext < InstanceContext
+                class EntityContext < InstanceContext
+                class ChallengeContext < InstanceContext
 
-                ##
-                # Create the NotificationInstance
-                # @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(ttl: :unset)
-                  data = Twilio::Values.of({'Ttl' => ttl, })
-
-                  payload = @version.create('POST', @uri, data: data)
-
-                  NotificationInstance.new(
-                      @version,
-                      payload,
-                      service_sid: @solution[:service_sid],
-                      identity: @solution[:identity],
-                      challenge_sid: @solution[:challenge_sid],
-                  )
-                end
+                     class NotificationList < ListResource
+                
+                    ##
+                    # Initialize the NotificationList
+                    # @param [Version] version Version that contains the resource
+                    # @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"
+                        
+                    end
+                    ##
+                    # Create the NotificationInstance
+                    # @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(
+                        ttl: :unset
+                    )
 
-                ##
-                # Provide a user friendly representation
-                def to_s
-                  '#<Twilio.Verify.V2.NotificationList>'
-                end
-              end
-
-              class NotificationPage < Page
-                ##
-                # Initialize the NotificationPage
-                # @param [Version] version Version that contains the resource
-                # @param [Response] response Response from the API
-                # @param [Hash] solution Path solution for the resource
-                # @return [NotificationPage] NotificationPage
-                def initialize(version, response, solution)
-                  super(version, response)
-
-                  # Path Solution
-                  @solution = solution
-                end
+                        data = Twilio::Values.of({
+                            'Ttl' => ttl,
+                        })
 
-                ##
-                # Build an instance of NotificationInstance
-                # @param [Hash] payload Payload response from the API
-                # @return [NotificationInstance] NotificationInstance
-                def get_instance(payload)
-                  NotificationInstance.new(
-                      @version,
-                      payload,
-                      service_sid: @solution[:service_sid],
-                      identity: @solution[:identity],
-                      challenge_sid: @solution[:challenge_sid],
-                  )
-                end
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        NotificationInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                            identity: @solution[:identity],
+                            challenge_sid: @solution[:challenge_sid],
+                        )
+                    end
 
-                ##
-                # Provide a user friendly representation
-                def to_s
-                  '<Twilio.Verify.V2.NotificationPage>'
-                end
-              end
-
-              class NotificationInstance < InstanceResource
-                ##
-                # Initialize the NotificationInstance
-                # @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] identity Customer unique identity for the Entity owner of the
-                #   Challenge. This identifier should be immutable, not PII, length between 8 and 64
-                #   characters, and generated by your external system, such as your user's UUID,
-                #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
-                # @param [String] challenge_sid The unique SID identifier of the Challenge.
-                # @return [NotificationInstance] NotificationInstance
-                def initialize(version, payload, service_sid: nil, identity: nil, challenge_sid: nil)
-                  super(version)
-
-                  # Marshaled Properties
-                  @properties = {
-                      'sid' => payload['sid'],
-                      'account_sid' => payload['account_sid'],
-                      'service_sid' => payload['service_sid'],
-                      'entity_sid' => payload['entity_sid'],
-                      'identity' => payload['identity'],
-                      'challenge_sid' => payload['challenge_sid'],
-                      'priority' => payload['priority'],
-                      'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
-                      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  }
-                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
+                    )
 
-                ##
-                # @return [String] A string that uniquely identifies this Notification.
-                def sid
-                  @properties['sid']
-                end
+                        data = Twilio::Values.of({
+                            'Ttl' => ttl,
+                        })
 
-                ##
-                # @return [String] Account Sid.
-                def account_sid
-                  @properties['account_sid']
-                end
+                        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
 
-                ##
-                # @return [String] Service Sid.
-                def service_sid
-                  @properties['service_sid']
-                end
+                
 
-                ##
-                # @return [String] Entity Sid.
-                def entity_sid
-                  @properties['entity_sid']
-                end
 
-                ##
-                # @return [String] Unique external identifier of the Entity
-                def identity
-                  @properties['identity']
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Verify.V2.NotificationList>'
+                    end
                 end
 
-                ##
-                # @return [String] Challenge Sid.
-                def challenge_sid
-                  @properties['challenge_sid']
-                end
+                class NotificationPage < Page
+                    ##
+                    # Initialize the NotificationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [NotificationPage] NotificationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
 
-                ##
-                # @return [String] The priority of the notification.
-                def priority
-                  @properties['priority']
-                end
+                        # Path Solution
+                        @solution = solution
+                    end
 
-                ##
-                # @return [String] How long, in seconds, the notification is valid.
-                def ttl
-                  @properties['ttl']
+                    ##
+                    # Build an instance of NotificationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [NotificationInstance] NotificationInstance
+                    def get_instance(payload)
+                        NotificationInstance.new(@version, payload, service_sid: @solution[:service_sid], identity: @solution[:identity], challenge_sid: @solution[:challenge_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Verify.V2.NotificationPage>'
+                    end
                 end
 
-                ##
-                # @return [Time] The date this Notification was created
-                def date_created
-                  @properties['date_created']
+                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
 
-                ##
-                # Provide a user friendly representation
-                def to_s
-                  "<Twilio.Verify.V2.NotificationInstance>"
+                    def notification
+                        @notification
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
                 end
 
-                ##
-                # Provide a detailed, user friendly representation
-                def inspect
-                  "<Twilio.Verify.V2.NotificationInstance>"
+                class NotificationInstance < InstanceResource
+                    ##
+                    # Initialize the NotificationInstance
+                    # @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 Notification
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [NotificationInstance] NotificationInstance
+                    def initialize(version, payload , service_sid: nil, identity: nil, challenge_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'entity_sid' => payload['entity_sid'],
+                            'identity' => payload['identity'],
+                            'challenge_sid' => payload['challenge_sid'],
+                            'priority' => payload['priority'],
+                            'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Notification.
+                    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. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
+                    def identity
+                        @properties['identity']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Challenge.
+                    def challenge_sid
+                        @properties['challenge_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The priority of the notification. For `push` Challenges it's always `high` which sends the notification immediately, and can wake up a sleeping device.
+                    def priority
+                        @properties['priority']
+                    end
+                    
+                    ##
+                    # @return [String] How long, in seconds, the notification is valid. Max: 5 minutes
+                    def ttl
+                        @properties['ttl']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this Notification was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Verify.V2.NotificationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Verify.V2.NotificationInstance>"
+                    end
                 end
-              end
+
+             end
+             end
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+