twilio-ruby 7.10.5 → 7.10.7

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

@@ -0,0 +1,721 @@
+##
+#    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 ProfileList < ListResource
+                
+                    class ProfileData
+                            # @param [traits]: [Hash<String, Hash<String, Object>>] Multiple trait groups.
+                        attr_accessor :traits
+                        def initialize(payload)
+                                @traits = payload["traits"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "traits": @traits,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ProfilePatch
+                            # @param [traits]: [Hash<String, Hash<String, Object>>] Multiple trait groups.
+                        attr_accessor :traits
+                        def initialize(payload)
+                                @traits = payload["traits"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "traits": @traits,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class ProfileData
+                            # @param [traits]: [Hash<String, Hash<String, Object>>] Multiple trait groups.
+                        attr_accessor :traits
+                        def initialize(payload)
+                                @traits = payload["traits"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "traits": @traits,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ProfilePatch
+                            # @param [traits]: [Hash<String, Hash<String, Object>>] Multiple trait groups.
+                        attr_accessor :traits
+                        def initialize(payload)
+                                @traits = payload["traits"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "traits": @traits,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ProfileList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ProfileList] ProfileList
+                    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"
+                        
+                    end
+                    ##
+                    # Create the ProfileInstance
+                    # @param [ProfileData] profile_data 
+                    # @return [ProfileInstance] Created ProfileInstance
+                    def create(profile_data: 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: profile_data.to_json)
+                        ProfileInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                        )
+                    end
+
+                    ##
+                    # Create the ProfileInstanceMetadata
+                    # @param [ProfileData] profile_data 
+                    # @return [ProfileInstance] Created ProfileInstance
+                    def create_with_metadata(profile_data: 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: profile_data.to_json)
+                        profile_instance = ProfileInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                        )
+                        ProfileInstanceMetadata.new(
+                            @version,
+                            profile_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists ProfileInstance 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 ProfilePageMetadata 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)
+
+                        ProfilePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ProfileInstance 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 ProfileInstance 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 ProfileInstance
+                    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)
+
+                        ProfilePage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ProfileInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ProfileInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ProfilePage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.ProfileList>'
+                    end
+                end
+
+
+                class ProfileContext < InstanceContext
+                    ##
+                    # Initialize the ProfileContext
+                    # @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.
+                    # @return [ProfileContext] ProfileContext
+                    def initialize(version, store_id, profile_id)
+                        
+                        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]}"
+
+                        
+                    end
+                    ##
+                    # Delete the ProfileInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        ProfileInstance.new(
+                          @version,
+                          response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the ProfileInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          profile_instance = ProfileInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ProfileInstanceMetadata.new(@version, profile_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the ProfileInstance
+                    # @param [String] trait_groups Comma separated list of trait group names to include.
+                    # @return [ProfileInstance] Fetched ProfileInstance
+                    def fetch(
+                      trait_groups: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'traitGroups' => trait_groups,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        ProfileInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ProfileInstanceMetadata
+                    # @param [String] trait_groups Comma separated list of trait group names to include.
+                    # @return [ProfileInstance] Fetched ProfileInstance
+                    def fetch_with_metadata(
+                      trait_groups: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'traitGroups' => trait_groups,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        profile_instance = ProfileInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                        ProfileInstanceMetadata.new(
+                            @version,
+                            profile_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the ProfileInstance
+                    # @param [ProfilePatch] profile_patch 
+                    # @return [ProfileInstance] Patched ProfileInstance
+                    def patch(profile_patch: 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: profile_patch.to_json)
+                        ProfileInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                    end
+
+                    ##
+                    # Patch the ProfileInstanceMetadata
+                    # @param [ProfilePatch] profile_patch 
+                    # @return [ProfileInstance] Patchd ProfileInstance
+                    def patch_with_metadata(profile_patch: 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: profile_patch.to_json)
+                        profile_instance = ProfileInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                        ProfileInstanceMetadata.new(
+                            @version,
+                            profile_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.ProfileContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Memory.V1.ProfileContext #{context}>"
+                    end
+                end
+
+                class ProfileInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ProfileInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ProfileInstance] profile_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 [ProfileInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, profile_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @profile_instance = profile_instance
+                    end
+
+                    def profile
+                        @profile_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ProfileInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ProfileListResponse < InstanceListResource
+                    # @param [Array<ProfileInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @profile_instance = payload.body[key].map do |data|
+                        ProfileInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def profile_instance
+                          @instance
+                      end
+                  end
+
+                class ProfilePage < TokenPage
+                    ##
+                    # Initialize the ProfilePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ProfilePage] ProfilePage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ProfileInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ProfileInstance] ProfileInstance
+                    def get_instance(payload)
+                        ProfileInstance.new(@version, payload, store_id: @solution[:store_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.ProfilePage>'
+                    end
+                end
+
+                class ProfilePageMetadata < PageMetadata
+                    attr_reader :profile_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @profile_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @profile_page << ProfileListResponse.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
+                        @profile_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class ProfileListResponse < InstanceListResource
+
+                    # @param [Array<ProfileInstance>] 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
+                      @profile = data_list.map do |data|
+                        ProfileInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def profile
+                        @profile
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ProfileInstance < InstanceResource
+                    ##
+                    # Initialize the ProfileInstance
+                    # @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 Profile
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ProfileInstance] ProfileInstance
+                    def initialize(version, payload , store_id: nil, profile_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'message' => payload['message'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'traits' => payload['traits'],
+                            'profiles' => payload['profiles'],
+                            'meta' => payload['meta'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'store_id' => store_id  || @properties['store_id']  ,'profile_id' => profile_id  || @properties['profile_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 [ProfileContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ProfileContext.new(@version , @params['store_id'], @params['profile_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The canonical profile ID.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [Time] The time the profile was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, Hash<String, Object>>] Multiple trait groups.
+                    def traits
+                        @properties['traits']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] 
+                    def profiles
+                        @properties['profiles']
+                    end
+                    
+                    ##
+                    # @return [ProfilesMeta] 
+                    def meta
+                        @properties['meta']
+                    end
+                    
+                    ##
+                    # Delete the ProfileInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the ProfileInstance
+                    # @param [String] trait_groups Comma separated list of trait group names to include.
+                    # @return [ProfileInstance] Fetched ProfileInstance
+                    def fetch(
+                      trait_groups: :unset
+                    )
+
+                        context.fetch(
+                            trait_groups: trait_groups, 
+                        )
+                    end
+
+                    ##
+                    # Patch the ProfileInstance
+                    # @param [ProfilePatch] profile_patch 
+                    # @return [ProfileInstance] Patched ProfileInstance
+                    def patch(profile_patch: nil
+                    )
+
+                        context.patch(
+                            profile_patch: profile_patch, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.ProfileInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Memory.V1.ProfileInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end