memori-client 0.1.1 → 0.1.2

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

@@ -0,0 +1,220 @@
+# Generated on 2025-01-27 16:56:16 +0000    
+class MemoriClient::Engine::V2::Function < MemoriClient::Engine::Resource
+    # `GET /memori/v2/MacroFunctions/{strSessionID}`
+    #
+    # Lists all Macro Function objects.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # `list_macro_functions(strSessionID:)`
+    def self.list_macro_functions(strSessionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/MacroFunctions/{strSessionID}', **args)
+    end
+
+    # `GET /memori/v2/Functions/{strSessionID}`
+    #
+    # Lists all Function objects.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # `list_functions(strSessionID:)`
+    def self.list_functions(strSessionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Functions/{strSessionID}', **args)
+    end
+
+    # `GET /memori/v2/Functions/{strSessionID}/{from}/{howMany}`
+    #
+    # Lists Function objects with pagination.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [integer] from The 0-based index of the first Function object to list. required
+    #
+    # @param [integer] howMany The number of the Function objects to list. required
+    #
+    # `list_functions_paginated(strSessionID:, from:, howMany:)`
+    def self.list_functions_paginated(strSessionID:, from:, howMany:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Functions/{strSessionID}/{from}/{howMany}', **args)
+    end
+
+    # `GET /memori/v2/Function/{strSessionID}/{strFunctionID}`
+    #
+    # Gets the details of a Function object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strFunctionID The Function object ID. required
+    #
+    # `get_function(strSessionID:, strFunctionID:)`
+    def self.get_function(strSessionID:, strFunctionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Function/{strSessionID}/{strFunctionID}', **args)
+    end
+
+    # `PATCH /memori/v2/Function/{strSessionID}/{strFunctionID}`
+    #
+    # Updates an existing Function object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strFunctionID The Function object ID. required
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.functionID . optional
+    #
+    # @param [String] payload.functionType . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [String] payload.description . optional
+    #
+    # @param [Array] payload.parameters . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [String] payload.httpMethod . optional
+    #
+    # @param [Object] payload.httpHeaders . optional
+    #
+    # @param [String] payload.httpQueryStringTemplate . optional
+    #
+    # @param [String] payload.httpBodyTemplate . optional
+    #
+    # @param [String] payload.httpBodyContentType . optional
+    #
+    # @param [Array] payload.sendExtensionHeaders . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `update_function(strSessionID:, strFunctionID:, payload: {})`
+    def self.update_function(strSessionID:, strFunctionID:, payload: {})
+      args = build_arguments(binding)
+      payload_keys = [
+        'creationSessionID',
+        'creationTimestamp',
+        'description',
+        'functionID',
+        'functionType',
+        'httpBodyContentType',
+        'httpBodyTemplate',
+        'httpHeaders',
+        'httpMethod',
+        'httpQueryStringTemplate',
+        'lastChangeSessionID',
+        'lastChangeTimestamp',
+        'name',
+        'parameters',
+        'sendExtensionHeaders',
+        'webHook',
+      ]
+      payload_required_keys = %w[]
+      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
+
+      exec_http_request('patch', '/memori/v2/Function/{strSessionID}/{strFunctionID}', **args)
+    end
+
+    # `DELETE /memori/v2/Function/{strSessionID}/{strFunctionID}`
+    #
+    # Removes an existing Function object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strFunctionID The Function object ID. required
+    #
+    # `remove_function(strSessionID:, strFunctionID:)`
+    def self.remove_function(strSessionID:, strFunctionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('delete', '/memori/v2/Function/{strSessionID}/{strFunctionID}', **args)
+    end
+
+    # `POST /memori/v2/Function/{strSessionID}`
+    #
+    # Adds a new Function object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.functionID . optional
+    #
+    # @param [String] payload.functionType . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [String] payload.description . optional
+    #
+    # @param [Array] payload.parameters . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [String] payload.httpMethod . optional
+    #
+    # @param [Object] payload.httpHeaders . optional
+    #
+    # @param [String] payload.httpQueryStringTemplate . optional
+    #
+    # @param [String] payload.httpBodyTemplate . optional
+    #
+    # @param [String] payload.httpBodyContentType . optional
+    #
+    # @param [Array] payload.sendExtensionHeaders . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `add_function(strSessionID:, payload: {})`
+    def self.add_function(strSessionID:, payload: {})
+      args = build_arguments(binding)
+      payload_keys = [
+        'creationSessionID',
+        'creationTimestamp',
+        'description',
+        'functionID',
+        'functionType',
+        'httpBodyContentType',
+        'httpBodyTemplate',
+        'httpHeaders',
+        'httpMethod',
+        'httpQueryStringTemplate',
+        'lastChangeSessionID',
+        'lastChangeTimestamp',
+        'name',
+        'parameters',
+        'sendExtensionHeaders',
+        'webHook',
+      ]
+      payload_required_keys = %w[]
+      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
+
+      exec_http_request('post', '/memori/v2/Function/{strSessionID}', **args)
+    end
+
+
+end

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

@@ -1,59 +1,87 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 16:56:16 +0000    
 class MemoriClient::Engine::V2::Intent < MemoriClient::Engine::Resource
-    # GET /memori/v2/Intents/{strSessionID}
+    # `GET /memori/v2/Intents/{strSessionID}`
+    #
     # Lists all Intent objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # list_intents(strSessionID:)
+    #
+    # `list_intents(strSessionID:)`
     def self.list_intents(strSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/Intents/{strSessionID}', **args)
     end
 
-    # GET /memori/v2/Intents/{strSessionID}/{from}/{howMany}
+    # `GET /memori/v2/Intents/{strSessionID}/{from}/{howMany}`
+    #
     # Lists Intent objects with pagination.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [integer] from The 0-based index of the first Intent object to list. required
+    #
     # @param [integer] howMany The number of the Intent objects to list. required
-    # list_intents_paginated(strSessionID:, from:, howMany:)
+    #
+    # `list_intents_paginated(strSessionID:, from:, howMany:)`
     def self.list_intents_paginated(strSessionID:, from:, howMany:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/Intents/{strSessionID}/{from}/{howMany}', **args)
     end
 
-    # GET /memori/v2/Intent/{strSessionID}/{strIntentID}
+    # `GET /memori/v2/Intent/{strSessionID}/{strIntentID}`
+    #
     # Gets the details of an Intent object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strIntentID The Intent object ID. required
-    # get_intent(strSessionID:, strIntentID:)
+    #
+    # `get_intent(strSessionID:, strIntentID:)`
     def self.get_intent(strSessionID:, strIntentID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/Intent/{strSessionID}/{strIntentID}', **args)
     end
 
-    # PATCH /memori/v2/Intent/{strSessionID}/{strIntentID}
+    # `PATCH /memori/v2/Intent/{strSessionID}/{strIntentID}`
+    #
     # Updates an existing Intent object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strIntentID The Intent object ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.intentID . optional
-    # @param [string] payload.intentType . required
-    # @param [string] payload.name . required
-    # @param [array] payload.utterances . required
-    # @param [boolean] payload.timeoutIntent . optional
-    # @param [string] payload.webHook . optional
-    # @param [number] payload.validityMinutes . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # update_intent(strSessionID:, strIntentID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.intentID . optional
+    #
+    # @param [String] payload.intentType . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [Array] payload.utterances . optional
+    #
+    # @param [Boolean] payload.timeoutIntent . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [Number] payload.validityMinutes . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `update_intent(strSessionID:, strIntentID:, payload: {})`
     def self.update_intent(strSessionID:, strIntentID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -69,41 +97,60 @@ class MemoriClient::Engine::V2::Intent < MemoriClient::Engine::Resource
         'validityMinutes',
         'webHook',
       ]
-      payload_required_keys = %w[intentType name utterances]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('patch', '/memori/v2/Intent/{strSessionID}/{strIntentID}', **args)
     end
 
-    # DELETE /memori/v2/Intent/{strSessionID}/{strIntentID}
+    # `DELETE /memori/v2/Intent/{strSessionID}/{strIntentID}`
+    #
     # Removes an existing Intent object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strIntentID The Intent object ID. required
-    # remove_intent(strSessionID:, strIntentID:)
+    #
+    # `remove_intent(strSessionID:, strIntentID:)`
     def self.remove_intent(strSessionID:, strIntentID:)
       args = build_arguments(binding)
 
       exec_http_request('delete', '/memori/v2/Intent/{strSessionID}/{strIntentID}', **args)
     end
 
-    # POST /memori/v2/Intent/{strSessionID}
+    # `POST /memori/v2/Intent/{strSessionID}`
+    #
     # Adds a new Intent object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.intentID . optional
-    # @param [string] payload.intentType . required
-    # @param [string] payload.name . required
-    # @param [array] payload.utterances . required
-    # @param [boolean] payload.timeoutIntent . optional
-    # @param [string] payload.webHook . optional
-    # @param [number] payload.validityMinutes . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # add_intent(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.intentID . optional
+    #
+    # @param [String] payload.intentType . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [Array] payload.utterances . optional
+    #
+    # @param [Boolean] payload.timeoutIntent . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [Number] payload.validityMinutes . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `add_intent(strSessionID:, payload: {})`
     def self.add_intent(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -119,64 +166,90 @@ class MemoriClient::Engine::V2::Intent < MemoriClient::Engine::Resource
         'validityMinutes',
         'webHook',
       ]
-      payload_required_keys = %w[intentType name utterances]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/Intent/{strSessionID}', **args)
     end
 
-    # GET /memori/v2/IntentSlots/{strSessionID}
+    # `GET /memori/v2/IntentSlots/{strSessionID}`
+    #
     # Lists all Intent Slot objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # list_intent_slots(strSessionID:)
+    #
+    # `list_intent_slots(strSessionID:)`
     def self.list_intent_slots(strSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/IntentSlots/{strSessionID}', **args)
     end
 
-    # GET /memori/v2/IntentSlots/{strSessionID}/{from}/{howMany}
+    # `GET /memori/v2/IntentSlots/{strSessionID}/{from}/{howMany}`
+    #
     # Lists Intent Slot objects with pagination.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [integer] from The 0-based index of the first Intent Slot object to list. required
+    #
     # @param [integer] howMany The number of the Intent Slot objects to list. required
-    # list_intent_slots_paginated(strSessionID:, from:, howMany:)
+    #
+    # `list_intent_slots_paginated(strSessionID:, from:, howMany:)`
     def self.list_intent_slots_paginated(strSessionID:, from:, howMany:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/IntentSlots/{strSessionID}/{from}/{howMany}', **args)
     end
 
-    # GET /memori/v2/IntentSlot/{strSessionID}/{strSlotID}
+    # `GET /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
+    #
     # Gets the details of an Intent Slot object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strSlotID The Intent Slot object ID. required
-    # get_intent_slot(strSessionID:, strSlotID:)
+    #
+    # `get_intent_slot(strSessionID:, strSlotID:)`
     def self.get_intent_slot(strSessionID:, strSlotID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/IntentSlot/{strSessionID}/{strSlotID}', **args)
     end
 
-    # PATCH /memori/v2/IntentSlot/{strSessionID}/{strSlotID}
+    # `PATCH /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
+    #
     # Updates an existing Intent Slot object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strSlotID The Intent Slot object ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.intentSlotID . optional
-    # @param [string] payload.name . required
-    # @param [array] payload.values . optional
-    # @param [string] payload.webHook . optional
-    # @param [number] payload.validityMinutes . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # update_intent_slot(strSessionID:, strSlotID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.intentSlotID . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [Array] payload.values . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [Number] payload.validityMinutes . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `update_intent_slot(strSessionID:, strSlotID:, payload: {})`
     def self.update_intent_slot(strSessionID:, strSlotID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -190,39 +263,56 @@ class MemoriClient::Engine::V2::Intent < MemoriClient::Engine::Resource
         'values',
         'webHook',
       ]
-      payload_required_keys = %w[name]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('patch', '/memori/v2/IntentSlot/{strSessionID}/{strSlotID}', **args)
     end
 
-    # DELETE /memori/v2/IntentSlot/{strSessionID}/{strSlotID}
+    # `DELETE /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
+    #
     # Removes an existing Intent Slot object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strSlotID The Intent Slot object ID. required
-    # remove_intent_slot(strSessionID:, strSlotID:)
+    #
+    # `remove_intent_slot(strSessionID:, strSlotID:)`
     def self.remove_intent_slot(strSessionID:, strSlotID:)
       args = build_arguments(binding)
 
       exec_http_request('delete', '/memori/v2/IntentSlot/{strSessionID}/{strSlotID}', **args)
     end
 
-    # POST /memori/v2/IntentSlot/{strSessionID}
+    # `POST /memori/v2/IntentSlot/{strSessionID}`
+    #
     # Adds a new Intent Slot object.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.intentSlotID . optional
-    # @param [string] payload.name . required
-    # @param [array] payload.values . optional
-    # @param [string] payload.webHook . optional
-    # @param [number] payload.validityMinutes . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.creationSessionID . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # @param [string] payload.lastChangeSessionID . optional
-    # add_intent_slot(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.intentSlotID . optional
+    #
+    # @param [String] payload.name . optional
+    #
+    # @param [Array] payload.values . optional
+    #
+    # @param [String] payload.webHook . optional
+    #
+    # @param [Number] payload.validityMinutes . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.creationSessionID . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # @param [String] payload.lastChangeSessionID . optional
+    #
+    # `add_intent_slot(strSessionID:, payload: {})`
     def self.add_intent_slot(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -236,7 +326,7 @@ class MemoriClient::Engine::V2::Intent < MemoriClient::Engine::Resource
         'values',
         'webHook',
       ]
-      payload_required_keys = %w[name]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/IntentSlot/{strSessionID}', **args)