twilio-ruby 7.10.5 → 7.10.6

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

@@ -0,0 +1,701 @@
+##
+#    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 StoreList < ListResource
+                
+                    class PatchStoreRequest
+                            # @param [display_name]: [String] Provides a unique and addressable name to be assigned to this Store. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.
+                            # @param [description]: [String] A human readable description of this resource, up to 128 characters.
+                        attr_accessor :display_name, :description
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ServiceRequest
+                            # @param [display_name]: [String] Provides a unique and addressable name to be assigned to this Store. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.
+                            # @param [description]: [String] A human readable description of this resource, up to 128 characters.
+                        attr_accessor :display_name, :description
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class PatchStoreRequest
+                            # @param [display_name]: [String] Provides a unique and addressable name to be assigned to this Store. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.
+                            # @param [description]: [String] A human readable description of this resource, up to 128 characters.
+                        attr_accessor :display_name, :description
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ServiceRequest
+                            # @param [display_name]: [String] Provides a unique and addressable name to be assigned to this Store. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.
+                            # @param [description]: [String] A human readable description of this resource, up to 128 characters.
+                        attr_accessor :display_name, :description
+                        def initialize(payload)
+                                @display_name = payload["display_name"]
+                                @description = payload["description"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "displayName": @display_name,
+                                "description": @description,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the StoreList
+                    # @param [Version] version Version that contains the resource
+                    # @return [StoreList] StoreList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ControlPlane/Stores"
+                        
+                    end
+                    ##
+                    # Create the StoreInstance
+                    # @param [ServiceRequest] service_request 
+                    # @return [StoreInstance] Created StoreInstance
+                    def create(service_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: service_request.to_json)
+                        StoreInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the StoreInstanceMetadata
+                    # @param [ServiceRequest] service_request 
+                    # @return [StoreInstance] Created StoreInstance
+                    def create_with_metadata(service_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: service_request.to_json)
+                        store_instance = StoreInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        StoreInstanceMetadata.new(
+                            @version,
+                            store_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists StoreInstance 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] order_by Either 'ASC' or 'DESC' to sort results ascending or descending respectively.
+                    # @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, order_by: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            order_by: order_by,
+                            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] order_by Either 'ASC' or 'DESC' to sort results ascending or descending respectively.
+                    # @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, order_by: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            order_by: order_by,
+                            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 StorePageMetadata records from the API as a list.
+                      # @param [String] page_token The token for the page of results to retrieve.
+                      # @param [String] order_by Either 'ASC' or 'DESC' to sort results ascending or descending respectively.
+                    # @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, order_by: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'orderBy' => order_by,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        StorePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields StoreInstance 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 StoreInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    # @param [String] order_by Either 'ASC' or 'DESC' to sort results ascending or descending respectively.
+                    
+                    # @return [Page] Page of StoreInstance
+                    def page(page_token: :unset, order_by: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'orderBy' => order_by,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        StorePage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of StoreInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of StoreInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    StorePage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.StoreList>'
+                    end
+                end
+
+
+                class StoreContext < InstanceContext
+                    ##
+                    # Initialize the StoreContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] store_id A unique Memory Store ID using Twilio Type ID (TTID) format
+                    # @return [StoreContext] StoreContext
+                    def initialize(version, store_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { store_id: store_id,  }
+                        @uri = "/ControlPlane/Stores/#{@solution[:store_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the StoreInstance
+                    # @return [StoreInstance] Fetched StoreInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        StoreInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the StoreInstanceMetadata
+                    # @return [StoreInstance] Fetched StoreInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        store_instance = StoreInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                        )
+                        StoreInstanceMetadata.new(
+                            @version,
+                            store_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the StoreInstance
+                    # @param [String] if_match Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.
+                    # @param [PatchStoreRequest] patch_store_request 
+                    # @return [StoreInstance] Patched StoreInstance
+                    def patch(
+                      if_match: :unset,
+                      patch_store_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.patch('PATCH', @uri, headers: headers, data: patch_store_request.to_json)
+                        StoreInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                        )
+                    end
+
+                    ##
+                    # Patch the StoreInstanceMetadata
+                    # @param [String] if_match Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.
+                    # @param [PatchStoreRequest] patch_store_request 
+                    # @return [StoreInstance] Patchd StoreInstance
+                    def patch_with_metadata(
+                      if_match: :unset,
+                    patch_store_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: patch_store_request.to_json)
+                        store_instance = StoreInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                        )
+                        StoreInstanceMetadata.new(
+                            @version,
+                            store_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Memory.V1.StoreContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Memory.V1.StoreContext #{context}>"
+                    end
+                end
+
+                class StoreInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new StoreInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}StoreInstance] store_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 [StoreInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, store_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @store_instance = store_instance
+                    end
+
+                    def store
+                        @store_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.StoreInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class StoreListResponse < InstanceListResource
+                    # @param [Array<StoreInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @store_instance = payload.body[key].map do |data|
+                        StoreInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def store_instance
+                          @instance
+                      end
+                  end
+
+                class StorePage < TokenPage
+                    ##
+                    # Initialize the StorePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [StorePage] StorePage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of StoreInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [StoreInstance] StoreInstance
+                    def get_instance(payload)
+                        StoreInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.StorePage>'
+                    end
+                end
+
+                class StorePageMetadata < PageMetadata
+                    attr_reader :store_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @store_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @store_page << StoreListResponse.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
+                        @store_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class StoreListResponse < InstanceListResource
+
+                    # @param [Array<StoreInstance>] 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
+                      @store = data_list.map do |data|
+                        StoreInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def store
+                        @store
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class StoreInstance < InstanceResource
+                    ##
+                    # Initialize the StoreInstance
+                    # @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 Store
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [StoreInstance] StoreInstance
+                    def initialize(version, payload , store_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'message' => payload['message'],
+                            'status_url' => payload['status_url'],
+                            'display_name' => payload['display_name'],
+                            'description' => payload['description'],
+                            'id' => payload['id'],
+                            'status' => payload['status'],
+                            'intelligence_service_id' => payload['intelligence_service_id'],
+                            'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
+                            'stores' => payload['stores'],
+                            'meta' => payload['meta'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'store_id' => store_id  || @properties['store_id']  , }
+                    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 [StoreContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = StoreContext.new(@version , @params['store_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] URI to check operation status.
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [String] Provides a unique and addressable name to be assigned to this Store. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.
+                    def display_name
+                        @properties['display_name']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable description of this resource, up to 128 characters.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier for the Memory Store
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The current status of the Memory Store.  A store begins in the QUEUED state as it is scheduled for processing.  It then moves to PROVISIONING at the beginning of processing. It transitions to ACTIVE once all dependent resources are provisioned, including Conversational Intelligence capabilities.  If there is an issue provisioning resources, the store will move to the FAILED state.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The ID of the associated intelligence service that was provisioned for memory extraction.
+                    def intelligence_service_id
+                        @properties['intelligence_service_id']
+                    end
+                    
+                    ##
+                    # @return [String] The current version number of the Memory Store. Incremented on each successful update.
+                    def version
+                        @properties['version']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] List of Memory Store IDs associated with the Twilio account.
+                    def stores
+                        @properties['stores']
+                    end
+                    
+                    ##
+                    # @return [Meta] 
+                    def meta
+                        @properties['meta']
+                    end
+                    
+                    ##
+                    # Fetch the StoreInstance
+                    # @return [StoreInstance] Fetched StoreInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Patch the StoreInstance
+                    # @param [String] if_match Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.
+                    # @param [PatchStoreRequest] patch_store_request 
+                    # @return [StoreInstance] Patched StoreInstance
+                    def patch(
+                      if_match: :unset,
+                      patch_store_request: :unset
+                    )
+
+                        context.patch(
+                            if_match: if_match, 
+                            patch_store_request: patch_store_request, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.StoreInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.StoreInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end