twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/sync/v1/service/document.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [DocumentList] DocumentList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Documents"
@@ -64,6 +65,44 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the DocumentInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the Sync Document
+                    # @param [Object] data A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
+                    # @param [String] ttl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live).
+                    # @return [DocumentInstance] Created DocumentInstance
+                    def create_with_metadata(
+                      unique_name: :unset, 
+                      data: :unset, 
+                      ttl: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'Data' => Twilio.serialize_object(data),
+                            'Ttl' => ttl,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        document_instance = DocumentInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        DocumentInstanceMetadata.new(
+                            @version,
+                            document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists DocumentInstance records from the API as a list.
@@ -103,6 +142,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists DocumentPageMetadata 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)
+
+                        DocumentPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields DocumentInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -124,7 +185,7 @@ module Twilio
                     # @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 DocumentInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -170,6 +231,7 @@ module Twilio
                     # @return [DocumentContext] DocumentContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -187,9 +249,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the DocumentInstanceMetadata
+                    # @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)
+                          document_instance = DocumentInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          DocumentInstanceMetadata.new(@version, document_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the DocumentInstance
                     # @return [DocumentInstance] Fetched DocumentInstance
@@ -210,6 +292,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the DocumentInstanceMetadata
+                    # @return [DocumentInstance] Fetched DocumentInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        document_instance = DocumentInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        DocumentInstanceMetadata.new(
+                            @version,
+                            document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the DocumentInstance
                     # @param [Object] data A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
@@ -242,6 +350,44 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the DocumentInstanceMetadata
+                    # @param [Object] data A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
+                    # @param [String] ttl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).
+                    # @param [String] if_match The If-Match HTTP request header
+                    # @return [DocumentInstance] Updated DocumentInstance
+                    def update_with_metadata(
+                      data: :unset, 
+                      ttl: :unset, 
+                      if_match: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Data' => Twilio.serialize_object(data),
+                            'Ttl' => ttl,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        document_instance = DocumentInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        DocumentInstanceMetadata.new(
+                            @version,
+                            document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the document_permissions
                     # @return [DocumentPermissionList]
@@ -277,6 +423,53 @@ module Twilio
                     end
                 end
 
+                class DocumentInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DocumentInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DocumentInstance] document_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 [DocumentInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, document_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @document_instance = document_instance
+                    end
+
+                    def document
+                        @document_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DocumentInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DocumentListResponse < InstanceListResource
+                    # @param [Array<DocumentInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @document_instance = payload.body[key].map do |data|
+                        DocumentInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def document_instance
+                          @instance
+                      end
+                  end
+
                 class DocumentPage < Page
                     ##
                     # Initialize the DocumentPage
@@ -286,6 +479,7 @@ module Twilio
                     # @return [DocumentPage] DocumentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -305,6 +499,66 @@ module Twilio
                         '<Twilio.Sync.V1.DocumentPage>'
                     end
                 end
+
+                class DocumentPageMetadata < PageMetadata
+                    attr_reader :document_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @document_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @document_page << DocumentListResponse.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
+                        @document_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Sync::V1PageMetadata>';
+                    end
+                end
+                class DocumentListResponse < InstanceListResource
+
+                    # @param [Array<DocumentInstance>] 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
+                      @document = data_list.map do |data|
+                        DocumentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def document
+                        @document
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DocumentInstance < InstanceResource
                     ##
                     # Initialize the DocumentInstance
@@ -318,6 +572,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],