[MOAR][SquareUP] Adding square up toolkit (#596)
Adding square up toolkit --------- Co-authored-by: Francisco Liberal <francisco@arcade.dev>
This commit is contained in:
jottakka
GitHub
parent
103732cc2e
commit
b89ba3372c
154 changed files with 25668 additions and 0 deletions
|
|
@ -1,4 +1,5 @@
|
|||
arcade-box-api
|
||||
arcade-slack-api
|
||||
arcade-stripe-api
|
||||
arcade-squareup-api
|
||||
arcade-xero-api
|
||||
|
|
|
|||
18
toolkits/squareup_api/.pre-commit-config.yaml
Normal file
18
toolkits/squareup_api/.pre-commit-config.yaml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
files: ^.*/squareup_api/.*
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: "v4.4.0"
|
||||
hooks:
|
||||
- id: check-case-conflict
|
||||
- id: check-merge-conflict
|
||||
- id: check-toml
|
||||
- id: check-yaml
|
||||
- id: end-of-file-fixer
|
||||
- id: trailing-whitespace
|
||||
|
||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||
rev: v0.6.7
|
||||
hooks:
|
||||
- id: ruff
|
||||
args: [--fix]
|
||||
- id: ruff-format
|
||||
44
toolkits/squareup_api/.ruff.toml
Normal file
44
toolkits/squareup_api/.ruff.toml
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
target-version = "py310"
|
||||
line-length = 100
|
||||
fix = true
|
||||
|
||||
[lint]
|
||||
select = [
|
||||
# flake8-2020
|
||||
"YTT",
|
||||
# flake8-bandit
|
||||
"S",
|
||||
# flake8-bugbear
|
||||
"B",
|
||||
# flake8-builtins
|
||||
"A",
|
||||
# flake8-comprehensions
|
||||
"C4",
|
||||
# flake8-debugger
|
||||
"T10",
|
||||
# flake8-simplify
|
||||
"SIM",
|
||||
# isort
|
||||
"I",
|
||||
# mccabe
|
||||
"C90",
|
||||
# pycodestyle
|
||||
"E", "W",
|
||||
# pyflakes
|
||||
"F",
|
||||
# pygrep-hooks
|
||||
"PGH",
|
||||
# pyupgrade
|
||||
"UP",
|
||||
# ruff
|
||||
"RUF",
|
||||
# tryceratops
|
||||
"TRY",
|
||||
]
|
||||
|
||||
[lint.per-file-ignores]
|
||||
"**/tests/*" = ["S101"]
|
||||
|
||||
[format]
|
||||
preview = true
|
||||
skip-magic-trailing-comma = false
|
||||
21
toolkits/squareup_api/LICENSE
Normal file
21
toolkits/squareup_api/LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2025, Arcade AI
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
54
toolkits/squareup_api/Makefile
Normal file
54
toolkits/squareup_api/Makefile
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
.PHONY: help
|
||||
|
||||
help:
|
||||
@echo "🛠️ github Commands:\n"
|
||||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
||||
|
||||
.PHONY: install
|
||||
install: ## Install the uv environment and install all packages with dependencies
|
||||
@echo "🚀 Creating virtual environment and installing all packages using uv"
|
||||
@uv sync --active --all-extras --no-sources
|
||||
@if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi
|
||||
@echo "✅ All packages and dependencies installed via uv"
|
||||
|
||||
.PHONY: install-local
|
||||
install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources
|
||||
@echo "🚀 Creating virtual environment and installing all packages using uv"
|
||||
@uv sync --active --all-extras
|
||||
@if [ -f .pre-commit-config.yaml ]; then uv run pre-commit install; fi
|
||||
@echo "✅ All packages and dependencies installed via uv"
|
||||
.PHONY: build
|
||||
build: clean-build ## Build wheel file using poetry
|
||||
@echo "🚀 Creating wheel file"
|
||||
uv build
|
||||
|
||||
.PHONY: clean-build
|
||||
clean-build: ## clean build artifacts
|
||||
@echo "🗑️ Cleaning dist directory"
|
||||
rm -rf dist
|
||||
|
||||
.PHONY: test
|
||||
test: ## Test the code with pytest
|
||||
@echo "🚀 Testing code: Running pytest"
|
||||
@uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml
|
||||
|
||||
.PHONY: coverage
|
||||
coverage: ## Generate coverage report
|
||||
@echo "coverage report"
|
||||
@uv run --no-sources coverage report
|
||||
@echo "Generating coverage report"
|
||||
@uv run --no-sources coverage html
|
||||
|
||||
.PHONY: bump-version
|
||||
bump-version: ## Bump the version in the pyproject.toml file by a patch version
|
||||
@echo "🚀 Bumping version in pyproject.toml"
|
||||
uv version --no-sources --bump patch
|
||||
|
||||
.PHONY: check
|
||||
check: ## Run code quality tools.
|
||||
@if [ -f .pre-commit-config.yaml ]; then\
|
||||
echo "🚀 Linting code: Running pre-commit";\
|
||||
uv run --no-sources pre-commit run -a;\
|
||||
fi
|
||||
@echo "🚀 Static type checking: Running mypy"
|
||||
@uv run --no-sources mypy --config-file=pyproject.toml
|
||||
0
toolkits/squareup_api/arcade_squareup_api/__init__.py
Normal file
0
toolkits/squareup_api/arcade_squareup_api/__init__.py
Normal file
5013
toolkits/squareup_api/arcade_squareup_api/tools/__init__.py
Normal file
5013
toolkits/squareup_api/arcade_squareup_api/tools/__init__.py
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "AcceptDispute",
|
||||
"fully_qualified_name": "SquareupApi.AcceptDispute@0.1.0",
|
||||
"description": "Accepts the loss on a dispute, updating the state to ACCEPTED.\n\nThis tool accepts the loss on a dispute by updating its state to ACCEPTED. Square processes the disputed amount, returning it to the cardholder and debiting the seller's Square account or associated bank account if funds are insufficient.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the dispute that needs to be accepted. This must match the ID given by Square for the specific dispute.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute you want to accept."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "dispute_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'AcceptDispute'.",
|
||||
"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": [
|
||||
"DISPUTES_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/disputes/{dispute_id}/accept",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"tool_parameter_name": "dispute_id",
|
||||
"description": "The ID of the dispute you want to accept.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute you want to accept."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "AddGroupToCustomer",
|
||||
"fully_qualified_name": "SquareupApi.AddGroupToCustomer@0.1.0",
|
||||
"description": "Add a customer to a specific group.\n\nUse this tool to assign a specified customer to a particular group by providing the customer's ID and the group's ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the customer to be added to a group. It must match an existing customer ID.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to add to a group."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
},
|
||||
{
|
||||
"name": "customer_group_id",
|
||||
"required": true,
|
||||
"description": "The ID of the customer group to which the customer will be added. This should be a valid group ID.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer group to add the customer to."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "group_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'AddGroupToCustomer'.",
|
||||
"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": [
|
||||
"CUSTOMERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/{customer_id}/groups/{group_id}",
|
||||
"http_method": "PUT",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_id",
|
||||
"description": "The ID of the customer to add to a group.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to add to a group."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "group_id",
|
||||
"tool_parameter_name": "customer_group_id",
|
||||
"description": "The ID of the customer group to add the customer to.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer group to add the customer to."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "CancelApprovedPayment",
|
||||
"fully_qualified_name": "SquareupApi.CancelApprovedPayment@0.1.0",
|
||||
"description": "Cancel an approved payment transaction.\n\nUse this tool to void a payment that has an APPROVED status. This can be useful when a transaction needs to be reversed before completion.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_identifier",
|
||||
"required": true,
|
||||
"description": "The unique ID of the payment to cancel. This ID must correspond to a payment with an APPROVED status.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payment to cancel."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "payment_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelPayment'.",
|
||||
"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": [
|
||||
"PAYMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payments/{payment_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_id",
|
||||
"tool_parameter_name": "payment_identifier",
|
||||
"description": "The ID of the payment to cancel.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payment to cancel."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "CancelLoyaltyPromotion",
|
||||
"fully_qualified_name": "SquareupApi.CancelLoyaltyPromotion@0.1.0",
|
||||
"description": "Cancel an active or scheduled loyalty promotion early.\n\nUse this tool to set a loyalty promotion to the 'CANCELED' state. It is useful for canceling active promotions earlier than planned or canceling scheduled promotions before they begin. This is also applicable if you need to cancel one prior to creating a new promotion.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "loyalty_promotion_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier of the loyalty promotion to be canceled. Applicable for promotions with an 'ACTIVE' or 'SCHEDULED' status.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "promotion_id"
|
||||
},
|
||||
{
|
||||
"name": "loyalty_program_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the base loyalty program to be canceled.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "program_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelLoyaltyPromotion'.",
|
||||
"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": [
|
||||
"LOYALTY_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "promotion_id",
|
||||
"tool_parameter_name": "loyalty_promotion_id",
|
||||
"description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "program_id",
|
||||
"tool_parameter_name": "loyalty_program_id",
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "CancelSubscription",
|
||||
"fully_qualified_name": "SquareupApi.CancelSubscription@0.1.0",
|
||||
"description": "Schedule cancellation of an active subscription.\n\nUse this tool to schedule a cancellation for an active subscription. The subscription will remain active until the end of the current billing period, after which it will be marked as canceled.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_identifier",
|
||||
"required": true,
|
||||
"description": "The unique identifier of the subscription to be canceled. Required to schedule the cancellation.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription to cancel."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "subscription_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelSubscription'.",
|
||||
"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": [
|
||||
"SUBSCRIPTIONS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/subscriptions/{subscription_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"tool_parameter_name": "subscription_identifier",
|
||||
"description": "The ID of the subscription to cancel.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription to cancel."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "CancelTerminalAction",
|
||||
"fully_qualified_name": "SquareupApi.CancelTerminalAction@0.1.0",
|
||||
"description": "Cancel a terminal action request if permitted.\n\nUse this tool to cancel a terminal action request when the status allows for cancellation.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_action_id",
|
||||
"required": true,
|
||||
"description": "Unique ID for the TerminalAction you want to cancel.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired `TerminalAction`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "action_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelTerminalAction'.",
|
||||
"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": [
|
||||
"PAYMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/actions/{action_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "action_id",
|
||||
"tool_parameter_name": "terminal_action_id",
|
||||
"description": "Unique ID for the desired `TerminalAction`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired `TerminalAction`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "CancelTerminalCheckout",
|
||||
"fully_qualified_name": "SquareupApi.CancelTerminalCheckout@0.1.0",
|
||||
"description": "Cancel a Terminal checkout request if feasible.\n\nThis tool cancels a Terminal checkout request, if its current status allows cancellation. It should be called when a checkout process needs to be aborted.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_checkout_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the TerminalCheckout to be canceled.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalCheckout`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "checkout_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelTerminalCheckout'.",
|
||||
"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": [
|
||||
"PAYMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/checkouts/{checkout_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "checkout_id",
|
||||
"tool_parameter_name": "terminal_checkout_id",
|
||||
"description": "The unique ID for the desired `TerminalCheckout`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalCheckout`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "CancelTerminalRefund",
|
||||
"fully_qualified_name": "SquareupApi.CancelTerminalRefund@0.1.0",
|
||||
"description": "Cancel a terminal refund request if allowed.\n\nThis tool cancels a terminal refund request using the refund request ID, if the current status permits cancellation.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_id",
|
||||
"required": true,
|
||||
"description": "The unique ID for the desired TerminalRefund to cancel.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalRefund`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "terminal_refund_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'CancelTerminalRefund'.",
|
||||
"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": [
|
||||
"PAYMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/refunds/{terminal_refund_id}/cancel",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_id",
|
||||
"tool_parameter_name": "terminal_refund_id",
|
||||
"description": "The unique ID for the desired `TerminalRefund`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalRefund`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "DeleteBookingCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.DeleteBookingCustomAttribute@0.1.0",
|
||||
"description": "Deletes a custom attribute from a booking.\n\nUse this tool to remove a custom attribute from a specific booking. Appropriate OAuth permissions are required: 'APPOINTMENTS_WRITE' for buyer-level and 'APPOINTMENTS_ALL_WRITE' with 'APPOINTMENTS_WRITE' for seller-level. Seller must be subscribed to Appointments Plus or Premium.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "booking_id",
|
||||
"required": true,
|
||||
"description": "The ID of the target booking from which the custom attribute will be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "booking_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute to delete. It must match the key of a custom attribute definition in the Square seller account. Use the qualified key if not the definition owner.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteBookingCustomAttribute'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/{booking_id}/custom-attributes/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "booking_id",
|
||||
"tool_parameter_name": "booking_id",
|
||||
"description": "The ID of the target [booking](entity:Booking).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteBookingCustomAttributeDefinition",
|
||||
"fully_qualified_name": "SquareupApi.DeleteBookingCustomAttributeDefinition@0.1.0",
|
||||
"description": "Deletes a bookings custom attribute definition.\n\nUse to delete a custom attribute definition for bookings. Requires specific OAuth scopes depending on permission level: `APPOINTMENTS_WRITE` for buyer-level or both `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for seller-level. Seller-level calls require an Appointments Plus or Premium subscription.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_definition_key",
|
||||
"required": true,
|
||||
"description": "The unique key of the custom attribute definition to be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteBookingCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_definition_key",
|
||||
"description": "The key of the custom attribute definition to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteBreakType",
|
||||
"fully_qualified_name": "SquareupApi.DeleteBreakType@0.1.0",
|
||||
"description": "Deletes an existing break type.\n\nUse this tool to delete a specific break type, even if it is referenced by a shift.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "break_type_uuid",
|
||||
"required": true,
|
||||
"description": "The UUID of the BreakType to delete. Ensure it is a valid UUID format.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `BreakType` being deleted."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteBreakType'.",
|
||||
"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": [
|
||||
"TIMECARDS_SETTINGS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/labor/break-types/{id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "break_type_uuid",
|
||||
"description": "The UUID for the `BreakType` being deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `BreakType` being deleted."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteCatalogObject",
|
||||
"fully_qualified_name": "SquareupApi.DeleteCatalogObject@0.1.0",
|
||||
"description": "Deletes a catalog object and its children by ID.\n\nThis tool deletes a catalog object by its ID, including all its child objects, ensuring that only one delete request is processed at a time per seller account. It should be called when you want to permanently remove a catalog item and its variations.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "catalog_object_id",
|
||||
"required": true,
|
||||
"description": "The ID of the catalog object, including its child objects, to be deleted. This is a cascading deletion.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "object_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteCatalogObject'.",
|
||||
"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": [
|
||||
"ITEMS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/catalog/object/{object_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "object_id",
|
||||
"tool_parameter_name": "catalog_object_id",
|
||||
"description": "The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "DeleteCustomerCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.DeleteCustomerCustomAttribute@0.1.0",
|
||||
"description": "Delete a custom attribute from a customer profile.\n\nDeletes a custom attribute from a customer profile, ensuring the visibility setting is `VISIBILITY_READ_WRITE_VALUES` for attributes owned by other applications.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_profile_id",
|
||||
"required": true,
|
||||
"description": "The ID of the target customer profile for which the custom attribute will be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [customer profile](entity:Customer)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key identifying the custom attribute to delete, matching the definition in the Square account. Use the qualified key if the application isn't the definition owner.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteCustomerCustomAttribute'.",
|
||||
"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": [
|
||||
"CUSTOMERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/{customer_id}/custom-attributes/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_profile_id",
|
||||
"description": "The ID of the target [customer profile](entity:Customer).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [customer profile](entity:Customer)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteCustomerCustomAttributeDefinition",
|
||||
"fully_qualified_name": "SquareupApi.DeleteCustomerCustomAttributeDefinition@0.1.0",
|
||||
"description": "Delete a customer custom attribute definition for a seller account.\n\nThis tool deletes a customer-related custom attribute definition from a Square seller's account. It will also remove the related custom attribute from all customer profiles in the seller's Customer Directory. Only the definition owner can perform this action.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The unique key of the custom attribute definition you wish to delete from the seller account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteCustomerCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"CUSTOMERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute definition to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteCustomerGroup",
|
||||
"fully_qualified_name": "SquareupApi.DeleteCustomerGroup@0.1.0",
|
||||
"description": "Deletes a specified customer group by ID.\n\n",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_group_id",
|
||||
"required": true,
|
||||
"description": "The ID of the customer group to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer group to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "group_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteCustomerGroup'.",
|
||||
"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": [
|
||||
"CUSTOMERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/groups/{group_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "group_id",
|
||||
"tool_parameter_name": "customer_group_id",
|
||||
"description": "The ID of the customer group to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer group to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "DeleteCustomerProfile",
|
||||
"fully_qualified_name": "SquareupApi.DeleteCustomerProfile@0.1.0",
|
||||
"description": "Deletes a customer profile from a business.\n\nUse this tool to delete a customer profile, especially if created by merging existing profiles. The unique customer ID is required for deletion.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_identifier",
|
||||
"required": true,
|
||||
"description": "The unique identifier of the customer to be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
},
|
||||
{
|
||||
"name": "customer_profile_version",
|
||||
"required": false,
|
||||
"description": "The current version of the customer profile. Used for optimistic concurrency control.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteCustomer'.",
|
||||
"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": [
|
||||
"CUSTOMERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/{customer_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "customer_profile_version",
|
||||
"description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_identifier",
|
||||
"description": "The ID of the customer to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,138 @@
|
|||
{
|
||||
"name": "DeleteDraftInvoice",
|
||||
"fully_qualified_name": "SquareupApi.DeleteDraftInvoice@0.1.0",
|
||||
"description": "Deletes a specified draft invoice.\n\nUse this tool to delete a draft invoice. Once deleted, the associated order status changes to CANCELED. This tool cannot delete published invoices.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "invoice_id_to_delete",
|
||||
"required": true,
|
||||
"description": "The ID of the draft invoice to be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the invoice to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "invoice_id"
|
||||
},
|
||||
{
|
||||
"name": "invoice_version_to_delete",
|
||||
"required": false,
|
||||
"description": "The version number of the draft invoice to delete. Retrieve this using GetInvoice or ListInvoices if unknown.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteInvoice'.",
|
||||
"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": [
|
||||
"ORDERS_WRITE",
|
||||
"INVOICES_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/invoices/{invoice_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "invoice_version_to_delete",
|
||||
"description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "invoice_id",
|
||||
"tool_parameter_name": "invoice_id_to_delete",
|
||||
"description": "The ID of the invoice to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the invoice to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteLocationCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.DeleteLocationCustomAttribute@0.1.0",
|
||||
"description": "Delete a location-related custom attribute definition.\n\nUse this tool to delete a specific location-related custom attribute definition from a Square seller account. Only the definition owner can perform this action. Deleting also removes the attribute from all locations.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The unique key identifying the custom attribute definition to be deleted from the seller account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteLocationCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute definition to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteLoyaltyReward",
|
||||
"fully_qualified_name": "SquareupApi.DeleteLoyaltyReward@0.1.0",
|
||||
"description": "Delete a loyalty reward and restore loyalty points.\n\nUse this tool to delete a loyalty reward, which restores loyalty points to the account. It also updates the associated order by removing the reward and related discounts if an order ID was specified. The reward cannot be deleted if it has been redeemed.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "reward_id",
|
||||
"required": true,
|
||||
"description": "The ID of the loyalty reward to delete. This is required to identify which reward to remove and restore points for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the [loyalty reward](entity:LoyaltyReward) to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "reward_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteLoyaltyReward'.",
|
||||
"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": [
|
||||
"LOYALTY_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/loyalty/rewards/{reward_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "reward_id",
|
||||
"tool_parameter_name": "reward_id",
|
||||
"description": "The ID of the [loyalty reward](entity:LoyaltyReward) to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the [loyalty reward](entity:LoyaltyReward) to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteMerchantCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.DeleteMerchantCustomAttribute@0.1.0",
|
||||
"description": "Delete a custom attribute definition from a merchant account.\n\nUse this tool to delete a merchant-related custom attribute definition from a Square seller account. This action also removes the corresponding custom attribute from the merchant. Note that only the definition owner can perform this deletion.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "attribute_key_to_delete",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute definition to delete from the merchant account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteMerchantCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "attribute_key_to_delete",
|
||||
"description": "The key of the custom attribute definition to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "DeleteOrderCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.DeleteOrderCustomAttribute@0.1.0",
|
||||
"description": "Delete a custom attribute from an order.\n\nUse this tool to delete a specific custom attribute associated with an order. This is necessary when a custom attribute has the 'VISIBILITY_READ_WRITE_VALUES' setting or is defined by the seller.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "order_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the target order from which the custom attribute will be deleted. This ID is crucial for locating the correct order.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [order](entity:Order)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "order_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "Specifies the key of the custom attribute to be deleted. It must match an existing custom attribute definition's key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the key of an\nexisting custom attribute definition."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "custom_attribute_key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteOrderCustomAttribute'.",
|
||||
"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": [
|
||||
"ORDERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "order_id",
|
||||
"tool_parameter_name": "order_id",
|
||||
"description": "The ID of the target [order](entity:Order).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [order](entity:Order)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to delete. This key must match the key of an\nexisting custom attribute definition.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to delete. This key must match the key of an\nexisting custom attribute definition."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteOrderCustomAttributeDefinition",
|
||||
"fully_qualified_name": "SquareupApi.DeleteOrderCustomAttributeDefinition@0.1.0",
|
||||
"description": "Delete an order-related custom attribute definition.\n\nDeletes a custom attribute definition related to an order from a Square seller account. Only the owner of the definition can perform this action.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key identifying the custom attribute definition to be deleted from the seller's account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteOrderCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"ORDERS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions/{key}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute definition to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
{
|
||||
"name": "DeletePaymentLink",
|
||||
"fully_qualified_name": "SquareupApi.DeletePaymentLink@0.1.0",
|
||||
"description": "Deletes a specified payment link.\n\nUse this tool to delete a payment link by providing the link's ID. Call it when you need to remove a payment link from your system.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_link_id",
|
||||
"required": true,
|
||||
"description": "The ID of the payment link you want to delete. Provide the specific link ID to proceed with deletion.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payment link to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeletePaymentLink'.",
|
||||
"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": [
|
||||
"ORDERS_WRITE",
|
||||
"ORDERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/online-checkout/payment-links/{id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "payment_link_id",
|
||||
"description": "The ID of the payment link to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payment link to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "DeleteSubscriptionAction",
|
||||
"fully_qualified_name": "SquareupApi.DeleteSubscriptionAction@0.1.0",
|
||||
"description": "Delete a scheduled action from a subscription.\n\nThis tool deletes a specific scheduled action associated with a subscription identified by its subscription and action IDs. Use it to cancel or remove actions that are no longer needed from a subscription plan.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"required": true,
|
||||
"description": "The ID of the subscription for which the action is to be deleted. This ID is required to identify the specific subscription being targeted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription the targeted action is to act upon."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "subscription_id"
|
||||
},
|
||||
{
|
||||
"name": "action_id",
|
||||
"required": true,
|
||||
"description": "The ID of the specific action to be deleted from a subscription.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the targeted action to be deleted."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "action_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteSubscriptionAction'.",
|
||||
"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": [
|
||||
"SUBSCRIPTIONS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/subscriptions/{subscription_id}/actions/{action_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"tool_parameter_name": "subscription_id",
|
||||
"description": "The ID of the subscription the targeted action is to act upon.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription the targeted action is to act upon."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "action_id",
|
||||
"tool_parameter_name": "action_id",
|
||||
"description": "The ID of the targeted action to be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the targeted action to be deleted."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "DeleteTimecard",
|
||||
"fully_qualified_name": "SquareupApi.DeleteTimecard@0.1.0",
|
||||
"description": "Deletes a specified timecard.\n\nUse this tool to delete a timecard by its ID when managing labor records.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "timecard_id",
|
||||
"required": true,
|
||||
"description": "The UUID for the timecard to be deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `Timecard` being deleted."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteTimecard'.",
|
||||
"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": [
|
||||
"TIMECARDS_WRITE"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/labor/timecards/{id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "timecard_id",
|
||||
"description": "The UUID for the `Timecard` being deleted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `Timecard` being deleted."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "DeleteWebhookSubscription",
|
||||
"fully_qualified_name": "SquareupApi.DeleteWebhookSubscription@0.1.0",
|
||||
"description": "Deletes a webhook subscription to stop receiving events.\n\nUse this tool to delete a specific webhook subscription by its ID, preventing further event notifications.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "webhook_subscription_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the webhook subscription to be deleted. This ID is required to identify the specific subscription.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "subscription_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DeleteWebhookSubscription'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/webhooks/subscriptions/{subscription_id}",
|
||||
"http_method": "DELETE",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"tool_parameter_name": "webhook_subscription_id",
|
||||
"description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
{
|
||||
"name": "DisableEventsSearch",
|
||||
"fully_qualified_name": "SquareupApi.DisableEventsSearch@0.1.0",
|
||||
"description": "Disable events to prevent them from being searchable.\n\nUse this tool to disable events, preventing them from being searchable, even if re-enabled later. Helpful for managing event visibility.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DisableEvents'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/events/disable",
|
||||
"http_method": "PUT",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "DisablePaymentCard",
|
||||
"fully_qualified_name": "SquareupApi.DisablePaymentCard@0.1.0",
|
||||
"description": "Disable a payment card to prevent charges.\n\nUse this tool to disable a payment card, stopping any further updates or charges. Disabling an already disabled card is permitted but will not have any additional effect.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_card_id",
|
||||
"required": true,
|
||||
"description": "Unique ID for the card to be disabled.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired Card."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "card_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DisableCard'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/cards/{card_id}/disable",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "card_id",
|
||||
"tool_parameter_name": "payment_card_id",
|
||||
"description": "Unique ID for the desired Card.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired Card."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "DismissTerminalAction",
|
||||
"fully_qualified_name": "SquareupApi.DismissTerminalAction@0.1.0",
|
||||
"description": "Dismiss a Square Terminal action request.\n\nUse this tool to dismiss a Terminal action request if it is permitted by the status and type of the request.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_action_id",
|
||||
"required": true,
|
||||
"description": "Unique ID for the TerminalAction associated with the action to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalAction` associated with the action to be dismissed."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "action_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DismissTerminalAction'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/actions/{action_id}/dismiss",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "action_id",
|
||||
"tool_parameter_name": "terminal_action_id",
|
||||
"description": "Unique ID for the `TerminalAction` associated with the action to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalAction` associated with the action to be dismissed."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "DismissTerminalCheckout",
|
||||
"fully_qualified_name": "SquareupApi.DismissTerminalCheckout@0.1.0",
|
||||
"description": "Dismiss a Terminal checkout request if permitted.\n\nCall this tool to dismiss a Terminal checkout request when the request status and type allow for dismissal. Useful for managing checkout operations and correcting errors in checkout processes.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_checkout_id",
|
||||
"required": true,
|
||||
"description": "Unique ID for the TerminalCheckout to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "checkout_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DismissTerminalCheckout'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/checkouts/{checkout_id}/dismiss",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "checkout_id",
|
||||
"tool_parameter_name": "terminal_checkout_id",
|
||||
"description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "DismissTerminalRefund",
|
||||
"fully_qualified_name": "SquareupApi.DismissTerminalRefund@0.1.0",
|
||||
"description": "Dismiss a Terminal refund request if permissible.\n\nUse this tool to dismiss a Terminal refund request when the request status and type allow for dismissal.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_unique_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the `TerminalRefund` that is associated with the refund to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "terminal_refund_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'DismissTerminalRefund'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/refunds/{terminal_refund_id}/dismiss",
|
||||
"http_method": "POST",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_id",
|
||||
"tool_parameter_name": "terminal_refund_unique_id",
|
||||
"description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
{
|
||||
"name": "EnableEventsForSearch",
|
||||
"fully_qualified_name": "SquareupApi.EnableEventsForSearch@0.1.0",
|
||||
"description": "Enable events to make them searchable.\n\nThis tool activates events so that they become searchable. Only events occurring while enabled will be searchable. Use this tool when you need to ensure events are indexed for search.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'EnableEvents'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/events/enable",
|
||||
"http_method": "PUT",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,561 @@
|
|||
{
|
||||
"name": "FetchPaymentList",
|
||||
"fully_qualified_name": "SquareupApi.FetchPaymentList@0.1.0",
|
||||
"description": "Retrieve a list of payments for an account.\n\nThis tool calls the Squareup API to fetch a list of payments associated with the account making the request. It should be called when you need to access recent payment records. Note that results are eventually consistent, and there may be slight delays in updates.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "start_time_for_payment_retrieval",
|
||||
"required": false,
|
||||
"description": "The start time for retrieving payments, in RFC 3339 format, using the `created_at` field. Default is current time minus one year.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format.\nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "begin_time"
|
||||
},
|
||||
{
|
||||
"name": "payment_retrieval_end_time",
|
||||
"required": false,
|
||||
"description": "The end of the time range to retrieve payments, in RFC 3339 format. Defaults to the current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "end_time"
|
||||
},
|
||||
{
|
||||
"name": "order_results_by",
|
||||
"required": false,
|
||||
"description": "Specify the order of payment results: 'ASC' for oldest to newest, 'DESC' for newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A cursor from a previous call for fetching the next set of payment results. Use it for pagination.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "limit_results_by_location",
|
||||
"required": false,
|
||||
"description": "Specify the location ID to limit payment results to that location. Defaults to the main seller location if not provided.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "exact_payment_amount",
|
||||
"required": false,
|
||||
"description": "The exact amount of the payment in the total_money field. Provide as an integer value.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The exact amount in the `total_money` for a payment."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "total"
|
||||
},
|
||||
{
|
||||
"name": "payment_card_last_four_digits",
|
||||
"required": false,
|
||||
"description": "The last four digits of a payment card to filter specific payments.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The last four digits of a payment card."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "last_4"
|
||||
},
|
||||
{
|
||||
"name": "payment_card_brand",
|
||||
"required": false,
|
||||
"description": "The brand of the payment card to filter payments by (e.g., VISA, MasterCard).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The brand of the payment card (for example, VISA)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "card_brand"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Specify the maximum number of payment records to return per page, up to 100. Values over 100 are ignored.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "offline_payment_start_time",
|
||||
"required": false,
|
||||
"description": "Indicate the start of the time range for retrieving offline payments in RFC 3339 format. Defaults to the current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "offline_begin_time"
|
||||
},
|
||||
{
|
||||
"name": "offline_payment_end_time",
|
||||
"required": false,
|
||||
"description": "End time in RFC 3339 format to retrieve offline payments, based on `client_created_at`. Defaults to current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "offline_end_time"
|
||||
},
|
||||
{
|
||||
"name": "updated_at_start_time",
|
||||
"required": false,
|
||||
"description": "Start time in RFC 3339 format to retrieve payments using the `updated_at` field.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "updated_at_begin_time"
|
||||
},
|
||||
{
|
||||
"name": "end_time_for_update_retrieval",
|
||||
"required": false,
|
||||
"description": "The end time in RFC 3339 format to filter payments by the `updated_at` field.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "updated_at_end_time"
|
||||
},
|
||||
{
|
||||
"name": "sort_results_by_field",
|
||||
"required": false,
|
||||
"description": "Specify the field to sort the payment results by. Options are 'CREATED_AT', 'OFFLINE_CREATED_AT', or 'UPDATED_AT'. Default is 'CREATED_AT'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"CREATED_AT",
|
||||
"OFFLINE_CREATED_AT",
|
||||
"UPDATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_field"
|
||||
},
|
||||
{
|
||||
"name": "include_offline_payments",
|
||||
"required": false,
|
||||
"description": "Set to true to include payments taken offline. False excludes them.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Whether the payment was taken offline or not."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "is_offline_payment"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListPayments'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payments",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "begin_time",
|
||||
"tool_parameter_name": "start_time_for_payment_retrieval",
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format.\nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format.\nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"tool_parameter_name": "payment_retrieval_end_time",
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "order_results_by",
|
||||
"description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "limit_results_by_location",
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "total",
|
||||
"tool_parameter_name": "exact_payment_amount",
|
||||
"description": "The exact amount in the `total_money` for a payment.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The exact amount in the `total_money` for a payment."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "last_4",
|
||||
"tool_parameter_name": "payment_card_last_four_digits",
|
||||
"description": "The last four digits of a payment card.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The last four digits of a payment card."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "card_brand",
|
||||
"tool_parameter_name": "payment_card_brand",
|
||||
"description": "The brand of the payment card (for example, VISA).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The brand of the payment card (for example, VISA)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "is_offline_payment",
|
||||
"tool_parameter_name": "include_offline_payments",
|
||||
"description": "Whether the payment was taken offline or not.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Whether the payment was taken offline or not."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "offline_begin_time",
|
||||
"tool_parameter_name": "offline_payment_start_time",
|
||||
"description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "offline_end_time",
|
||||
"tool_parameter_name": "offline_payment_end_time",
|
||||
"description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at_begin_time",
|
||||
"tool_parameter_name": "updated_at_start_time",
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at_end_time",
|
||||
"tool_parameter_name": "end_time_for_update_retrieval",
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_field",
|
||||
"tool_parameter_name": "sort_results_by_field",
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"CREATED_AT",
|
||||
"OFFLINE_CREATED_AT",
|
||||
"UPDATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "FetchSpecificRefund",
|
||||
"fully_qualified_name": "SquareupApi.FetchSpecificRefund@0.1.0",
|
||||
"description": "Retrieve details of a specific refund using its ID.\n\nCall this tool to fetch information about a particular refund by providing the refund ID. This is useful for checking the status and details of any refund made through the system.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "specific_refund_id",
|
||||
"required": true,
|
||||
"description": "The unique ID for the specific PaymentRefund to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `PaymentRefund`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "refund_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetPaymentRefund'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/refunds/{refund_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "refund_id",
|
||||
"tool_parameter_name": "specific_refund_id",
|
||||
"description": "The unique ID for the desired `PaymentRefund`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `PaymentRefund`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,187 @@
|
|||
{
|
||||
"name": "GetAccountDisputes",
|
||||
"fully_qualified_name": "SquareupApi.GetAccountDisputes@0.1.0",
|
||||
"description": "Fetches disputes associated with an account.\n\nUse this tool to retrieve all disputes linked to a specific account. This can help in tracking and managing any disputes that have arisen.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A cursor for retrieving the next set of dispute results from a previous query.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "dispute_states_filter",
|
||||
"required": false,
|
||||
"description": "Filter disputes by their states. Options include 'INQUIRY_EVIDENCE_REQUIRED', 'INQUIRY_PROCESSING', 'INQUIRY_CLOSED', 'EVIDENCE_REQUIRED', 'PROCESSING', 'WON', 'LOST', 'ACCEPTED'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"INQUIRY_EVIDENCE_REQUIRED",
|
||||
"INQUIRY_PROCESSING",
|
||||
"INQUIRY_CLOSED",
|
||||
"EVIDENCE_REQUIRED",
|
||||
"PROCESSING",
|
||||
"WON",
|
||||
"LOST",
|
||||
"ACCEPTED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "states"
|
||||
},
|
||||
{
|
||||
"name": "location_identifier",
|
||||
"required": false,
|
||||
"description": "The ID of the location to return a list of disputes for. If not provided, returns disputes for all locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListDisputes'.",
|
||||
"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": [
|
||||
"DISPUTES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/disputes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "states",
|
||||
"tool_parameter_name": "dispute_states_filter",
|
||||
"description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"INQUIRY_EVIDENCE_REQUIRED",
|
||||
"INQUIRY_PROCESSING",
|
||||
"INQUIRY_CLOSED",
|
||||
"EVIDENCE_REQUIRED",
|
||||
"PROCESSING",
|
||||
"WON",
|
||||
"LOST",
|
||||
"ACCEPTED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_identifier",
|
||||
"description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetBankAccountDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetBankAccountDetails@0.1.0",
|
||||
"description": "Retrieve details of a Square account's bank account.\n\nFetches detailed information about a specific bank account linked to a Square account using the bank account ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "bank_account_identifier",
|
||||
"required": true,
|
||||
"description": "Square-issued ID of the specific bank account to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Square-issued ID of the desired `BankAccount`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "bank_account_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetBankAccount'.",
|
||||
"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": [
|
||||
"BANK_ACCOUNTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bank-accounts/{bank_account_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "bank_account_id",
|
||||
"tool_parameter_name": "bank_account_identifier",
|
||||
"description": "Square-issued ID of the desired `BankAccount`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Square-issued ID of the desired `BankAccount`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetBankAccountDetailsById",
|
||||
"fully_qualified_name": "SquareupApi.GetBankAccountDetailsById@0.1.0",
|
||||
"description": "Retrieve bank account details using V1 ID.\n\nUse this tool to get detailed information about a bank account by providing the V1 bank account ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "v1_bank_account_id",
|
||||
"required": true,
|
||||
"description": "Connect V1 ID of the desired BankAccount. A unique string identifier to retrieve specific bank account details.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "v1_bank_account_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetBankAccountByV1Id'.",
|
||||
"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": [
|
||||
"BANK_ACCOUNTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bank-accounts/by-v1-id/{v1_bank_account_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "v1_bank_account_id",
|
||||
"tool_parameter_name": "v1_bank_account_id",
|
||||
"description": "Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "GetBookingCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.GetBookingCustomAttribute@0.1.0",
|
||||
"description": "Retrieve a custom attribute for a specific booking.\n\nUse this tool to get a custom attribute associated with a given booking, using either buyer- or seller-level permissions.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "target_booking_id",
|
||||
"required": true,
|
||||
"description": "The ID of the target booking to retrieve its custom attribute.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "booking_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute to retrieve, matching the custom attribute definition in the Square seller account. Use the qualified key if not the definition owner.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_version",
|
||||
"required": false,
|
||||
"description": "The current version of the custom attribute for consistent reads. An integer value required to ensure up-to-date data.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definition",
|
||||
"required": false,
|
||||
"description": "Set to true to include the custom attribute's definition, such as name and data type, in the response. Defaults to false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definition"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveBookingCustomAttribute'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/{booking_id}/custom-attributes/{key}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "with_definition",
|
||||
"tool_parameter_name": "include_custom_attribute_definition",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "custom_attribute_version",
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "booking_id",
|
||||
"tool_parameter_name": "target_booking_id",
|
||||
"description": "The ID of the target [booking](entity:Booking).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "GetBookingCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.GetBookingCustomAttributes@0.1.0",
|
||||
"description": "Retrieve all custom attribute definitions for bookings.\n\nUse this tool to get all custom attribute definitions associated with bookings. It requires appropriate OAuth scopes for buyer or seller level permissions.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "Advisory maximum results per page. Minimum is 1, maximum is 100, default is 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Cursor for retrieving the next page of results from a previous response.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListBookingCustomAttributeDefinitions'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,297 @@
|
|||
{
|
||||
"name": "GetBookingList",
|
||||
"fully_qualified_name": "SquareupApi.GetBookingList@0.1.0",
|
||||
"description": "Retrieve a collection of bookings.\n\nUse this tool to get a collection of bookings from the Squareup service. Relevant permissions (OAuth scope) are needed: `APPOINTMENTS_READ` for buyer-level and `APPOINTMENTS_ALL_READ` along with `APPOINTMENTS_READ` for seller-level permissions.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "results_per_page_limit",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to display per page in the response. Accepts an integer value.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results per page to return in a paged response."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor from the previous response for fetching the next page of results. Leave unset for the first page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "specific_customer_id",
|
||||
"required": false,
|
||||
"description": "The specific customer for whom to retrieve bookings. If not set, retrieves bookings for all customers.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
},
|
||||
{
|
||||
"name": "team_member_id",
|
||||
"required": false,
|
||||
"description": "Specify the team member ID to retrieve bookings for. If not set, retrieves bookings for all team members.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "team_member_id"
|
||||
},
|
||||
{
|
||||
"name": "specific_location_id",
|
||||
"required": false,
|
||||
"description": "Specify the location ID to retrieve bookings for that location only. If not set, bookings for all locations are retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "earliest_start_time",
|
||||
"required": false,
|
||||
"description": "The RFC 3339 timestamp for the earliest booking start time. Defaults to current time if not set.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "start_at_min"
|
||||
},
|
||||
{
|
||||
"name": "latest_start_time",
|
||||
"required": false,
|
||||
"description": "The RFC 3339 timestamp for the latest acceptable start time of bookings. Defaults to 31 days after `start_at_min` if not set.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "start_at_max"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListBookings'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "results_per_page_limit",
|
||||
"description": "The maximum number of results per page to return in a paged response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results per page to return in a paged response."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "specific_customer_id",
|
||||
"description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "team_member_id",
|
||||
"tool_parameter_name": "team_member_id",
|
||||
"description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "specific_location_id",
|
||||
"description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "start_at_min",
|
||||
"tool_parameter_name": "earliest_start_time",
|
||||
"description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "start_at_max",
|
||||
"tool_parameter_name": "latest_start_time",
|
||||
"description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
{
|
||||
"name": "GetBusinessBookingProfile",
|
||||
"fully_qualified_name": "SquareupApi.GetBusinessBookingProfile@0.1.0",
|
||||
"description": "Retrieve seller's booking profile details.\n\nUse this tool to get detailed information about a seller's booking profile. Call this tool when you need to provide or display booking-related information for a seller.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveBusinessBookingProfile'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_BUSINESS_SETTINGS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/business-booking-profile",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "GetCashDrawerShiftDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetCashDrawerShiftDetails@0.1.0",
|
||||
"description": "Get summary details for a specific cash drawer shift.\n\nUse this tool to retrieve detailed information about a specific cash drawer shift, including relevant data about its transactions and status.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_identifier",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the location to retrieve cash drawer shifts from. Ensure this matches the location set up in Squareup.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to retrieve cash drawer shifts from."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "cash_drawer_shift_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the cash drawer shift to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The shift ID."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "shift_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveCashDrawerShift'.",
|
||||
"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": [
|
||||
"CASH_DRAWER_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/cash-drawers/shifts/{shift_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_identifier",
|
||||
"description": "The ID of the location to retrieve cash drawer shifts from.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to retrieve cash drawer shifts from."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "shift_id",
|
||||
"tool_parameter_name": "cash_drawer_shift_id",
|
||||
"description": "The shift ID.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The shift ID."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "GetCustomerCustomAttributeDefinition",
|
||||
"fully_qualified_name": "SquareupApi.GetCustomerCustomAttributeDefinition@0.1.0",
|
||||
"description": "Retrieve a customer's custom attribute definition from Square.\n\nFetches a customer-related custom attribute definition from a Square seller account. This should be called to get definitions where visibility is either 'READ_ONLY' or 'READ_WRITE_VALUES', including seller-defined custom fields.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute definition to retrieve. Use the qualified key if not the definition owner.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_version",
|
||||
"required": false,
|
||||
"description": "Current version of the attribute definition for consistent reads. Returns specified or higher version data. Error if version is too high.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveCustomerCustomAttributeDefinition'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions/{key}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "custom_attribute_version",
|
||||
"description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetCustomerDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetCustomerDetails@0.1.0",
|
||||
"description": "Retrieve details for a specific customer.\n\nUse this tool to get detailed information about a specific customer by their ID. Ideal for when you need to access customer profiles or verify customer details.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the customer to retrieve details for. Used to access specific customer information.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveCustomer'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/{customer_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_id",
|
||||
"description": "The ID of the customer to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the customer to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "GetDisputeEvidenceMetadata",
|
||||
"fully_qualified_name": "SquareupApi.GetDisputeEvidenceMetadata@0.1.0",
|
||||
"description": "Retrieve metadata for specified dispute evidence.\n\nCall this tool to obtain metadata of dispute evidence using a given dispute ID and evidence ID. Ensure to maintain a copy of any evidence uploaded as it cannot be downloaded later.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the dispute to retrieve its evidence metadata.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute from which you want to retrieve evidence metadata."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "dispute_id"
|
||||
},
|
||||
{
|
||||
"name": "evidence_id",
|
||||
"required": true,
|
||||
"description": "The ID of the evidence you wish to retrieve metadata for. Ensure correct ID is provided to access the specific evidence details.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the evidence to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "evidence_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveDisputeEvidence'.",
|
||||
"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": [
|
||||
"DISPUTES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/disputes/{dispute_id}/evidence/{evidence_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"tool_parameter_name": "dispute_id",
|
||||
"description": "The ID of the dispute from which you want to retrieve evidence metadata.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute from which you want to retrieve evidence metadata."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "evidence_id",
|
||||
"tool_parameter_name": "evidence_id",
|
||||
"description": "The ID of the evidence to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the evidence to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetGiftCardDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetGiftCardDetails@0.1.0",
|
||||
"description": "Retrieve details of a gift card using its ID.\n\nUse this tool to access information about a specific gift card by providing its ID. It is useful for checking gift card balance, status, and other related details.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "gift_card_id",
|
||||
"required": true,
|
||||
"description": "The ID of the gift card to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the gift card to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveGiftCard'.",
|
||||
"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": [
|
||||
"GIFTCARDS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/gift-cards/{id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "gift_card_id",
|
||||
"description": "The ID of the gift card to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the gift card to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetInventoryAdjustment",
|
||||
"fully_qualified_name": "SquareupApi.GetInventoryAdjustment@0.1.0",
|
||||
"description": "Retrieve detailed information on an inventory adjustment.\n\nThis tool retrieves the details of a specific InventoryAdjustment using the provided adjustment ID. It should be called when you need to obtain information about changes in inventory quantities.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "inventory_adjustment_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the inventory adjustment to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "adjustment_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveInventoryAdjustment'.",
|
||||
"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": [
|
||||
"INVENTORY_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/inventory/adjustments/{adjustment_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "adjustment_id",
|
||||
"tool_parameter_name": "inventory_adjustment_id",
|
||||
"description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetInventoryTransfer",
|
||||
"fully_qualified_name": "SquareupApi.GetInventoryTransfer@0.1.0",
|
||||
"description": "Retrieve details of an Inventory Transfer using its ID.\n\nUse this tool to obtain information about a specific Inventory Transfer by providing its transfer ID. This can be useful for tracking inventory movements within a system.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "inventory_transfer_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the InventoryTransfer to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "transfer_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveInventoryTransfer'.",
|
||||
"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": [
|
||||
"INVENTORY_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/inventory/transfers/{transfer_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "transfer_id",
|
||||
"tool_parameter_name": "inventory_transfer_id",
|
||||
"description": "ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "GetLocationCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.GetLocationCustomAttribute@0.1.0",
|
||||
"description": "Retrieve a custom attribute for a specified location.\n\nThis tool fetches a custom attribute associated with a specific location. Optional retrieval of the custom attribute's definition is available. Visibility settings must permit access if owned by another application.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"required": true,
|
||||
"description": "The ID of the location for which the custom attribute is being retrieved. This is required to identify the specific location in the Square account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [location](entity:Location)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute to retrieve. Must match a custom attribute definition key in the Square seller account. Use the qualified key if not the definition owner.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_version",
|
||||
"required": false,
|
||||
"description": "Specify the version of the custom attribute for consistent reads. If a higher version exists, it is returned. If higher than the current version, an error occurs.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
},
|
||||
{
|
||||
"name": "include_definition",
|
||||
"required": false,
|
||||
"description": "Set to true to include the custom attribute's definition, providing name, description, and data type.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definition"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveLocationCustomAttribute'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/locations/{location_id}/custom-attributes/{key}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "with_definition",
|
||||
"tool_parameter_name": "include_definition",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "custom_attribute_version",
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id",
|
||||
"description": "The ID of the target [location](entity:Location).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [location](entity:Location)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "GetMerchantCustomAttribute",
|
||||
"fully_qualified_name": "SquareupApi.GetMerchantCustomAttribute@0.1.0",
|
||||
"description": "Retrieve a custom attribute for a specific merchant.\n\nThis tool retrieves a custom attribute associated with a merchant. Use it to access merchant-specific data, with the option to include the custom attribute definition. Visibility settings dictate access permissions.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "merchant_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the target merchant whose custom attribute is to be retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [merchant](entity:Merchant)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "merchant_id"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_key",
|
||||
"required": true,
|
||||
"description": "The key of the custom attribute to retrieve. Must match the `key` of a custom attribute definition in the Square seller account.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "key"
|
||||
},
|
||||
{
|
||||
"name": "custom_attribute_version",
|
||||
"required": false,
|
||||
"description": "Specifies the version of the custom attribute for consistent reads. If higher than current, returns an error.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "version"
|
||||
},
|
||||
{
|
||||
"name": "include_definition",
|
||||
"required": false,
|
||||
"description": "Set to true to include the custom attribute definition, providing additional details such as name, description, and data type.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definition"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveMerchantCustomAttribute'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/merchants/{merchant_id}/custom-attributes/{key}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "with_definition",
|
||||
"tool_parameter_name": "include_definition",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"tool_parameter_name": "custom_attribute_version",
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "merchant_id",
|
||||
"tool_parameter_name": "merchant_id",
|
||||
"description": "The ID of the target [merchant](entity:Merchant).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [merchant](entity:Merchant)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"tool_parameter_name": "custom_attribute_key",
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetMerchantDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetMerchantDetails@0.1.0",
|
||||
"description": "Retrieve merchant details using an access token.\n\nProvides information about the merchant linked to the specified access token. Typically returns a single merchant object. Useful for obtaining merchant details for personal or OAuth token-based access.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "previous_response_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor generated by the previous response. Use this to fetch the next set of merchant details if needed.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor generated by the previous response."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListMerchants'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/merchants",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "previous_response_cursor",
|
||||
"description": "The cursor generated by the previous response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor generated by the previous response."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetPaymentDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetPaymentDetails@0.1.0",
|
||||
"description": "Retrieve specific payment details by payment ID.\n\nUse this tool to obtain detailed information about a specific payment using its payment ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_id",
|
||||
"required": true,
|
||||
"description": "A unique ID for the desired payment to retrieve specific payment details.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A unique ID for the desired payment."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "payment_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetPayment'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payments/{payment_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payment_id",
|
||||
"tool_parameter_name": "payment_id",
|
||||
"description": "A unique ID for the desired payment.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A unique ID for the desired payment."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "GetPayoutDetails",
|
||||
"fully_qualified_name": "SquareupApi.GetPayoutDetails@0.1.0",
|
||||
"description": "Retrieve details of a specific payout by payout ID.\n\nUse this tool to get detailed information about a specific payout by providing the payout ID. Useful for tracking or reviewing specific payout transactions.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payout_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier of the payout to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payout to retrieve the information for."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "payout_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetPayout'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payouts/{payout_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payout_id",
|
||||
"tool_parameter_name": "payout_id",
|
||||
"description": "The ID of the payout to retrieve the information for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payout to retrieve the information for."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,307 @@
|
|||
{
|
||||
"name": "GetPayoutList",
|
||||
"fully_qualified_name": "SquareupApi.GetPayoutList@0.1.0",
|
||||
"description": "Retrieve a list of all payouts for the default location.\n\nThis tool retrieves all payouts for the default location, allowing filtration by location ID, status, time range, and sorting order. It requires the `PAYOUTS_READ` OAuth scope.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"required": false,
|
||||
"description": "ID of the location to list payouts. Defaults to the main location if not specified.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "payout_status_filter",
|
||||
"required": false,
|
||||
"description": "Filter payouts by status: 'SENT', 'FAILED', or 'PAID'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"SENT",
|
||||
"FAILED",
|
||||
"PAID"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only payouts with the given status are returned."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "status"
|
||||
},
|
||||
{
|
||||
"name": "start_time_for_payouts",
|
||||
"required": false,
|
||||
"description": "RFC 3339 formatted timestamp for the beginning of payout creation. Defaults to one year ago.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "begin_time"
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"required": false,
|
||||
"description": "The timestamp for the end of the payout creation time, in RFC 3339 format. Defaults to the current time if not provided.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "end_time"
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"required": false,
|
||||
"description": "Determines if the list of payouts is sorted in ascending ('ASC') or descending ('DESC') order.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which payouts are listed."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor from a previous call, used to retrieve the next set of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return per page. Must be 100 or fewer; defaults to 100 if a higher value is provided.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListPayouts'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payouts",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id",
|
||||
"description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"tool_parameter_name": "payout_status_filter",
|
||||
"description": "If provided, only payouts with the given status are returned.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"SENT",
|
||||
"FAILED",
|
||||
"PAID"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only payouts with the given status are returned."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "begin_time",
|
||||
"tool_parameter_name": "start_time_for_payouts",
|
||||
"description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"tool_parameter_name": "end_time",
|
||||
"description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "sort_order",
|
||||
"description": "The order in which payouts are listed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which payouts are listed."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetScheduledShift",
|
||||
"fully_qualified_name": "SquareupApi.GetScheduledShift@0.1.0",
|
||||
"description": "Retrieve details of a scheduled shift by ID.\n\nThe tool retrieves information about a scheduled shift using its unique ID. Call this tool when you need detailed information about a specific shift.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "scheduled_shift_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the scheduled shift to retrieve details for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the scheduled shift to retrieve."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveScheduledShift'.",
|
||||
"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": [
|
||||
"TIMECARDS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/labor/scheduled-shifts/{id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "scheduled_shift_id",
|
||||
"description": "The ID of the scheduled shift to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the scheduled shift to retrieve."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
{
|
||||
"name": "GetSquareMerchantSettings",
|
||||
"fully_qualified_name": "SquareupApi.GetSquareMerchantSettings@0.1.0",
|
||||
"description": "Retrieve merchant settings for Square checkout pages.\n\nUse this tool to get the merchant-level settings configured for a Square-hosted checkout page. Useful for accessing checkout configurations and preferences.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'RetrieveMerchantSettings'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ",
|
||||
"PAYMENT_METHODS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/online-checkout/merchant-settings",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetTeamMemberWage",
|
||||
"fully_qualified_name": "SquareupApi.GetTeamMemberWage@0.1.0",
|
||||
"description": "Retrieve wage details for a specified team member.\n\nUse this tool to obtain wage information for a specific team member by providing their unique ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "team_member_wage_id",
|
||||
"required": true,
|
||||
"description": "The unique UUID for retrieving the specified team member's wage.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `TeamMemberWage` being retrieved."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetTeamMemberWage'.",
|
||||
"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": [
|
||||
"EMPLOYEES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/labor/team-member-wages/{id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"tool_parameter_name": "team_member_wage_id",
|
||||
"description": "The UUID for the `TeamMemberWage` being retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The UUID for the `TeamMemberWage` being retrieved."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetTerminalAction",
|
||||
"fully_qualified_name": "SquareupApi.GetTerminalAction@0.1.0",
|
||||
"description": "Retrieve details of a terminal action request by ID.\n\nThis tool retrieves a Terminal action request using the specified `action_id`. Terminal action requests can be accessed within 30 days of their request.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_action_id",
|
||||
"required": true,
|
||||
"description": "Unique ID of the terminal action to retrieve. Must be provided to access the TerminalAction details.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired `TerminalAction`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "action_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetTerminalAction'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/actions/{action_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "action_id",
|
||||
"tool_parameter_name": "terminal_action_id",
|
||||
"description": "Unique ID for the desired `TerminalAction`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Unique ID for the desired `TerminalAction`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "GetTerminalRefund",
|
||||
"fully_qualified_name": "SquareupApi.GetTerminalRefund@0.1.0",
|
||||
"description": "Fetch Interac Terminal refund details by ID.\n\nUse this tool to retrieve details of an Interac Terminal refund within 30 days of its creation using the refund ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the Interac Terminal refund to retrieve. Must be used within 30 days of creation.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalRefund`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "terminal_refund_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'GetTerminalRefund'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/terminals/refunds/{terminal_refund_id}",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "terminal_refund_id",
|
||||
"tool_parameter_name": "terminal_refund_id",
|
||||
"description": "The unique ID for the desired `TerminalRefund`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The unique ID for the desired `TerminalRefund`."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
{
|
||||
"name": "ListBankAccounts",
|
||||
"fully_qualified_name": "SquareupApi.ListBankAccounts@0.1.0",
|
||||
"description": "Fetch a list of bank accounts linked to a Square account.\n\nCall this tool to retrieve all bank accounts associated with a Square account. Useful for checking account details or managing linked bank accounts.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor from a previous call to fetch the next set of bank account results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_bank_accounts_limit",
|
||||
"required": false,
|
||||
"description": "Specify the maximum number of bank accounts to return. The largest supported limit is 1000.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "location_id_filter",
|
||||
"required": false,
|
||||
"description": "Optional filter to retrieve bank accounts for a specified location ID only.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListBankAccounts'.",
|
||||
"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": [
|
||||
"BANK_ACCOUNTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bank-accounts",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_bank_accounts_limit",
|
||||
"description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id_filter",
|
||||
"description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "ListBookingCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.ListBookingCustomAttributes@0.1.0",
|
||||
"description": "Lists custom attributes for a specific booking.\n\nUse this tool to retrieve the custom attributes associated with a specific booking. Ensure the appropriate OAuth permissions (`APPOINTMENTS_READ` for buyer-level or `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for seller-level) are set before calling this endpoint.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "booking_identifier",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the target booking whose custom attributes you want to list.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "booking_id"
|
||||
},
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return per page, between 1 and 100. Default is 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Cursor for retrieving the next page of results from a previous call to the endpoint.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definitions",
|
||||
"required": false,
|
||||
"description": "Set to true to include custom attribute definition details, such as name and data type, in the response. Default is false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definitions"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListBookingCustomAttributes'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/{booking_id}/custom-attributes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "with_definitions",
|
||||
"tool_parameter_name": "include_custom_attribute_definitions",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "booking_id",
|
||||
"tool_parameter_name": "booking_identifier",
|
||||
"description": "The ID of the target [booking](entity:Booking).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [booking](entity:Booking)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
{
|
||||
"name": "ListBusinessBreakTypes",
|
||||
"fully_qualified_name": "SquareupApi.ListBusinessBreakTypes@0.1.0",
|
||||
"description": "Retrieve a list of BreakType instances for a business.\n\nThis tool provides a paginated list of BreakType instances associated with a business. Use it to fetch information about different break types configured in a business's system.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filter_by_location_id",
|
||||
"required": false,
|
||||
"description": "Filter results to only include BreakTypes associated with a specific location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of BreakType results to return per page, between 1 and 200. Default is 200.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pointer to the next page of BreakType results for retrieval.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pointer to the next page of `BreakType` results to fetch."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListBreakTypes'.",
|
||||
"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": [
|
||||
"TIMECARDS_SETTINGS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/labor/break-types",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "filter_by_location_id",
|
||||
"description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pointer to the next page of `BreakType` results to fetch.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pointer to the next page of `BreakType` results to fetch."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "ListCashDrawerShiftEvents",
|
||||
"fully_qualified_name": "SquareupApi.ListCashDrawerShiftEvents@0.1.0",
|
||||
"description": "Retrieve events for a specific cash drawer shift.\n\nThis tool retrieves a paginated list of events for a specific cash drawer shift. It is useful for tracking activities and occurrences related to a particular shift.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_identifier",
|
||||
"required": true,
|
||||
"description": "The ID of the location to list cash drawer shifts for. This should be a valid location ID registered within the system.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to list cash drawer shifts for."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "cash_drawer_shift_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the cash drawer shift for which events are to be retrieved.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The shift ID."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "shift_id"
|
||||
},
|
||||
{
|
||||
"name": "page_size_limit",
|
||||
"required": false,
|
||||
"description": "Number of events to return per page, default is 200, maximum is 1000.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Opaque string to fetch the next page of results for cash drawer shift events.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Opaque cursor for fetching the next page of results."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCashDrawerShiftEvents'.",
|
||||
"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": [
|
||||
"CASH_DRAWER_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/cash-drawers/shifts/{shift_id}/events",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_identifier",
|
||||
"description": "The ID of the location to list cash drawer shifts for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to list cash drawer shifts for."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "page_size_limit",
|
||||
"description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "Opaque cursor for fetching the next page of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Opaque cursor for fetching the next page of results."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "shift_id",
|
||||
"tool_parameter_name": "cash_drawer_shift_id",
|
||||
"description": "The shift ID.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The shift ID."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,271 @@
|
|||
{
|
||||
"name": "ListCashDrawerShifts",
|
||||
"fully_qualified_name": "SquareupApi.ListCashDrawerShifts@0.1.0",
|
||||
"description": "Retrieve cash drawer shift details for a location and date range.\n\nThis tool provides details for all the cash drawer shifts for a specified location within a given date range. It should be called when cash drawer shift information is needed, such as start and end times, cash amounts, or other shift details for financial tracking and auditing purposes.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_identifier",
|
||||
"required": true,
|
||||
"description": "The unique identifier for the location to query for cash drawer shifts.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to query for a list of cash drawer shifts."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "sort_order_for_listing",
|
||||
"required": false,
|
||||
"description": "Specifies the order for listing cash drawer shifts by their opened_at field. Use 'ASC' for ascending or 'DESC' for descending. Defaults to 'ASC'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "query_start_time",
|
||||
"required": false,
|
||||
"description": "The inclusive start time for the query on opened_at, in ISO 8601 format.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The inclusive start time of the query on opened_at, in ISO 8601 format."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "begin_time"
|
||||
},
|
||||
{
|
||||
"name": "exclusive_end_date",
|
||||
"required": false,
|
||||
"description": "The exclusive end time of the query on opened_at, specified in ISO 8601 format, to define the endpoint for the cash drawer shift search.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The exclusive end date of the query on opened_at, in ISO 8601 format."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "end_time"
|
||||
},
|
||||
{
|
||||
"name": "result_limit",
|
||||
"required": false,
|
||||
"description": "Specifies the number of cash drawer shift events per results page. Defaults to 200, with a maximum of 1000.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "next_page_cursor",
|
||||
"required": false,
|
||||
"description": "Opaque cursor for fetching the next page of results, used for pagination.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Opaque cursor for fetching the next page of results."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCashDrawerShifts'.",
|
||||
"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": [
|
||||
"CASH_DRAWER_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/cash-drawers/shifts",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_identifier",
|
||||
"description": "The ID of the location to query for a list of cash drawer shifts.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location to query for a list of cash drawer shifts."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "sort_order_for_listing",
|
||||
"description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "begin_time",
|
||||
"tool_parameter_name": "query_start_time",
|
||||
"description": "The inclusive start time of the query on opened_at, in ISO 8601 format.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The inclusive start time of the query on opened_at, in ISO 8601 format."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"tool_parameter_name": "exclusive_end_date",
|
||||
"description": "The exclusive end date of the query on opened_at, in ISO 8601 format.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The exclusive end date of the query on opened_at, in ISO 8601 format."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "result_limit",
|
||||
"description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "next_page_cursor",
|
||||
"description": "Opaque cursor for fetching the next page of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Opaque cursor for fetching the next page of results."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
{
|
||||
"name": "ListCatalogItems",
|
||||
"fully_qualified_name": "SquareupApi.ListCatalogItems@0.1.0",
|
||||
"description": "Retrieve a list of catalog objects by type.\n\nThis tool retrieves a list of all catalog objects of specified types, such as ITEM, ITEM_VARIATION, MODIFIER, etc., excluding deleted items. It's useful for accessing and managing various components of a catalog in the Square ecosystem.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor from the previous response. Leave empty for the initial request. Defaults to a page size of 100 results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "catalog_object_types",
|
||||
"required": false,
|
||||
"description": "A comma-separated list of catalog object types to retrieve. Defaults to returning top-level types if unspecified.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "types"
|
||||
},
|
||||
{
|
||||
"name": "catalog_version",
|
||||
"required": false,
|
||||
"description": "Specify the version of the catalog objects to retrieve. Use to access historical versions. Default retrieves the current version.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "catalog_version"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCatalog'.",
|
||||
"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": [
|
||||
"ITEMS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/catalog/list",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "types",
|
||||
"tool_parameter_name": "catalog_object_types",
|
||||
"description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "catalog_version",
|
||||
"tool_parameter_name": "catalog_version",
|
||||
"description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListCustomerCustomAttributeDefinitions",
|
||||
"fully_qualified_name": "SquareupApi.ListCustomerCustomAttributeDefinitions@0.1.0",
|
||||
"description": "Retrieve customer custom attribute definitions for a Square seller.\n\nUse this tool to list all customer-related custom attribute definitions for a Square seller account. It returns all visible custom attribute definitions to the requesting application, including those set by other applications.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return in a paged response. Accepts values from 1 to 100, with a default of 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Cursor for retrieving the next page of results. Obtain this from a previous response.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCustomerCustomAttributeDefinitions'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "ListCustomerCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.ListCustomerCustomAttributes@0.1.0",
|
||||
"description": "Retrieve custom attributes for a customer profile.\n\nThis tool lists the custom attributes associated with a specified customer profile. It can also retrieve custom attribute definitions if specified. It returns all attributes visible to the requesting application, including those with read-only or read-write visibility owned by other applications.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "customer_profile_id",
|
||||
"required": true,
|
||||
"description": "The ID of the customer profile for which to list custom attributes.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [customer profile](entity:Customer)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
},
|
||||
{
|
||||
"name": "result_limit",
|
||||
"required": false,
|
||||
"description": "Maximum number of results for a single response. Accepts values 1-100, with a default of 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor from the previous response to continue retrieving results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definitions",
|
||||
"required": false,
|
||||
"description": "Indicate whether to include custom attribute definitions such as name, description, and data type details in the response. Default is false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definitions"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCustomerCustomAttributes'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/{customer_id}/custom-attributes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "result_limit",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "with_definitions",
|
||||
"tool_parameter_name": "include_custom_attribute_definitions",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_profile_id",
|
||||
"description": "The ID of the target [customer profile](entity:Customer).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [customer profile](entity:Customer)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListCustomerGroups",
|
||||
"fully_qualified_name": "SquareupApi.ListCustomerGroups@0.1.0",
|
||||
"description": "Retrieve the list of customer groups for a business.\n\nUse this tool to access all customer groups associated with a business. Useful for managing or displaying customer segmentation and categories.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor to retrieve the next set of customer groups. Used to continue from the last retrieved page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return per page, between 1 and 50. Defaults to 50.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCustomerGroups'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/groups",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListCustomerSegments",
|
||||
"fully_qualified_name": "SquareupApi.ListCustomerSegments@0.1.0",
|
||||
"description": "Retrieve the list of customer segments for a business.\n\nCall this tool to obtain the customer segments associated with a business. This can be useful for understanding customer classifications and targeting specific groups in marketing or service strategies.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor for retrieving the next set of customer segment results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Maximum number of results to return per page. Must be between 1 and 50. Default is 50. If outside this range, an error is returned.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCustomerSegments'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers/segments",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,215 @@
|
|||
{
|
||||
"name": "ListDeviceCodes",
|
||||
"fully_qualified_name": "SquareupApi.ListDeviceCodes@0.1.0",
|
||||
"description": "Retrieve all device codes for the merchant.\n\nThis tool retrieves all device codes associated with a merchant account on Square. It should be called when there's a need to list or manage the devices linked to a merchant.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor from a previous call, used to retrieve the next set of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_location_id",
|
||||
"required": false,
|
||||
"description": "Specify a location to return only its DeviceCodes. Leave empty to return codes from all locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_product_type",
|
||||
"required": false,
|
||||
"description": "Specify a product type to target specific DeviceCodes. Use 'TERMINAL_API' or leave empty for all types.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"TERMINAL_API"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "product_type"
|
||||
},
|
||||
{
|
||||
"name": "device_code_status",
|
||||
"required": false,
|
||||
"description": "Specifies the status of DeviceCodes to return. Options: UNKNOWN, UNPAIRED, PAIRED, EXPIRED. Returns PAIRED and UNPAIRED if empty.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"UNPAIRED",
|
||||
"PAIRED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListDeviceCodes'.",
|
||||
"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": [
|
||||
"DEVICE_CREDENTIAL_MANAGEMENT"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/devices/codes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "filter_by_location_id",
|
||||
"description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "product_type",
|
||||
"tool_parameter_name": "filter_by_product_type",
|
||||
"description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"TERMINAL_API"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"tool_parameter_name": "device_code_status",
|
||||
"description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"UNPAIRED",
|
||||
"PAIRED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListDisputeEvidence",
|
||||
"fully_qualified_name": "SquareupApi.ListDisputeEvidence@0.1.0",
|
||||
"description": "Retrieve evidence related to a specific dispute.\n\nUse this tool to obtain a list of all evidence associated with a particular dispute by specifying the dispute ID.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"required": true,
|
||||
"description": "The unique identifier of the dispute for which evidence is being requested.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "dispute_id"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor to retrieve the next set of results for the original query.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListDisputeEvidence'.",
|
||||
"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": [
|
||||
"DISPUTES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/disputes/{dispute_id}/evidence",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "dispute_id",
|
||||
"tool_parameter_name": "dispute_id",
|
||||
"description": "The ID of the dispute.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the dispute."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"name": "ListEventTypes",
|
||||
"fully_qualified_name": "SquareupApi.ListEventTypes@0.1.0",
|
||||
"description": "Retrieve all event types available for webhooks and querying.\n\nUse this tool to list all the event types you can subscribe to as webhooks or query via the Events API. It helps in understanding which events are trackable and can be used for notifications or further analysis.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "api_version",
|
||||
"required": false,
|
||||
"description": "Specify the API version to list event types. This overrides the default application version.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The API version for which to list event types. Setting this field overrides the default version used by the application."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "api_version"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListEventTypes'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/events/types",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "api_version",
|
||||
"tool_parameter_name": "api_version",
|
||||
"description": "The API version for which to list event types. Setting this field overrides the default version used by the application.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The API version for which to list event types. Setting this field overrides the default version used by the application."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,329 @@
|
|||
{
|
||||
"name": "ListGiftCardActivities",
|
||||
"fully_qualified_name": "SquareupApi.ListGiftCardActivities@0.1.0",
|
||||
"description": "Retrieve and filter gift card activities for a seller.\n\nLists gift card activities from the seller's account. Optionally filter the activities by gift card, region, or within a specific time window.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "gift_card_id",
|
||||
"required": false,
|
||||
"description": "Specify a gift card ID to return activities related to that gift card. Leave empty to return all gift card activities for the seller.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "gift_card_id"
|
||||
},
|
||||
{
|
||||
"name": "activity_type",
|
||||
"required": false,
|
||||
"description": "Filter gift card activities by specifying a particular activity type. If not provided, returns all activity types.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "type"
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"required": false,
|
||||
"description": "Specify the location ID to filter gift card activities for a particular location. Leave empty to return activities for all locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "reporting_start_time",
|
||||
"required": false,
|
||||
"description": "The starting timestamp for the reporting period, in RFC 3339 format. Includes this date and time. Defaults to one year prior from now if not specified.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "begin_time"
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"required": false,
|
||||
"description": "The inclusive end timestamp for the reporting period in RFC 3339 format. Defaults to current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "end_time"
|
||||
},
|
||||
{
|
||||
"name": "result_limit",
|
||||
"required": false,
|
||||
"description": "Specify the maximum number of results per page. Default is 50, maximum allowed is 100.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor from a previous call to get the next set of results. If not provided, the first page is returned.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "activities_sort_order",
|
||||
"required": false,
|
||||
"description": "Defines the order of gift card activities based on creation date. Use 'ASC' for oldest to newest, or 'DESC' for newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListGiftCardActivities'.",
|
||||
"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": [
|
||||
"GIFTCARDS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/gift-cards/activities",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "gift_card_id",
|
||||
"tool_parameter_name": "gift_card_id",
|
||||
"description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"tool_parameter_name": "activity_type",
|
||||
"description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id",
|
||||
"description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "begin_time",
|
||||
"tool_parameter_name": "reporting_start_time",
|
||||
"description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"tool_parameter_name": "end_time",
|
||||
"description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "result_limit",
|
||||
"description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "activities_sort_order",
|
||||
"description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,233 @@
|
|||
{
|
||||
"name": "ListGiftCards",
|
||||
"fully_qualified_name": "SquareupApi.ListGiftCards@0.1.0",
|
||||
"description": "Retrieve a list of all gift cards, with optional filters.\n\nCall this tool to obtain a sorted list of gift cards. You can apply filters to narrow down the results. Useful for managing and reviewing available gift cards.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "gift_card_type",
|
||||
"required": false,
|
||||
"description": "Specifies the type of gift cards to retrieve. If not provided, all types are returned.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "type"
|
||||
},
|
||||
{
|
||||
"name": "gift_card_state",
|
||||
"required": false,
|
||||
"description": "Specifies the state of gift cards to return. Leave empty to get all states.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "state"
|
||||
},
|
||||
{
|
||||
"name": "results_per_page_limit",
|
||||
"required": false,
|
||||
"description": "The number of gift card results per page. Maximum is 200, default is 30.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A string used to retrieve the next set of results for pagination from a previous call.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"required": false,
|
||||
"description": "A unique identifier for a customer to retrieve gift cards linked to them.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "customer_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListGiftCards'.",
|
||||
"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": [
|
||||
"GIFTCARDS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/gift-cards",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "type",
|
||||
"tool_parameter_name": "gift_card_type",
|
||||
"description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "state",
|
||||
"tool_parameter_name": "gift_card_state",
|
||||
"description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "results_per_page_limit",
|
||||
"description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"tool_parameter_name": "customer_id",
|
||||
"description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
{
|
||||
"name": "ListInvoices",
|
||||
"fully_qualified_name": "SquareupApi.ListInvoices@0.1.0",
|
||||
"description": "Retrieve a list of invoices for a specified location.\n\nUse this tool to get a list of invoices from a specific location. The response is paginated, and if the list is truncated, a cursor is provided to fetch the next set of invoices.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"required": true,
|
||||
"description": "The ID of the location for which to list invoices.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to list invoices."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A string value used to fetch the next set of paginated results for invoices. This is returned from a previous call to the list invoices endpoint.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "maximum_invoices_to_return",
|
||||
"required": false,
|
||||
"description": "The maximum number of invoices to return, up to 200. Defaults to 100 if not specified.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListInvoices'.",
|
||||
"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": [
|
||||
"INVOICES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/invoices",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id",
|
||||
"description": "The ID of the location for which to list invoices.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the location for which to list invoices."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_invoices_to_return",
|
||||
"description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"name": "ListJobsForSeller",
|
||||
"fully_qualified_name": "SquareupApi.ListJobsForSeller@0.1.0",
|
||||
"description": "Retrieve a list of jobs in a seller account.\n\nThis tool retrieves a list of jobs associated with a seller account, sorted by title in ascending order. Use this tool when you need to view or manage the job listings for a seller.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor for pagination to retrieve the next page of job results. Obtain this from the previous response.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListJobs'.",
|
||||
"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": [
|
||||
"EMPLOYEES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/team-members/jobs",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListLocationBookingProfiles",
|
||||
"fully_qualified_name": "SquareupApi.ListLocationBookingProfiles@0.1.0",
|
||||
"description": "Lists location booking profiles of a seller.\n\nUse this tool to retrieve a list of all the booking profiles associated with a seller's locations from Squareup.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of booking profiles to retrieve in one page of the response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a paged response."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Use this to provide the pagination cursor from the previous response to get the next set of results. Leave unset for the first page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListLocationBookingProfiles'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_BUSINESS_SETTINGS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/location-booking-profiles",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a paged response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a paged response."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
{
|
||||
"name": "ListLocationCustomAttributeDefinitions",
|
||||
"fully_qualified_name": "SquareupApi.ListLocationCustomAttributeDefinitions@0.1.0",
|
||||
"description": "Retrieve location custom attribute definitions for a Square account.\n\nThis tool retrieves all location-related custom attribute definitions for a Square seller account. It includes those visible to the requesting application, even if created by other applications. Use this to access custom attribute definitions with various visibility settings.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filter_by_visibility",
|
||||
"required": false,
|
||||
"description": "Filter the results by visibility values: ALL, READ, or READ_WRITE.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "Maximum number of results to return per page. Minimum is 1, maximum is 100, default is 20. Advisory only, may vary.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor for retrieving the next page of results from a previous call. Use this for pagination handling.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListLocationCustomAttributeDefinitions'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "filter_by_visibility",
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
{
|
||||
"name": "ListLocationCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.ListLocationCustomAttributes@0.1.0",
|
||||
"description": "Fetch custom attributes for a specific location.\n\nUse this tool to list custom attributes associated with a specific location. It can also retrieve custom attribute definitions if needed. It includes attributes visible to the requesting app, even if owned by others.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "location_id",
|
||||
"required": true,
|
||||
"description": "The ID of the target location for which to fetch custom attributes.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [location](entity:Location)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"required": false,
|
||||
"description": "Filters custom attribute results based on their visibility values (ALL, READ, READ_WRITE).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to fetch per page. Minimum is 1, maximum is 100, default is 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "String value of the cursor from previous response, used for paginating results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definitions",
|
||||
"required": false,
|
||||
"description": "Set to true to include custom attribute definitions with each custom attribute. Default is false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definitions"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListLocationCustomAttributes'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/locations/{location_id}/custom-attributes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "visibility_filter",
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "with_definitions",
|
||||
"tool_parameter_name": "include_custom_attribute_definitions",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "location_id",
|
||||
"description": "The ID of the target [location](entity:Location).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [location](entity:Location)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
{
|
||||
"name": "ListLoyaltyPromotions",
|
||||
"fully_qualified_name": "SquareupApi.ListLoyaltyPromotions@0.1.0",
|
||||
"description": "Fetches loyalty promotions for a specific program.\n\nUse this tool to retrieve a list of loyalty promotions linked to a specific loyalty program, sorted by their creation date, from newest to oldest.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "loyalty_program_id",
|
||||
"required": true,
|
||||
"description": "The ID of the base loyalty program. Use the 'RetrieveLoyaltyProgram' API with 'main' to get this ID.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "program_id"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_status",
|
||||
"required": false,
|
||||
"description": "Filter loyalty promotions by status. Options: ACTIVE, ENDED, CANCELED, SCHEDULED.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"ENDED",
|
||||
"CANCELED",
|
||||
"SCHEDULED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "status"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor for retrieving the next page of loyalty promotions. Obtain this from the previous response to continue pagination.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Specifies the maximum number of loyalty promotions to return per page. Must be between 1 and 30. Default is 30.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListLoyaltyPromotions'.",
|
||||
"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": [
|
||||
"LOYALTY_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/loyalty/programs/{program_id}/promotions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "status",
|
||||
"tool_parameter_name": "filter_by_status",
|
||||
"description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"ENDED",
|
||||
"CANCELED",
|
||||
"SCHEDULED"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "program_id",
|
||||
"tool_parameter_name": "loyalty_program_id",
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
{
|
||||
"name": "ListMerchantCustomAttributeDefinitions",
|
||||
"fully_qualified_name": "SquareupApi.ListMerchantCustomAttributeDefinitions@0.1.0",
|
||||
"description": "Retrieve custom attribute definitions for a Square seller account.\n\nLists all visible merchant-related custom attribute definitions for a Square seller account, including those created by other applications.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filter_by_visibility",
|
||||
"required": false,
|
||||
"description": "Specify the visibility to filter custom attribute definitions. Options: 'ALL', 'READ', 'READ_WRITE'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Specifies the maximum number of results to return per page. Valid values are between 1 and 100. Defaults to 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Cursor to retrieve the next page of results from a previous API call response.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListMerchantCustomAttributeDefinitions'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "filter_by_visibility",
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
{
|
||||
"name": "ListMerchantCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.ListMerchantCustomAttributes@0.1.0",
|
||||
"description": "Retrieve custom attributes for a specified merchant.\n\nUse this tool to get custom attributes associated with a merchant. You can optionally include definitions of these attributes. The tool returns all attributes visible to the requesting application, including those with read-only or read-write visibility.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "merchant_id",
|
||||
"required": true,
|
||||
"description": "The ID of the target merchant. Use this to specify which merchant's custom attributes you want to retrieve.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [merchant](entity:Merchant)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "merchant_id"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_visibility",
|
||||
"required": false,
|
||||
"description": "Specify how to filter custom attribute definitions by visibility. Options: 'ALL', 'READ', 'READ_WRITE'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Maximum number of results per single paged response. Value must be between 1 and 100, with a default of 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor from the previous response to retrieve the next page of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definitions",
|
||||
"required": false,
|
||||
"description": "Set to `true` to include custom attribute definitions, including their name, description, and data type. Default is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definitions"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListMerchantCustomAttributes'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/merchants/{merchant_id}/custom-attributes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "filter_by_visibility",
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Filters the `CustomAttributeDefinition` results by their `visibility` values."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "with_definitions",
|
||||
"tool_parameter_name": "include_custom_attribute_definitions",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "merchant_id",
|
||||
"tool_parameter_name": "merchant_id",
|
||||
"description": "The ID of the target [merchant](entity:Merchant).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [merchant](entity:Merchant)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
{
|
||||
"name": "ListMerchantDevices",
|
||||
"fully_qualified_name": "SquareupApi.ListMerchantDevices@0.1.0",
|
||||
"description": "Retrieve a list of merchant's connected devices.\n\nCall this tool to obtain a list of devices associated with a merchant, specifically Terminal API devices, using the Squareup service.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor from a previous call to retrieve the next set of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "result_sort_order",
|
||||
"required": false,
|
||||
"description": "Specifies whether to list results from oldest to newest ('ASC') or newest to oldest ('DESC'). Default is 'DESC'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "results_per_page",
|
||||
"required": false,
|
||||
"description": "The number of device results to return in a single API call.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The number of results to return in a single page."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_location_id",
|
||||
"required": false,
|
||||
"description": "Return devices only at the specified location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If present, only returns devices at the target location."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListDevices'.",
|
||||
"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": [
|
||||
"DEVICES_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/devices",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "result_sort_order",
|
||||
"description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "results_per_page",
|
||||
"description": "The number of results to return in a single page.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The number of results to return in a single page."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "filter_by_location_id",
|
||||
"description": "If present, only returns devices at the target location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If present, only returns devices at the target location."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
{
|
||||
"name": "ListOrderCustomAttributeDefinitions",
|
||||
"fully_qualified_name": "SquareupApi.ListOrderCustomAttributeDefinitions@0.1.0",
|
||||
"description": "Retrieve order-related custom attribute definitions for a Square seller.\n\nUse this tool to list all order-related custom attribute definitions for a Square seller account. It includes attributes visible to the requesting application, even those created by other applications, with various visibility settings.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "custom_attribute_visibility_filter",
|
||||
"required": false,
|
||||
"description": "Specifies which custom attributes to return: all, read-only, or read-write.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The cursor from the previous response to get the next page of results. See [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return in a single paged response. Minimum is 1, maximum is 100. Default is 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListOrderCustomAttributeDefinitions'.",
|
||||
"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": [
|
||||
"ORDERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "custom_attribute_visibility_filter",
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
{
|
||||
"name": "ListOrderCustomAttributes",
|
||||
"fully_qualified_name": "SquareupApi.ListOrderCustomAttributes@0.1.0",
|
||||
"description": "Retrieve custom attributes linked to a specific order.\n\nThis tool retrieves custom attribute details for a specified order, including all attributes visible to the requesting application across different visibility settings. It supports fetching custom attribute definitions as well.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "target_order_id",
|
||||
"required": true,
|
||||
"description": "The ID of the specific order for which to retrieve custom attributes.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [order](entity:Order)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "order_id"
|
||||
},
|
||||
{
|
||||
"name": "attribute_visibility_filter",
|
||||
"required": false,
|
||||
"description": "Select which custom attributes to return: 'ALL' for all, 'READ' for read-only, 'READ_WRITE' for read-write attributes.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "visibility_filter"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor from the previous response to retrieve the next page of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return in a single paged response. Accepts an integer between 1 and 100. Default is 20.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "include_custom_attribute_definitions",
|
||||
"required": false,
|
||||
"description": "Set to true to include custom attribute definitions with the order attributes. Default is false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "with_definitions"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListOrderCustomAttributes'.",
|
||||
"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": [
|
||||
"ORDERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/orders/{order_id}/custom-attributes",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "visibility_filter",
|
||||
"tool_parameter_name": "attribute_visibility_filter",
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"ALL",
|
||||
"READ",
|
||||
"READ_WRITE"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "with_definitions",
|
||||
"tool_parameter_name": "include_custom_attribute_definitions",
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "order_id",
|
||||
"tool_parameter_name": "target_order_id",
|
||||
"description": "The ID of the target [order](entity:Order).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the target [order](entity:Order)."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
{
|
||||
"name": "ListPaymentLinks",
|
||||
"fully_qualified_name": "SquareupApi.ListPaymentLinks@0.1.0",
|
||||
"description": "Retrieve all available payment links from Squareup.\n\nUse this tool to list all payment links generated in your Squareup account. It helps in managing and reviewing payment links efficiently.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A string cursor for paginating results. Use it to fetch the next set of results from a previous query. Leave blank to get the first page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "results_per_page_limit",
|
||||
"required": false,
|
||||
"description": "Sets the maximum number of payment links to return per page. Defaults to 100, ignored if negative or exceeds 1000.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListPaymentLinks'.",
|
||||
"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": [
|
||||
"ORDERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/online-checkout/payment-links",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "results_per_page_limit",
|
||||
"description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,431 @@
|
|||
{
|
||||
"name": "ListPaymentRefunds",
|
||||
"fully_qualified_name": "SquareupApi.ListPaymentRefunds@0.1.0",
|
||||
"description": "Retrieve a list of payment refunds for the account.\n\nFetches a list of refunds associated with the account making the request. Suitable for monitoring refund transactions, with a maximum of 100 results per page. Results may take several seconds to update due to eventual consistency.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "start_time_for_refund_retrieval",
|
||||
"required": false,
|
||||
"description": "Start of the time range for retrieving PaymentRefund in RFC 3339 format, based on the created_at field. Defaults to one year ago.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "begin_time"
|
||||
},
|
||||
{
|
||||
"name": "refund_end_time",
|
||||
"required": false,
|
||||
"description": "Specifies the end date and time for the refund retrieval range in RFC 3339 format, defaulting to the current time if not specified.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "end_time"
|
||||
},
|
||||
{
|
||||
"name": "results_sort_order",
|
||||
"required": false,
|
||||
"description": "Set the order for listing results by `PaymentRefund.created_at`. Use 'ASC' for oldest to newest, 'DESC' for newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor from a previous call to retrieve the next set of results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "limit_results_to_location",
|
||||
"required": false,
|
||||
"description": "Specify the location ID to filter results for that location. Defaults to all seller-associated locations.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "refund_status_filter",
|
||||
"required": false,
|
||||
"description": "Filter refunds by specific status. Uses status values defined in PaymentRefund entity. If omitted, all statuses are included.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "status"
|
||||
},
|
||||
{
|
||||
"name": "payment_source_type",
|
||||
"required": false,
|
||||
"description": "Specify the source type of payments to filter refunds. Options: CARD, BANK_ACCOUNT, WALLET, CASH, EXTERNAL. If omitted, all source types are included.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "source_type"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Specify the maximum number of refund results per page, up to a maximum of 100.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "updated_at_start_time",
|
||||
"required": false,
|
||||
"description": "The start of the time range for retrieving refunds, based on the `updated_at` field, in RFC 3339 format. Defaults to `begin_time` if omitted.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: If omitted, the time range starts at `begin_time`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "updated_at_begin_time"
|
||||
},
|
||||
{
|
||||
"name": "updated_at_end_time",
|
||||
"required": false,
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 format. Defaults to the current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: The current time."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "updated_at_end_time"
|
||||
},
|
||||
{
|
||||
"name": "sort_results_by_field",
|
||||
"required": false,
|
||||
"description": "Specifies the field to sort refund results by. Options are 'CREATED_AT' or 'UPDATED_AT'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"CREATED_AT",
|
||||
"UPDATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_field"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListPaymentRefunds'.",
|
||||
"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": [
|
||||
"PAYMENTS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/refunds",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "begin_time",
|
||||
"tool_parameter_name": "start_time_for_refund_retrieval",
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "end_time",
|
||||
"tool_parameter_name": "refund_end_time",
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "results_sort_order",
|
||||
"description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "limit_results_to_location",
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"tool_parameter_name": "refund_status_filter",
|
||||
"description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "source_type",
|
||||
"tool_parameter_name": "payment_source_type",
|
||||
"description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at_begin_time",
|
||||
"tool_parameter_name": "updated_at_start_time",
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: If omitted, the time range starts at `begin_time`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: If omitted, the time range starts at `begin_time`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at_end_time",
|
||||
"tool_parameter_name": "updated_at_end_time",
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: The current time.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339\nformat. The range is determined using the `updated_at` field for each `PaymentRefund`.\n\nDefault: The current time."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_field",
|
||||
"tool_parameter_name": "sort_results_by_field",
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"CREATED_AT",
|
||||
"UPDATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The field used to sort results by. The default is `CREATED_AT`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,203 @@
|
|||
{
|
||||
"name": "ListPayoutEntries",
|
||||
"fully_qualified_name": "SquareupApi.ListPayoutEntries@0.1.0",
|
||||
"description": "Retrieve all payout entries for a specific payout.\n\nFetches a list of all payout entries associated with a particular payout ID. Ideal for obtaining detailed payout information from Square.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "payout_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the payout to retrieve entries for. Essential for identifying the payout for which entries are needed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payout to retrieve the information for."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "payout_id"
|
||||
},
|
||||
{
|
||||
"name": "payout_entries_sort_order",
|
||||
"required": false,
|
||||
"description": "Specifies the order in which payout entries are listed. Use 'DESC' for descending or 'ASC' for ascending order.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which payout entries are listed."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Provide this cursor to retrieve the next set of results for the original query. A pagination cursor from a previous call.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "Sets the maximum number of results to retrieve per page, up to 100. Defaults to 100 if the value exceeds this limit.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`"
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListPayoutEntries'.",
|
||||
"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": null
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/payouts/{payout_id}/payout-entries",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "payout_entries_sort_order",
|
||||
"description": "The order in which payout entries are listed.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The order in which payout entries are listed."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`"
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "payout_id",
|
||||
"tool_parameter_name": "payout_id",
|
||||
"description": "The ID of the payout to retrieve the information for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the payout to retrieve the information for."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
{
|
||||
"name": "ListSellerLocations",
|
||||
"fully_qualified_name": "SquareupApi.ListSellerLocations@0.1.0",
|
||||
"description": "Retrieve details of all seller locations from Square.\n\nCall this tool to get information about all the seller's locations, including inactive ones, retrieved in alphabetical order by name. Useful for managing or displaying seller location data.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListLocations'.",
|
||||
"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": [
|
||||
"MERCHANT_PROFILE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/locations",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,245 @@
|
|||
{
|
||||
"name": "ListSquareCustomers",
|
||||
"fully_qualified_name": "SquareupApi.ListSquareCustomers@0.1.0",
|
||||
"description": "Retrieve customer profiles from a Square account.\n\nUse this tool to obtain a list of customer profiles linked to a Square account. This is helpful for managing and analyzing customer data. Customer profiles may take some time to update, especially during network issues.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "A pagination cursor to retrieve the next set of customer profiles. Use a cursor from a previous query call to fetch subsequent results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "maximum_results_per_page",
|
||||
"required": false,
|
||||
"description": "Specify the maximum number of customer profiles to return in a single page. Must be between 1 and 100, inclusive.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "customer_sorting_field",
|
||||
"required": false,
|
||||
"description": "Specify how customer profiles should be sorted. Options are `DEFAULT` or `CREATED_AT`. Default is `DEFAULT`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"CREATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_field"
|
||||
},
|
||||
{
|
||||
"name": "customer_sort_order",
|
||||
"required": false,
|
||||
"description": "Specifies whether to sort customers in ascending ('ASC') or descending ('DESC') order. Default is 'ASC'.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "sort_order"
|
||||
},
|
||||
{
|
||||
"name": "include_total_customer_count",
|
||||
"required": false,
|
||||
"description": "Set to true to include the total count of customers in the response. The default is false.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "count"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListCustomers'.",
|
||||
"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": [
|
||||
"CUSTOMERS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/customers",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "maximum_results_per_page",
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_field",
|
||||
"tool_parameter_name": "customer_sorting_field",
|
||||
"description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"CREATED_AT"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "sort_order",
|
||||
"tool_parameter_name": "customer_sort_order",
|
||||
"description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": [
|
||||
"DESC",
|
||||
"ASC"
|
||||
],
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "count",
|
||||
"tool_parameter_name": "include_total_customer_count",
|
||||
"description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
{
|
||||
"name": "ListSquareOnlineSites",
|
||||
"fully_qualified_name": "SquareupApi.ListSquareOnlineSites@0.1.0",
|
||||
"description": "Retrieve a list of Square Online sites for a seller.\n\nUse this tool to obtain a list of Square Online sites associated with a seller, ordered by their creation date. This is part of Square's early access program for online APIs.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": []
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListSites'.",
|
||||
"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_SITE_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/sites",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [],
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
{
|
||||
"name": "ListSubscriptionEvents",
|
||||
"fully_qualified_name": "SquareupApi.ListSubscriptionEvents@0.1.0",
|
||||
"description": "Retrieve events for a specific subscription.\n\nCall this tool to retrieve all events related to a specific subscription using the Square API. Useful for tracking changes and updates within a subscription lifecycle.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"required": true,
|
||||
"description": "The unique ID of the subscription to retrieve events for. Use this to specify which subscription's events to list.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription to retrieve the events for."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "subscription_id"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "Specify the cursor to fetch the next set of subscription events if results exceed the limit. Leave unset for the last page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "max_events_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of subscription events to return in a single response page.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The upper limit on the number of subscription events to return\nin a paged response."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListSubscriptionEvents'.",
|
||||
"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": [
|
||||
"SUBSCRIPTIONS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/subscriptions/{subscription_id}/events",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_events_per_page",
|
||||
"description": "The upper limit on the number of subscription events to return\nin a paged response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The upper limit on the number of subscription events to return\nin a paged response."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "subscription_id",
|
||||
"tool_parameter_name": "subscription_id",
|
||||
"description": "The ID of the subscription to retrieve the events for.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The ID of the subscription to retrieve the events for."
|
||||
},
|
||||
"accepted_as": "path",
|
||||
"required": true,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
{
|
||||
"name": "ListTeamMemberBookingProfiles",
|
||||
"fully_qualified_name": "SquareupApi.ListTeamMemberBookingProfiles@0.1.0",
|
||||
"description": "Lists booking profiles for team members.\n\nCall this tool to retrieve booking profiles for all team members, useful for managing schedules and appointments.",
|
||||
"toolkit": {
|
||||
"name": "ArcadeSquareupApi",
|
||||
"description": null,
|
||||
"version": "0.1.0"
|
||||
},
|
||||
"input": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "max_results_per_page",
|
||||
"required": false,
|
||||
"description": "The maximum number of results to return in a paged response. Useful for controlling pagination size.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a paged response."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "limit"
|
||||
},
|
||||
{
|
||||
"name": "pagination_cursor",
|
||||
"required": false,
|
||||
"description": "The pagination cursor for returning the next page of results. Leave empty to get the first page.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "cursor"
|
||||
},
|
||||
{
|
||||
"name": "filter_by_location_id",
|
||||
"required": false,
|
||||
"description": "Specify the location ID to filter team members enabled at that location.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to include only team members enabled at the given location in the returned result."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "location_id"
|
||||
},
|
||||
{
|
||||
"name": "include_only_bookable_team_members",
|
||||
"required": false,
|
||||
"description": "Set to true to include only bookable team members in the result; false to include all members.",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`)."
|
||||
},
|
||||
"inferrable": true,
|
||||
"http_endpoint_parameter_name": "bookable_only"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"description": "Response from the API endpoint 'ListTeamMemberBookingProfiles'.",
|
||||
"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": [
|
||||
"APPOINTMENTS_BUSINESS_SETTINGS_READ"
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": null,
|
||||
"metadata": null
|
||||
},
|
||||
"deprecation_message": null,
|
||||
"metadata": {
|
||||
"object_type": "api_wrapper_tool",
|
||||
"version": "1.0.0",
|
||||
"description": "Tools that enable LLMs to interact directly with the squareup API."
|
||||
},
|
||||
"http_endpoint": {
|
||||
"metadata": {
|
||||
"object_type": "http_endpoint",
|
||||
"version": "1.0.0",
|
||||
"description": ""
|
||||
},
|
||||
"url": "https://connect.squareup.com/v2/bookings/team-member-booking-profiles",
|
||||
"http_method": "GET",
|
||||
"headers": {},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "bookable_only",
|
||||
"tool_parameter_name": "include_only_bookable_team_members",
|
||||
"description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).",
|
||||
"value_schema": {
|
||||
"val_type": "boolean",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`)."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"tool_parameter_name": "max_results_per_page",
|
||||
"description": "The maximum number of results to return in a paged response.",
|
||||
"value_schema": {
|
||||
"val_type": "integer",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The maximum number of results to return in a paged response."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "cursor",
|
||||
"tool_parameter_name": "pagination_cursor",
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"documentation_urls": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"tool_parameter_name": "filter_by_location_id",
|
||||
"description": "Indicates whether to include only team members enabled at the given location in the returned result.",
|
||||
"value_schema": {
|
||||
"val_type": "string",
|
||||
"inner_val_type": null,
|
||||
"enum": null,
|
||||
"properties": null,
|
||||
"inner_properties": null,
|
||||
"description": "Indicates whether to include only team members enabled at the given location in the returned result."
|
||||
},
|
||||
"accepted_as": "query",
|
||||
"required": false,
|
||||
"deprecated": false,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue