313 lines
10 KiB
JSON
313 lines
10 KiB
JSON
{
|
|
"name": "UpdateCannedResponseFolder",
|
|
"fully_qualified_name": "FreshserviceApi.UpdateCannedResponseFolder@1.0.0",
|
|
"description": "Update an existing Canned Response Folder in Freshservice.\n\nUse this tool to modify details of a specific canned response folder in Freshservice by providing the folder ID and required updates.",
|
|
"toolkit": {
|
|
"name": "ArcadeFreshserviceApi",
|
|
"description": null,
|
|
"version": "1.0.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "canned_response_folder_id",
|
|
"required": true,
|
|
"description": "The ID of the canned response folder to update in Freshservice. This is required to identify which folder needs modification.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ID of canned response Folder to update"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "canned_response_folder_id"
|
|
},
|
|
{
|
|
"name": "new_folder_id",
|
|
"required": false,
|
|
"description": "The new ID to assign to the canned response folder. This should be an integer.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "id"
|
|
},
|
|
{
|
|
"name": "folder_name",
|
|
"required": false,
|
|
"description": "The new name for the canned response folder. This will replace the current name.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "name"
|
|
},
|
|
{
|
|
"name": "folder_type",
|
|
"required": false,
|
|
"description": "Specify the type of the canned response folder. This may relate to its category or purpose.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "type"
|
|
},
|
|
{
|
|
"name": "folder_responses_count",
|
|
"required": false,
|
|
"description": "Specifies the number of responses in the canned response folder to update.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "responses_count"
|
|
},
|
|
{
|
|
"name": "folder_creation_date",
|
|
"required": false,
|
|
"description": "The date and time the canned response folder was originally created. Expected format is ISO 8601 (e.g., '2023-10-12T10:20:30Z').",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "created_at"
|
|
},
|
|
{
|
|
"name": "last_updated_timestamp",
|
|
"required": false,
|
|
"description": "The timestamp of when the folder was last updated. Expected in ISO 8601 format.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "updated_at"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'update-canned-response-folder'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "FRESHSERVICE_SUBDOMAIN"
|
|
},
|
|
{
|
|
"key": "FRESHSERVICE_API_KEY"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Freshservice API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://{freshservice_subdomain}.freshservice.com/api/v2/canned_response_folder/{canned_response_folder_id}",
|
|
"http_method": "PUT",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "canned_response_folder_id",
|
|
"tool_parameter_name": "canned_response_folder_id",
|
|
"description": "ID of canned response Folder to update",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ID of canned response Folder to update"
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"tool_parameter_name": "new_folder_id",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "name",
|
|
"tool_parameter_name": "folder_name",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "type",
|
|
"tool_parameter_name": "folder_type",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "responses_count",
|
|
"tool_parameter_name": "folder_responses_count",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"tool_parameter_name": "folder_creation_date",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"tool_parameter_name": "last_updated_timestamp",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "FRESHSERVICE_SUBDOMAIN",
|
|
"parameter_name": "freshservice_subdomain",
|
|
"accepted_as": "path",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "FRESHSERVICE_API_KEY",
|
|
"parameter_name": "username",
|
|
"accepted_as": "basic_auth_username",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"description\": \"Canned Response details that needs to be updated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"readOnly\": true,\n \"example\": 10\n },\n \"name\": {\n \"type\": \"string\",\n \"example\": \"Auto Response\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"General\"\n },\n \"responses_count\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"readOnly\": true,\n \"example\": 10\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-08-12T10:10:20Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-08-12T10:10:20Z\"\n }\n }\n }\n }\n },\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|