arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/AddOrUpdateSquareOnlineSnippet.json

{
  "name": "AddOrUpdateSquareOnlineSnippet",
  "fully_qualified_name": "SquareupApi.AddOrUpdateSquareOnlineSnippet@2.0.0",
  "description": "Add or update a snippet on a Square Online site.\n\nThis tool adds a new snippet to or updates an existing snippet on a Square Online site's `head` element. It excludes checkout pages and requires the site's ID. Use ListSites to find site IDs.",
  "toolkit": {
    "name": "ArcadeSquareupApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "site_id_for_snippet",
        "required": true,
        "description": "The ID of the site where you want to add or update the snippet. Obtained through ListSites function.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the site where you want to add or update the snippet."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "site_id"
      },
      {
        "name": "snippet_code_content",
        "required": true,
        "description": "The code snippet to add or update, which can include valid HTML, JavaScript, or both. This will be appended to the head element of all site pages except checkout pages.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The snippet code, which can contain valid HTML, JavaScript, or both."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "snippet.content"
      },
      {
        "name": "snippet_id",
        "required": false,
        "description": "The Square-assigned ID for the snippet to add or update.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Square-assigned ID for the snippet."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "snippet.id"
      },
      {
        "name": "snippet_site_id",
        "required": false,
        "description": "The ID of the site that contains the snippet to be updated or added.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the site that contains the snippet."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "snippet.site_id"
      },
      {
        "name": "snippet_initial_creation_timestamp",
        "required": false,
        "description": "The timestamp indicating when the snippet was initially added to the site, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp of when the snippet was initially added to the site, in RFC 3339 format."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "snippet.created_at"
      },
      {
        "name": "snippet_last_updated_timestamp",
        "required": false,
        "description": "The timestamp for when the snippet was last updated on the site, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp of when the snippet was last updated on the site, in RFC 3339 format."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "snippet.updated_at"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'UpsertSnippet'.",
    "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": {
      "provider_id": "arcade-squareup",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "ONLINE_STORE_SNIPPETS_WRITE"
        ]
      }
    },
    "secrets": null,
    "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 squareup API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://connect.squareup.com/v2/sites/{site_id}/snippet",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "site_id",
        "tool_parameter_name": "site_id_for_snippet",
        "description": "The ID of the site where you want to add or update the snippet.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the site where you want to add or update the snippet."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "snippet.id",
        "tool_parameter_name": "snippet_id",
        "description": "The Square-assigned ID for the snippet.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Square-assigned ID for the snippet."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "snippet.site_id",
        "tool_parameter_name": "snippet_site_id",
        "description": "The ID of the site that contains the snippet.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the site that contains the snippet."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "snippet.content",
        "tool_parameter_name": "snippet_code_content",
        "description": "The snippet code, which can contain valid HTML, JavaScript, or both.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The snippet code, which can contain valid HTML, JavaScript, or both."
        },
        "accepted_as": "body",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "snippet.created_at",
        "tool_parameter_name": "snippet_initial_creation_timestamp",
        "description": "The timestamp of when the snippet was initially added to the site, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp of when the snippet was initially added to the site, in RFC 3339 format."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "snippet.updated_at",
        "tool_parameter_name": "snippet_last_updated_timestamp",
        "description": "The timestamp of when the snippet was last updated on the site, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp of when the snippet was last updated on the site, in RFC 3339 format."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": "{\n  \"required\": true,\n  \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"description\": \"Represents an `UpsertSnippet` request.\",\n        \"x-release-status\": \"PUBLIC\",\n        \"required\": [\n          \"snippet\"\n        ],\n        \"properties\": {\n          \"snippet\": {\n            \"type\": \"object\",\n            \"description\": \"Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages.\",\n            \"x-release-status\": \"PUBLIC\",\n            \"required\": [\n              \"content\"\n            ],\n            \"properties\": {\n              \"id\": {\n                \"type\": \"string\",\n                \"description\": \"The Square-assigned ID for the snippet.\",\n                \"maxLength\": 48,\n                \"readOnly\": true\n              },\n              \"site_id\": {\n                \"type\": \"string\",\n                \"description\": \"The ID of the site that contains the snippet.\",\n                \"readOnly\": true\n              },\n              \"content\": {\n                \"type\": \"string\",\n                \"description\": \"The snippet code, which can contain valid HTML, JavaScript, or both.\",\n                \"minLength\": 1,\n                \"maxLength\": 65535\n              },\n              \"created_at\": {\n                \"type\": \"string\",\n                \"description\": \"The timestamp of when the snippet was initially added to the site, in RFC 3339 format.\",\n                \"readOnly\": true\n              },\n              \"updated_at\": {\n                \"type\": \"string\",\n                \"description\": \"The timestamp of when the snippet was last updated on the site, in RFC 3339 format.\",\n                \"readOnly\": true\n              }\n            }\n          }\n        },\n        \"example\": {\n          \"snippet\": {\n            \"content\": \"<script>var js = 1;</script>\"\n          }\n        }\n      }\n    }\n  }\n}",
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}