twilio-ruby 7.10.5 → 7.10.6

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

@@ -0,0 +1,710 @@
+##
+#    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 IdentifierList < ListResource
+                
+                    class Identifier
+                            # @param [id_type]: [String] Identifier type as configured in the service's Identity Resolution Settings.
+                            # @param [value]: [String] Raw value captured for the identifier. The service may normalize this value according to the `normalization` rule defined in the identifier settings before storage or matching (for example E.164 formatting for phone numbers).
+                        attr_accessor :id_type, :value
+                        def initialize(payload)
+                                @id_type = payload["id_type"]
+                                @value = payload["value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "idType": @id_type,
+                                "value": @value,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IdentifierUpdate
+                            # @param [id_type]: [String] The identifier type to update (e.g., email, phone).
+                            # @param [old_value]: [String] Existing stored value to replace.
+                            # @param [new_value]: [String] New value to store for the identifier. Normalization rules from the corresponding identifier settings apply.
+                        attr_accessor :id_type, :old_value, :new_value
+                        def initialize(payload)
+                                @id_type = payload["id_type"]
+                                @old_value = payload["old_value"]
+                                @new_value = payload["new_value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "idType": @id_type,
+                                "oldValue": @old_value,
+                                "newValue": @new_value,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class Identifier
+                            # @param [id_type]: [String] Identifier type as configured in the service's Identity Resolution Settings.
+                            # @param [value]: [String] Raw value captured for the identifier. The service may normalize this value according to the `normalization` rule defined in the identifier settings before storage or matching (for example E.164 formatting for phone numbers).
+                        attr_accessor :id_type, :value
+                        def initialize(payload)
+                                @id_type = payload["id_type"]
+                                @value = payload["value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "idType": @id_type,
+                                "value": @value,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IdentifierUpdate
+                            # @param [id_type]: [String] The identifier type to update (e.g., email, phone).
+                            # @param [old_value]: [String] Existing stored value to replace.
+                            # @param [new_value]: [String] New value to store for the identifier. Normalization rules from the corresponding identifier settings apply.
+                        attr_accessor :id_type, :old_value, :new_value
+                        def initialize(payload)
+                                @id_type = payload["id_type"]
+                                @old_value = payload["old_value"]
+                                @new_value = payload["new_value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "idType": @id_type,
+                                "oldValue": @old_value,
+                                "newValue": @new_value,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the IdentifierList
+                    # @param [Version] version Version that contains the resource
+                    # @return [IdentifierList] IdentifierList
+                    def initialize(version, store_id: nil, profile_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { store_id: store_id, profile_id: profile_id }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/#{@solution[:profile_id]}/Identifiers"
+                        
+                    end
+                    ##
+                    # Create the IdentifierInstance
+                    # @param [Identifier] identifier 
+                    # @return [IdentifierInstance] Created IdentifierInstance
+                    def create(identifier: 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: identifier.to_json)
+                        IdentifierInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                    end
+
+                    ##
+                    # Create the IdentifierInstanceMetadata
+                    # @param [Identifier] identifier 
+                    # @return [IdentifierInstance] Created IdentifierInstance
+                    def create_with_metadata(identifier: 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: identifier.to_json)
+                        identifier_instance = IdentifierInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                        IdentifierInstanceMetadata.new(
+                            @version,
+                            identifier_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists IdentifierInstance 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 IdentifierPageMetadata 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)
+
+                        IdentifierPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields IdentifierInstance 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 IdentifierInstance records from the API.
+                    # Request is executed immediately.
+                    
+                    # @return [Page] Page of IdentifierInstance
+                    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)
+
+                        IdentifierPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of IdentifierInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of IdentifierInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    IdentifierPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.IdentifierList>'
+                    end
+                end
+
+
+                class IdentifierContext < InstanceContext
+                    ##
+                    # Initialize the IdentifierContext
+                    # @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] profile_id The unique identifier for the profile using Twilio Type ID (TTID) format.
+                    # @param [String] id_type Identifier type configured for the service (for example `email`, `phone`, or `externalId`).
+                    # @return [IdentifierContext] IdentifierContext
+                    def initialize(version, store_id, profile_id, id_type)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { store_id: store_id, profile_id: profile_id, id_type: id_type,  }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/#{@solution[:profile_id]}/Identifiers/#{@solution[:id_type]}"
+
+                        
+                    end
+                    ##
+                    # Delete the IdentifierInstance
+                    # @param [Boolean] remove_all When true, removes every stored value for the identifier type in a single operation. Defaults to false.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete(
+                      remove_all: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'removeAll' => remove_all,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, params: params, headers: headers)
+                        IdentifierInstance.new(
+                          @version,
+                          response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                            id_type: @solution[:id_type],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the IdentifierInstanceMetadata
+                    # @param [Boolean] remove_all When true, removes every stored value for the identifier type in a single operation. Defaults to false.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      remove_all: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'removeAll' => remove_all,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, params: params, headers: headers)
+                          identifier_instance = IdentifierInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          IdentifierInstanceMetadata.new(@version, identifier_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the IdentifierInstance
+                    # @return [IdentifierInstance] Fetched IdentifierInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        IdentifierInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                            id_type: @solution[:id_type],
+                        )
+                    end
+
+                    ##
+                    # Fetch the IdentifierInstanceMetadata
+                    # @return [IdentifierInstance] Fetched IdentifierInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        identifier_instance = IdentifierInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                            id_type: @solution[:id_type],
+                        )
+                        IdentifierInstanceMetadata.new(
+                            @version,
+                            identifier_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the IdentifierInstance
+                    # @param [IdentifierUpdate] identifier_update 
+                    # @return [IdentifierInstance] Patched IdentifierInstance
+                    def patch(identifier_update: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.patch('PATCH', @uri, headers: headers, data: identifier_update.to_json)
+                        IdentifierInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                            id_type: @solution[:id_type],
+                        )
+                    end
+
+                    ##
+                    # Patch the IdentifierInstanceMetadata
+                    # @param [IdentifierUpdate] identifier_update 
+                    # @return [IdentifierInstance] Patchd IdentifierInstance
+                    def patch_with_metadata(identifier_update: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: identifier_update.to_json)
+                        identifier_instance = IdentifierInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                            id_type: @solution[:id_type],
+                        )
+                        IdentifierInstanceMetadata.new(
+                            @version,
+                            identifier_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.IdentifierContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Memory.V1.IdentifierContext #{context}>"
+                    end
+                end
+
+                class IdentifierInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new IdentifierInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}IdentifierInstance] identifier_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 [IdentifierInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, identifier_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @identifier_instance = identifier_instance
+                    end
+
+                    def identifier
+                        @identifier_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.IdentifierInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class IdentifierListResponse < InstanceListResource
+                    # @param [Array<IdentifierInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @identifier_instance = payload.body[key].map do |data|
+                        IdentifierInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def identifier_instance
+                          @instance
+                      end
+                  end
+
+                class IdentifierPage < TokenPage
+                    ##
+                    # Initialize the IdentifierPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [IdentifierPage] IdentifierPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of IdentifierInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [IdentifierInstance] IdentifierInstance
+                    def get_instance(payload)
+                        IdentifierInstance.new(@version, payload, store_id: @solution[:store_id], profile_id: @solution[:profile_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.IdentifierPage>'
+                    end
+                end
+
+                class IdentifierPageMetadata < PageMetadata
+                    attr_reader :identifier_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @identifier_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @identifier_page << IdentifierListResponse.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
+                        @identifier_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class IdentifierListResponse < InstanceListResource
+
+                    # @param [Array<IdentifierInstance>] 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
+                      @identifier = data_list.map do |data|
+                        IdentifierInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def identifier
+                        @identifier
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class IdentifierInstance < InstanceResource
+                    ##
+                    # Initialize the IdentifierInstance
+                    # @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 Identifier
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [IdentifierInstance] IdentifierInstance
+                    def initialize(version, payload , store_id: nil, profile_id: nil, id_type: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'message' => payload['message'],
+                            'id_type' => payload['id_type'],
+                            'values' => payload['values'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'store_id' => store_id  || @properties['store_id']  ,'profile_id' => profile_id  || @properties['profile_id']  ,'id_type' => id_type  || @properties['id_type']  , }
+                    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 [IdentifierContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = IdentifierContext.new(@version , @params['store_id'], @params['profile_id'], @params['id_type'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] Identifier type defined in Identity Resolution Settings.
+                    def id_type
+                        @properties['id_type']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] Server managed collection of stored values for the identifier type.  Identifier values are normalized according to the corresponding identifier settings and ordered chronologically.
+                    def values
+                        @properties['values']
+                    end
+                    
+                    ##
+                    # Delete the IdentifierInstance
+                    # @param [Boolean] remove_all When true, removes every stored value for the identifier type in a single operation. Defaults to false.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete(
+                      remove_all: :unset
+                    )
+
+                        context.delete(
+                            remove_all: remove_all, 
+                        )
+                    end
+
+                    ##
+                    # Fetch the IdentifierInstance
+                    # @return [IdentifierInstance] Fetched IdentifierInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Patch the IdentifierInstance
+                    # @param [IdentifierUpdate] identifier_update 
+                    # @return [IdentifierInstance] Patched IdentifierInstance
+                    def patch(identifier_update: nil
+                    )
+
+                        context.patch(
+                            identifier_update: identifier_update, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.IdentifierInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.IdentifierInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end