admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/SearchTerminalCheckouts.json
jottakka f2332a7682
[Moar][Rewrapping] Rewrapping tools (#653) 
## Rewrapping

- Calendly
- Airtable
- Squareup
- PagerDuty
- Trello
- Miro

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-24 18:05:33 -03:00

313 lines
16 KiB
JSON
Raw Blame History

{
"name": "SearchTerminalCheckouts",
"fully_qualified_name": "SquareupApi.SearchTerminalCheckouts@2.0.0",
"description": "Retrieve filtered Terminal checkout requests for the merchant.\n\nThis tool returns a filtered list of Terminal checkout requests created specifically by the application making the request. It should be called when there's a need to access Terminal checkout requests for the merchant associated with the OAuth token. Requests are available for 30 days.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "device_id_filter",
"required": false,
"description": "Filters TerminalCheckout objects associated with a specific device. Omitting this shows checkouts for all devices.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all\n`TerminalCheckout` objects for the merchant are displayed."
},
"inferrable": true,
"http_endpoint_parameter_name": "query.filter.device_id"
},
{
"name": "start_time_range",
"required": false,
"description": "The start datetime for the TerminalCheckout search in RFC 3339 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"inferrable": true,
"http_endpoint_parameter_name": "query.filter.created_at.start_at"
},
{
"name": "end_time_rfc3339",
"required": false,
"description": "A datetime in RFC 3339 format indicating when the time range ends.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
},
"inferrable": true,
"http_endpoint_parameter_name": "query.filter.created_at.end_at"
},
{
"name": "checkout_status_filter",
"required": false,
"description": "Specify the desired status to filter TerminalCheckout results. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filtered results with the desired status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`"
},
"inferrable": true,
"http_endpoint_parameter_name": "query.filter.status"
},
{
"name": "result_sort_order",
"required": false,
"description": "Specifies the order (DESC or ASC) for results in a request, such as chronological or alphabetical.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DESC",
"ASC"
],
"properties": null,
"inner_properties": null,
"description": "The order (e.g., chronological or alphabetical) in which results from a request are returned."
},
"inferrable": true,
"http_endpoint_parameter_name": "query.sort.sort_order"
},
{
"name": "pagination_cursor",
"required": false,
"description": "A pagination cursor from a previous call, used to fetch the next set of results for the same query. Useful for traversing paginated 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_limit",
"required": false,
"description": "Maximum number of results to return in a single request.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Limits the number of results returned for a single request."
},
"inferrable": true,
"http_endpoint_parameter_name": "limit"
}
]
},
"output": {
"description": "Response from the API endpoint 'SearchTerminalCheckouts'.",
"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.1.0",
"description": "Tools that enable LLMs to interact directly with the squareup API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://connect.squareup.com/v2/terminals/checkouts/search",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "query.filter.device_id",
"tool_parameter_name": "device_id_filter",
"description": "The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all\n`TerminalCheckout` objects for the merchant are displayed.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all\n`TerminalCheckout` objects for the merchant are displayed."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "query.filter.created_at.start_at",
"tool_parameter_name": "start_time_range",
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "query.filter.created_at.end_at",
"tool_parameter_name": "end_time_rfc3339",
"description": "A datetime value in RFC 3339 format indicating when the time range\nends.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "query.filter.status",
"tool_parameter_name": "checkout_status_filter",
"description": "Filtered results with the desired status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filtered results with the desired status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "query.sort.sort_order",
"tool_parameter_name": "result_sort_order",
"description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DESC",
"ASC"
],
"properties": null,
"inner_properties": null,
"description": "The order (e.g., chronological or alphabetical) in which results from a request are returned."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"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.\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": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "limit",
"tool_parameter_name": "result_limit",
"description": "Limits the number of results returned for a single request.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Limits the number of results returned for a single request."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"query\": {\n \"type\": \"object\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"filter\": {\n \"type\": \"object\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"device_id\": {\n \"type\": \"string\",\n \"description\": \"The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all\\n`TerminalCheckout` objects for the merchant are displayed.\",\n \"nullable\": true\n },\n \"created_at\": {\n \"type\": \"object\",\n \"description\": \"Represents a generic time range. The start and end values are\\nrepresented in RFC 3339 format. Time ranges are customized to be\\ninclusive or exclusive based on the needs of a particular endpoint.\\nRefer to the relevant endpoint-specific documentation to determine\\nhow time ranges are handled.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nstarts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nends.\",\n \"nullable\": true\n }\n }\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"Filtered results with the desired status of the `TerminalCheckout`.\\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`\",\n \"nullable\": true\n }\n }\n },\n \"sort\": {\n \"type\": \"object\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"sort_order\": {\n \"type\": \"string\",\n \"enum\": [\n \"DESC\",\n \"ASC\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"DESC\",\n \"description\": \"The results are returned in descending (e.g., newest-first or Z-A) order.\"\n },\n {\n \"name\": \"ASC\",\n \"description\": \"The results are returned in ascending (e.g., oldest-first or A-Z) order.\"\n }\n ],\n \"description\": \"The order (e.g., chronological or alphabetical) in which results from a request are returned.\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n }\n }\n },\n \"cursor\": {\n \"type\": \"string\",\n \"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.\"\n },\n \"limit\": {\n \"type\": \"integer\",\n \"description\": \"Limits the number of results returned for a single request.\",\n \"minimum\": 1,\n \"maximum\": 100\n }\n },\n \"example\": {\n \"limit\": 2,\n \"query\": {\n \"filter\": {\n \"status\": \"COMPLETED\"\n }\n }\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}
Reference in a new issue View git blame Copy permalink