memori-client 0.1.1 → 0.1.6

data/lib/memori_client/engine/v2/custom_dictionary.rb

@@ -1,55 +1,79 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::CustomDictionary < MemoriClient::Engine::Resource
-    # GET /memori/v2/CustomWords/{strSessionID}
+    # `GET /memori/v2/CustomWords/{strSessionID}`
+    #
     # Lists all Custom Word objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # list_custom_words(strSessionID:)
+    #
+    # `list_custom_words(strSessionID:)`
     def self.list_custom_words(strSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/CustomWords/{strSessionID}', **args)
     end
 
-    # GET /memori/v2/CustomWords/{strSessionID}/{from}/{howMany}
+    # `GET /memori/v2/CustomWords/{strSessionID}/{from}/{howMany}`
+    #
     # Lists Custom Word objects with pagination.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [integer] from The 0-based index of the first Custom Word to list. required
+    #
     # @param [integer] howMany The number of the Custom Word to list. required
-    # list_custom_words_paginated(strSessionID:, from:, howMany:)
+    #
+    # `list_custom_words_paginated(strSessionID:, from:, howMany:)`
     def self.list_custom_words_paginated(strSessionID:, from:, howMany:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/CustomWords/{strSessionID}/{from}/{howMany}', **args)
     end
 
-    # GET /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}
+    # `GET /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
+    #
     # Gets the details of a Custom Word object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strCustomWordID The Custom Word object ID. required
-    # get_custom_word(strSessionID:, strCustomWordID:)
+    #
+    # `get_custom_word(strSessionID:, strCustomWordID:)`
     def self.get_custom_word(strSessionID:, strCustomWordID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}', **args)
     end
 
-    # PATCH /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}
+    # `PATCH /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
+    #
     # Updates an existing Custom Word object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strCustomWordID The Custom Word object ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.customWordID . optional
-    # @param [string] payload.word . optional
-    # @param [string] payload.definition . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # update_custom_word(strSessionID:, strCustomWordID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.customWordID . optional
+    #
+    # @param [String] payload.word . optional
+    #
+    # @param [String] payload.definition . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `update_custom_word(strSessionID:, strCustomWordID:, payload: {})`
     def self.update_custom_word(strSessionID:, strCustomWordID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -67,31 +91,46 @@ class MemoriClient::Engine::V2::CustomDictionary < MemoriClient::Engine::Resourc
       exec_http_request('patch', '/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}', **args)
     end
 
-    # DELETE /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}
+    # `DELETE /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
+    #
     # Removes an existing Custom Word object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strCustomWordID The Custom Word object ID. required
-    # remove_custom_word(strSessionID:, strCustomWordID:)
+    #
+    # `remove_custom_word(strSessionID:, strCustomWordID:)`
     def self.remove_custom_word(strSessionID:, strCustomWordID:)
       args = build_arguments(binding)
 
       exec_http_request('delete', '/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}', **args)
     end
 
-    # POST /memori/v2/CustomWord/{strSessionID}
+    # `POST /memori/v2/CustomWord/{strSessionID}`
+    #
     # Adds a new Custom Word object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.customWordID . optional
-    # @param [string] payload.word . optional
-    # @param [string] payload.definition . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # add_custom_word(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.customWordID . optional
+    #
+    # @param [String] payload.word . optional
+    #
+    # @param [String] payload.definition . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `add_custom_word(strSessionID:, payload: {})`
     def self.add_custom_word(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [

data/lib/memori_client/engine/v2/dialog.rb

@@ -1,51 +1,69 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::Dialog < MemoriClient::Engine::Resource
-    # POST /memori/v2/TextEnteredEvent/{strSessionID}
+    # `POST /memori/v2/TextEnteredEvent/{strSessionID}`
+    #
     # Submits a Text Entered event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.text . required
-    # enter_text(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.text . optional
+    #
+    # `enter_text(strSessionID:, payload: {})`
     def self.enter_text(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'text',
       ]
-      payload_required_keys = %w[text]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/TextEnteredEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/DateChangedEvent/{strSessionID}
+    # `POST /memori/v2/DateChangedEvent/{strSessionID}`
+    #
     # Submits a Date Changed event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.date . required
-    # change_date(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # `change_date(strSessionID:, payload: {})`
     def self.change_date(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'date',
       ]
-      payload_required_keys = %w[date]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/DateChangedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/PlaceChangedEvent/{strSessionID}
+    # `POST /memori/v2/PlaceChangedEvent/{strSessionID}`
+    #
     # Submits a Place Changed event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.placeName . optional
-    # @param [number] payload.latitude . optional
-    # @param [number] payload.longitude . optional
-    # @param [number] payload.uncertaintyKm . optional
-    # change_place(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.latitude . optional
+    #
+    # @param [Number] payload.longitude . optional
+    #
+    # @param [Number] payload.uncertaintyKm . optional
+    #
+    # `change_place(strSessionID:, payload: {})`
     def self.change_place(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -60,83 +78,110 @@ class MemoriClient::Engine::V2::Dialog < MemoriClient::Engine::Resource
       exec_http_request('post', '/memori/v2/PlaceChangedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/TagChangedEvent/{strSessionID}
+    # `POST /memori/v2/TagChangedEvent/{strSessionID}`
+    #
     # Submits a Tag Changed event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.tag . required
-    # change_tag(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # `change_tag(strSessionID:, payload: {})`
     def self.change_tag(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'tag',
       ]
-      payload_required_keys = %w[tag]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/TagChangedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/TimeoutEvent/{strSessionID}
+    # `POST /memori/v2/TimeoutEvent/{strSessionID}`
+    #
     # Submits a Timeout event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # timeout(strSessionID:)
+    #
+    # `timeout(strSessionID:)`
     def self.timeout(strSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('post', '/memori/v2/TimeoutEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/MediumSelectedEvent/{strSessionID}
+    # `POST /memori/v2/MediumSelectedEvent/{strSessionID}`
+    #
     # Submits a Medium Selected event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [] payload.medium . required
-    # select_medium(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [] payload.medium . optional
+    #
+    # `select_medium(strSessionID:, payload: {})`
     def self.select_medium(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'medium',
       ]
-      payload_required_keys = %w[medium]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/MediumSelectedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/DateSelectedEvent/{strSessionID}
+    # `POST /memori/v2/DateSelectedEvent/{strSessionID}`
+    #
     # Submits a Date Selected event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.date . required
-    # @param [number] payload.uncertaintyDays . optional
-    # select_date(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # @param [Number] payload.uncertaintyDays . optional
+    #
+    # `select_date(strSessionID:, payload: {})`
     def self.select_date(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'date',
         'uncertaintyDays',
       ]
-      payload_required_keys = %w[date]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/DateSelectedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/PlaceSelectedEvent/{strSessionID}
+    # `POST /memori/v2/PlaceSelectedEvent/{strSessionID}`
+    #
     # Submits a Place Selected event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.placeName . optional
-    # @param [number] payload.latitude . optional
-    # @param [number] payload.longitude . optional
-    # @param [number] payload.uncertaintyKm . optional
-    # select_place(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.latitude . optional
+    #
+    # @param [Number] payload.longitude . optional
+    #
+    # @param [Number] payload.uncertaintyKm . optional
+    #
+    # `select_place(strSessionID:, payload: {})`
     def self.select_place(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -151,19 +196,24 @@ class MemoriClient::Engine::V2::Dialog < MemoriClient::Engine::Resource
       exec_http_request('post', '/memori/v2/PlaceSelectedEvent/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/TagSelectedEvent/{strSessionID}
+    # `POST /memori/v2/TagSelectedEvent/{strSessionID}`
+    #
     # Submits a Tag Selected event to the session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.tag . required
-    # select_tag(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # `select_tag(strSessionID:, payload: {})`
     def self.select_tag(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'tag',
       ]
-      payload_required_keys = %w[tag]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/TagSelectedEvent/{strSessionID}', **args)

data/lib/memori_client/engine/v2/event_log.rb

@@ -1,57 +1,98 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::EventLog < MemoriClient::Engine::Resource
-    # GET /memori/v2/EventLogs/{strSessionID}/{strDateFrom}/{strDateTo}
+    # `GET /memori/v2/EventLogs/{strSessionID}/{strDateFrom}/{strDateTo}`
+    #
     # Gets the Event Log objects for the Memori of the current session in a specific date interval.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+    #
     # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # list_memori_event_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)
+    #
+    # `list_memori_event_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
     def self.list_memori_event_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/EventLogs/{strSessionID}/{strDateFrom}/{strDateTo}', **args)
     end
 
-    # GET /memori/v2/MemoryEventLogs/{strSessionID}/{strMemoryID}/{strDateFrom}/{strDateTo}
+    # `GET /memori/v2/MemoryEventLogs/{strSessionID}/{strMemoryID}/{strDateFrom}/{strDateTo}`
+    #
     # Gets the Event Log objects for a specific Memory object in a specific date interval.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strMemoryID The Memory object ID. required
+    #
     # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+    #
     # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # list_memory_event_logs(strSessionID:, strMemoryID:, strDateFrom: nil, strDateTo: nil)
+    #
+    # `list_memory_event_logs(strSessionID:, strMemoryID:, strDateFrom: nil, strDateTo: nil)`
     def self.list_memory_event_logs(strSessionID:, strMemoryID:, strDateFrom: nil, strDateTo: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/MemoryEventLogs/{strSessionID}/{strMemoryID}/{strDateFrom}/{strDateTo}', **args)
     end
 
-    # GET /memori/v2/IntentEventLogs/{strSessionID}/{strIntentID}/{strDateFrom}/{strDateTo}
+    # `GET /memori/v2/IntentEventLogs/{strSessionID}/{strIntentID}/{strDateFrom}/{strDateTo}`
+    #
     # Gets the Event Log objects for a specific Intent object in a specific date interval.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strIntentID The Intent object ID. required
+    #
     # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+    #
     # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # list_intent_event_logs(strSessionID:, strIntentID:, strDateFrom: nil, strDateTo: nil)
+    #
+    # `list_intent_event_logs(strSessionID:, strIntentID:, strDateFrom: nil, strDateTo: nil)`
     def self.list_intent_event_logs(strSessionID:, strIntentID:, strDateFrom: nil, strDateTo: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/IntentEventLogs/{strSessionID}/{strIntentID}/{strDateFrom}/{strDateTo}', **args)
     end
 
-    # GET /memori/v2/SessionEventLogs/{strSessionID}/{strEventLogSessionID}
+    # `GET /memori/v2/SessionEventLogs/{strSessionID}/{strEventLogSessionID}`
+    #
     # Gets the Event Log objects for the Memori of the current session recorded during a specific other session.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strEventLogSessionID The session ID for which Event Log objects are being searched. required
-    # list_session_event_logs(strSessionID:, strEventLogSessionID:)
+    #
+    # `list_session_event_logs(strSessionID:, strEventLogSessionID:)`
     def self.list_session_event_logs(strSessionID:, strEventLogSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/SessionEventLogs/{strSessionID}/{strEventLogSessionID}', **args)
     end
 
+    # `GET /memori/v2/UserEventLogs/{strSessionID}/{strUserID}/{strDateFrom}/{strDateTo}`
+    #
+    # Gets the Event Log objects for the Memori of the current session created by a specific User.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strUserID The user ID for which Event Log objects are being searched. required
+    #
+    # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+    #
+    # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+    #
+    # `list_user_event_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)`
+    def self.list_user_event_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/UserEventLogs/{strSessionID}/{strUserID}/{strDateFrom}/{strDateTo}', **args)
+    end
+
 
 end