twilio-ruby 7.11.1 → 7.11.2

data/lib/twilio-ruby/rest/numbers/v2/caller_id.rb

@@ -1,515 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Twilio - Numbers
-#    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 Numbers < NumbersBase
-            class V2 < Version
-                class CallerIdList < ListResource
-                
-                    ##
-                    # Initialize the CallerIdList
-                    # @param [Version] version Version that contains the resource
-                    # @return [CallerIdList] CallerIdList
-                    def initialize(version)
-                        super(version)
-                        
-                        # Path Solution
-                        @solution = {  }
-                        @uri = "/CallerIds"
-                        
-                    end
-                
-                    ##
-                    # Lists CallerIdInstance records from the API as a list.
-                    # Unlike stream(), this operation is eager and will load `limit` records into
-                    # memory before returning.
-                    # @param [Integer] limit Upper limit for the number of records to return. stream()
-                    #    guarantees to never return more than limit.  Default is no limit
-                    # @param [Integer] page_size Number of records to fetch per request, when
-                    #    not set will use the default value of 50 records.  If no page_size is defined
-                    #    but a limit is defined, stream() will attempt to read the limit with the most
-                    #    efficient page size, i.e. min(limit, 1000)
-                    # @return [Array] Array of up to limit results
-                    def list(limit: nil, page_size: nil)
-                        self.stream(
-                            limit: limit,
-                            page_size: page_size
-                        ).entries
-                    end
-
-                    ##
-                    # Streams Instance records from the API as an Enumerable.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    # @param [Integer] limit Upper limit for the number of records to return. stream()
-                    #    guarantees to never return more than limit.  Default is no limit
-                    # @param [Integer] page_size Number of records to fetch per request, when
-                    #    not set will use the default value of 50 records.  If no page_size is defined
-                    #    but a limit is defined, stream() will attempt to read the limit with the most
-                    #    efficient page size, i.e. min(limit, 1000)
-                    # @return [Enumerable] Enumerable that will yield up to limit results
-                    def stream(limit: nil, page_size: nil)
-                        limits = @version.read_limits(limit, page_size)
-
-                        page = self.page(
-                            page_size: limits[:page_size], )
-
-                        return [].each if page.nil?
-
-                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-                        return [].each if result.nil?
-                        result
-                    end
-
-                    ##
-                    # Lists CallerIdPageMetadata records from the API as a list.
-                    # @param [Integer] limit Upper limit for the number of records to return. stream()
-                    #    guarantees to never return more than limit.  Default is no limit
-                    # @param [Integer] page_size Number of records to fetch per request, when
-                    #    not set will use the default value of 50 records.  If no page_size is defined
-                    #    but a limit is defined, stream() will attempt to read the limit with the most
-                    #    efficient page size, i.e. min(limit, 1000)
-                    # @return [Array] Array of up to limit results
-                    def list_with_metadata(limit: nil, page_size: nil)
-                        limits = @version.read_limits(limit, page_size)
-                        params = Twilio::Values.of({
-                            
-                            'PageSize' => limits[:page_size],
-                        });
-                        headers = Twilio::Values.of({})
-
-                        response = @version.page('GET', @uri, params: params, headers: headers)
-
-                        CallerIdPageMetadata.new(@version, response, @solution, limits[:limit])
-                    end
-
-                    ##
-                    # When passed a block, yields CallerIdInstance records from the API.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    def each
-                        limits = @version.read_limits
-
-                        page = self.page(page_size: limits[:page_size], )
-
-                        return [].each if page.nil?
-
-                        result = @version.stream(page,
-                            limit: limits[:limit],
-                            page_limit: limits[:page_limit])
-                        return [].each if result.nil?
-                        result.each {|x| yield x}
-                    end
-
-                    ##
-                    # Retrieve a single page of CallerIdInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] page_token PageToken provided by the API
-                    # @param [Integer] page_number Page Number, this value is simply for client state
-                    # @param [Integer] page_size Number of records to return, defaults to 50
-                    # @return [Page] Page of CallerIdInstance
-                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
-                        params = Twilio::Values.of({
-                            'PageToken' => page_token,
-                            'Page' => page_number,
-                            'PageSize' => page_size,
-                        })
-                        headers = Twilio::Values.of({})
-                        
-                        
-
-                        response = @version.page('GET', @uri, params: params, headers: headers)
-
-                        CallerIdPage.new(@version, response, @solution)
-                    end
-
-                    ##
-                    # Retrieve a single page of CallerIdInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of CallerIdInstance
-                    def get_page(target_url)
-                        response = @version.domain.request(
-                            'GET',
-                            target_url
-                        )
-                    CallerIdPage.new(@version, response, @solution)
-                    end
-                    
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Numbers.V2.CallerIdList>'
-                    end
-                end
-
-
-                class CallerIdContext < InstanceContext
-                    ##
-                    # Initialize the CallerIdContext
-                    # @param [Version] version Version that contains the resource
-                    # @param [String] caller_id_sid 
-                    # @return [CallerIdContext] CallerIdContext
-                    def initialize(version, caller_id_sid)
-                        super(version)
-                        
-
-                        # Path Solution
-                        @solution = { caller_id_sid: caller_id_sid,  }
-                        @uri = "/CallerIds/#{@solution[:caller_id_sid]}"
-
-                        
-                    end
-                    ##
-                    # Delete the CallerIdInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        
-                        
-
-                        @version.delete('DELETE', @uri, headers: headers)
-                    end
-
-                    ##
-                    # Delete the CallerIdInstanceMetadata
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete_with_metadata
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        
-                        
-                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
-                          callerId_instance = CallerIdInstance.new(
-                              @version,
-                              response.body,
-                              account_sid: @solution[:account_sid],
-                              sid: @solution[:sid],
-                          )
-                          CallerIdInstanceMetadata.new(@version, callerId_instance, response.headers, response.status_code)
-                    end
-
-                    ##
-                    # Update the CallerIdInstance
-                    # @return [CallerIdInstance] Updated CallerIdInstance
-                    def update
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        
-                        
-                        
-                        
-                        payload = @version.update('POST', @uri, headers: headers)
-                        CallerIdInstance.new(
-                            @version,
-                            payload,
-                            caller_id_sid: @solution[:caller_id_sid],
-                        )
-                    end
-
-                    ##
-                    # Update the CallerIdInstanceMetadata
-                    # @return [CallerIdInstance] Updated CallerIdInstance
-                    def update_with_metadata
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        
-                        
-                        
-                        
-                        response = @version.update_with_metadata('POST', @uri, headers: headers)
-                        caller_id_instance = CallerIdInstance.new(
-                            @version,
-                            response.body,
-                            caller_id_sid: @solution[:caller_id_sid],
-                        )
-                        CallerIdInstanceMetadata.new(
-                            @version,
-                            caller_id_instance,
-                            response.headers,
-                            response.status_code
-                        )
-                    end
-
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Numbers.V2.CallerIdContext #{context}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Numbers.V2.CallerIdContext #{context}>"
-                    end
-                end
-
-                class CallerIdInstanceMetadata <  InstanceResourceMetadata
-                    ##
-                    # Initializes a new CallerIdInstanceMetadata.
-                    # @param [Version] version Version that contains the resource
-                    # @param [}CallerIdInstance] caller_id_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 [CallerIdInstanceMetadata] The initialized instance with metadata.
-                    def initialize(version, caller_id_instance, headers, status_code)
-                        super(version, headers, status_code)
-                        @caller_id_instance = caller_id_instance
-                    end
-
-                    def caller_id
-                        @caller_id_instance
-                    end
-
-                    def headers
-                        @headers
-                    end
-
-                    def status_code
-                        @status_code
-                    end
-
-                    def to_s
-                      "<Twilio.Api.V2010.CallerIdInstanceMetadata status=#{@status_code}>"
-                    end
-                end
-
-                class CallerIdListResponse < InstanceListResource
-                    # @param [Array<CallerIdInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key)
-                       @caller_id_instance = payload.body[key].map do |data|
-                        CallerIdInstance.new(version, data)
-                       end
-                       @headers = payload.headers
-                       @status_code = payload.status_code
-                    end
-
-                      def caller_id_instance
-                          @instance
-                      end
-                  end
-
-                class CallerIdPage < Page
-                    ##
-                    # Initialize the CallerIdPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [CallerIdPage] CallerIdPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-                        
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of CallerIdInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [CallerIdInstance] CallerIdInstance
-                    def get_instance(payload)
-                        CallerIdInstance.new(@version, payload)
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.Numbers.V2.CallerIdPage>'
-                    end
-                end
-
-                class CallerIdPageMetadata < PageMetadata
-                    attr_reader :caller_id_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @caller_id_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @caller_id_page << CallerIdListResponse.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
-                        @caller_id_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Numbers::V2PageMetadata>';
-                    end
-                end
-                class CallerIdListResponse < InstanceListResource
-
-                    # @param [Array<CallerIdInstance>] 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
-                      @caller_id = data_list.map do |data|
-                        CallerIdInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def caller_id
-                        @caller_id
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
-                class CallerIdInstance < InstanceResource
-                    ##
-                    # Initialize the CallerIdInstance
-                    # @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 CallerId
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [CallerIdInstance] CallerIdInstance
-                    def initialize(version, payload , caller_id_sid: nil)
-                        super(version)
-                        
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'sid' => payload['sid'],
-                            'account_sid' => payload['account_sid'],
-                            'phone_number' => payload['phone_number'],
-                            'friendly_name' => payload['friendly_name'],
-                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                        }
-
-                        # Context
-                        @instance_context = nil
-                        @params = { 'caller_id_sid' => caller_id_sid  || @properties['caller_id_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 [CallerIdContext] CallContext for this CallInstance
-                    def context
-                        unless @instance_context
-                            @instance_context = CallerIdContext.new(@version , @params['caller_id_sid'])
-                        end
-                        @instance_context
-                    end
-                    
-                    ##
-                    # @return [String] The unique SID of this Caller ID resource.
-                    def sid
-                        @properties['sid']
-                    end
-                    
-                    ##
-                    # @return [String] The Account SID that owns this Caller ID.
-                    def account_sid
-                        @properties['account_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The phone number in E.164 format.
-                    def phone_number
-                        @properties['phone_number']
-                    end
-                    
-                    ##
-                    # @return [String] A human-readable name for this caller ID.
-                    def friendly_name
-                        @properties['friendly_name']
-                    end
-                    
-                    ##
-                    # @return [Time] The date this resource was created.
-                    def date_created
-                        @properties['date_created']
-                    end
-                    
-                    ##
-                    # @return [Time] The date this resource was last updated.
-                    def date_updated
-                        @properties['date_updated']
-                    end
-                    
-                    ##
-                    # Delete the CallerIdInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        context.delete
-                    end
-
-                    ##
-                    # Update the CallerIdInstance
-                    # @return [CallerIdInstance] Updated CallerIdInstance
-                    def update
-
-                        context.update
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Numbers.V2.CallerIdInstance #{values}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Numbers.V2.CallerIdInstance #{values}>"
-                    end
-                end
-
-            end
-        end
-    end
-end