twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/messaging/v1/deactivations.rb

@@ -0,0 +1,337 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Messaging
+#    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 Messaging < MessagingBase
+            class V1 < Version
+                class DeactivationsList < ListResource
+                
+                    ##
+                    # Initialize the DeactivationsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [DeactivationsList] DeactivationsList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Messaging.V1.DeactivationsList>'
+                    end
+                end
+
+
+                class DeactivationsContext < InstanceContext
+                    ##
+                    # Initialize the DeactivationsContext
+                    # @param [Version] version Version that contains the resource
+                    # @return [DeactivationsContext] DeactivationsContext
+                    def initialize(version)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Deactivations"
+
+                        
+                    end
+                    ##
+                    # Fetch the DeactivationsInstance
+                    # @param [Date] date The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.
+                    # @return [DeactivationsInstance] Fetched DeactivationsInstance
+                    def fetch(
+                        date: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Date' => Twilio.serialize_iso8601_date(date),
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        DeactivationsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the DeactivationsInstanceMetadata
+                    # @param [Date] date The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.
+                    # @return [DeactivationsInstance] Fetched DeactivationsInstance
+                    def fetch_with_metadata(
+                      date: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Date' => Twilio.serialize_iso8601_date(date),
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        deactivations_instance = DeactivationsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        DeactivationsInstanceMetadata.new(
+                            @version,
+                            deactivations_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+                    end
+                end
+
+                class DeactivationsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DeactivationsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DeactivationsInstance] deactivations_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [DeactivationsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, deactivations_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @deactivations_instance = deactivations_instance
+                    end
+
+                    def deactivations
+                        @deactivations_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DeactivationsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DeactivationsListResponse < InstanceListResource
+                    # @param [Array<DeactivationsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @deactivations_instance = payload.body[key].map do |data|
+                        DeactivationsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def deactivations_instance
+                          @instance
+                      end
+                  end
+
+                class DeactivationsPage < Page
+                    ##
+                    # Initialize the DeactivationsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [DeactivationsPage] DeactivationsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of DeactivationsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [DeactivationsInstance] DeactivationsInstance
+                    def get_instance(payload)
+                        DeactivationsInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Messaging.V1.DeactivationsPage>'
+                    end
+                end
+
+                class DeactivationsPageMetadata < PageMetadata
+                    attr_reader :deactivations_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @deactivations_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @deactivations_page << DeactivationsListResponse.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
+                        @deactivations_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class DeactivationsListResponse < InstanceListResource
+
+                    # @param [Array<DeactivationsInstance>] 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
+                      @deactivations = data_list.map do |data|
+                        DeactivationsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def deactivations
+                        @deactivations
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class DeactivationsInstance < InstanceResource
+                    ##
+                    # Initialize the DeactivationsInstance
+                    # @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 Deactivations
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [DeactivationsInstance] DeactivationsInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'redirect_to' => payload['redirect_to'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = {  }
+                    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 [DeactivationsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = DeactivationsContext.new(@version )
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Returns an authenticated url that redirects to a file containing the deactivated numbers for the requested day. This url is valid for up to two minutes.
+                    def redirect_to
+                        @properties['redirect_to']
+                    end
+                    
+                    ##
+                    # Fetch the DeactivationsInstance
+                    # @param [Date] date The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.
+                    # @return [DeactivationsInstance] Fetched DeactivationsInstance
+                    def fetch(
+                        date: :unset
+                    )
+
+                        context.fetch(
+                            date: date, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end