twilio-ruby 7.10.5 → 7.10.6

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

@@ -0,0 +1,574 @@
+##
+#    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 ImportList < ListResource
+                
+                    class CreateProfilesImportV2Request
+                            # @param [filename]: [String] The name of the file to generate a presigned URL
+                            # @param [file_size]: [String] The size of the file in bytes (1 byte to 100 MiB)
+                            # @param [column_mappings]: [Array<ImportList.ColumnMappingItem>] Mappings of CSV header columns to traits' fields
+                        attr_accessor :filename, :file_size, :column_mappings
+                        def initialize(payload)
+                                @filename = payload["filename"]
+                                @file_size = payload["file_size"]
+                                @column_mappings = payload["column_mappings"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "filename": @filename,
+                                "fileSize": @file_size,
+                                "columnMappings": @column_mappings,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ImportList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ImportList] ImportList
+                    def initialize(version, store_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { store_id: store_id }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/Imports"
+                        
+                    end
+                    ##
+                    # Create the ImportInstance
+                    # @param [CreateProfilesImportV2Request] create_profiles_import_v2_request 
+                    # @return [ImportInstance] Created ImportInstance
+                    def create(create_profiles_import_v2_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: create_profiles_import_v2_request.to_json)
+                        ImportInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                        )
+                    end
+
+                    ##
+                    # Create the ImportInstanceMetadata
+                    # @param [CreateProfilesImportV2Request] create_profiles_import_v2_request 
+                    # @return [ImportInstance] Created ImportInstance
+                    def create_with_metadata(create_profiles_import_v2_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: create_profiles_import_v2_request.to_json)
+                        import_instance = ImportInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                        )
+                        ImportInstanceMetadata.new(
+                            @version,
+                            import_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists ImportInstance 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 ImportPageMetadata 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)
+
+                        ImportPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ImportInstance 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 ImportInstance records from the API.
+                    # Request is executed immediately.
+                    
+                    # @return [Page] Page of ImportInstance
+                    def page(page_size: :unset)
+                        params = Twilio::Values.of({
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ImportPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ImportInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ImportInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ImportPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.ImportList>'
+                    end
+                end
+
+
+                class ImportContext < InstanceContext
+                    ##
+                    # Initialize the ImportContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] store_id A unique Memory Store ID using Twilio Type ID (TTID) format
+                    # @param [String] import_id The task identifier for the import process.
+                    # @return [ImportContext] ImportContext
+                    def initialize(version, store_id, import_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { store_id: store_id, import_id: import_id,  }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/Imports/#{@solution[:import_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the ImportInstance
+                    # @return [ImportInstance] Fetched ImportInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ImportInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            import_id: @solution[:import_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ImportInstanceMetadata
+                    # @return [ImportInstance] Fetched ImportInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        import_instance = ImportInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            import_id: @solution[:import_id],
+                        )
+                        ImportInstanceMetadata.new(
+                            @version,
+                            import_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.ImportContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Memory.V1.ImportContext #{context}>"
+                    end
+                end
+
+                class ImportInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ImportInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ImportInstance] import_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 [ImportInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, import_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @import_instance = import_instance
+                    end
+
+                    def import
+                        @import_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ImportInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ImportListResponse < InstanceListResource
+                    # @param [Array<ImportInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @import_instance = payload.body[key].map do |data|
+                        ImportInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def import_instance
+                          @instance
+                      end
+                  end
+
+                class ImportPage < TokenPage
+                    ##
+                    # Initialize the ImportPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ImportPage] ImportPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ImportInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ImportInstance] ImportInstance
+                    def get_instance(payload)
+                        ImportInstance.new(@version, payload, store_id: @solution[:store_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.ImportPage>'
+                    end
+                end
+
+                class ImportPageMetadata < PageMetadata
+                    attr_reader :import_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @import_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @import_page << ImportListResponse.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
+                        @import_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class ImportListResponse < InstanceListResource
+
+                    # @param [Array<ImportInstance>] 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
+                      @import = data_list.map do |data|
+                        ImportInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def import
+                        @import
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ImportInstance < InstanceResource
+                    ##
+                    # Initialize the ImportInstance
+                    # @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 Import
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ImportInstance] ImportInstance
+                    def initialize(version, payload , store_id: nil, import_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'import_id' => payload['import_id'],
+                            'url' => payload['url'],
+                            'status' => payload['status'],
+                            'filename' => payload['filename'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'file_size' => payload['file_size'] == nil ? payload['file_size'] : payload['file_size'].to_i,
+                            'column_mappings' => payload['column_mappings'],
+                            'summary' => payload['summary'],
+                            'imports' => payload['imports'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'store_id' => store_id  || @properties['store_id']  ,'import_id' => import_id  || @properties['import_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 [ImportContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ImportContext.new(@version , @params['store_id'], @params['import_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] ID of the import task.
+                    def import_id
+                        @properties['import_id']
+                    end
+                    
+                    ##
+                    # @return [String] Pre-signed URL to upload the CSV via a single PUT request.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [String] Current processing status of the import task
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] Original filename of the uploaded CSV
+                    def filename
+                        @properties['filename']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when the import was created
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when the import was last updated
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [String] Size of the uploaded file in bytes (1 byte to 100 MiB)
+                    def file_size
+                        @properties['file_size']
+                    end
+                    
+                    ##
+                    # @return [Array<ColumnMappingItem>] Mappings of CSV header columns to traits' fields
+                    def column_mappings
+                        @properties['column_mappings']
+                    end
+                    
+                    ##
+                    # @return [FetchProfileImportV2200ResponseSummary] 
+                    def summary
+                        @properties['summary']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] 
+                    def imports
+                        @properties['imports']
+                    end
+                    
+                    ##
+                    # Fetch the ImportInstance
+                    # @return [ImportInstance] Fetched ImportInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.ImportInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.ImportInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end