twilio-ruby 7.10.5 → 7.10.6

data/lib/twilio-ruby/rest/memory/v1/revision.rb

@@ -0,0 +1,349 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Memory API
+#    APIs for managing memory stores, profiles, events, and conversational intelligence capabilities.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Memory < MemoryBase
+            class V1 < Version
+                class RevisionList < ListResource
+                
+                    ##
+                    # Initialize the RevisionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [RevisionList] RevisionList
+                    def initialize(version, store_id: nil, profile_id: nil, observation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { store_id: store_id, profile_id: profile_id, observation_id: observation_id }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/#{@solution[:profile_id]}/Observations/#{@solution[:observation_id]}/Revisions"
+                        
+                    end
+                
+                    ##
+                    # Lists RevisionInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    # @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(page_token: :unset, accept_encoding: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            accept_encoding: accept_encoding,
+                            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 [String] page_token The token for the page of results to retrieve.
+                    # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    # @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(page_token: :unset, accept_encoding: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            accept_encoding: accept_encoding,
+                            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 RevisionPageMetadata records from the API as a list.
+                      # @param [String] page_token The token for the page of results to retrieve.
+                      # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    # @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(page_token: :unset, accept_encoding: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'Accept-Encoding' => accept_encoding,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RevisionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields RevisionInstance 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 RevisionInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    
+                    # @return [Page] Page of RevisionInstance
+                    def page(page_token: :unset, accept_encoding: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'Accept-Encoding' => accept_encoding,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RevisionPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of RevisionInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of RevisionInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    RevisionPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.RevisionList>'
+                    end
+                end
+
+                class RevisionPage < TokenPage
+                    ##
+                    # Initialize the RevisionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [RevisionPage] RevisionPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of RevisionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [RevisionInstance] RevisionInstance
+                    def get_instance(payload)
+                        RevisionInstance.new(@version, payload, store_id: @solution[:store_id], profile_id: @solution[:profile_id], observation_id: @solution[:observation_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.RevisionPage>'
+                    end
+                end
+
+                class RevisionPageMetadata < PageMetadata
+                    attr_reader :revision_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @revision_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @revision_page << RevisionListResponse.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
+                        @revision_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class RevisionListResponse < InstanceListResource
+
+                    # @param [Array<RevisionInstance>] 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
+                      @revision = data_list.map do |data|
+                        RevisionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def revision
+                        @revision
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class RevisionInstance < InstanceResource
+                    ##
+                    # Initialize the RevisionInstance
+                    # @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 Revision
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [RevisionInstance] RevisionInstance
+                    def initialize(version, payload , store_id: nil, profile_id: nil, observation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'content' => payload['content'],
+                            'occurred_at' => Twilio.deserialize_iso8601_datetime(payload['occurred_at']),
+                            'source' => payload['source'],
+                            'conversation_ids' => payload['conversation_ids'],
+                            'id' => payload['id'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The main content of the observation.
+                    def content
+                        @properties['content']
+                    end
+                    
+                    ##
+                    # @return [Time] The timestamp when the observation originally occurred.
+                    def occurred_at
+                        @properties['occurred_at']
+                    end
+                    
+                    ##
+                    # @return [String] The source system that generated this observation. Allows letters, numbers, spaces, and URL-safe symbols. Excludes URL-unsafe characters like quotes, angle brackets, and control characters.
+                    def source
+                        @properties['source']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] Array of conversation IDs associated with this observation.
+                    def conversation_ids
+                        @properties['conversation_ids']
+                    end
+                    
+                    ##
+                    # @return [String] A unique identifier for the observation using Twilio Type ID (TTID) format.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [Time] The timestamp when the observation was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] The timestamp when the observation was last updated.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Memory.V1.RevisionInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Memory.V1.RevisionInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end