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/CreateCustomerGroup.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

241 lines
10 KiB
JSON
Raw Blame History

{
"name": "CreateCustomerGroup",
"fully_qualified_name": "SquareupApi.CreateCustomerGroup@2.0.0",
"description": "Creates a new customer group for a business.\n\nUse this tool to create a new customer group by specifying the group's name. It should be called when a business needs to organize customers into a new group for targeted marketing or management purposes.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "customer_group_name",
"required": true,
"description": "The name of the customer group to be created. It is required for organizing customers into the group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the customer group."
},
"inferrable": true,
"http_endpoint_parameter_name": "group.name"
},
{
"name": "idempotency_key",
"required": false,
"description": "A unique string to ensure the request is processed only once. See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
},
"inferrable": true,
"http_endpoint_parameter_name": "idempotency_key"
},
{
"name": "customer_group_id",
"required": false,
"description": "A unique Square-generated ID for the customer group. This is automatically generated by Square and is used to identify the customer group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique Square-generated ID for the customer group."
},
"inferrable": true,
"http_endpoint_parameter_name": "group.id"
},
{
"name": "group_created_timestamp",
"required": false,
"description": "Specify the timestamp for when the customer group was created, in RFC 3339 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the customer group was created, in RFC 3339 format."
},
"inferrable": true,
"http_endpoint_parameter_name": "group.created_at"
},
{
"name": "group_last_updated_time",
"required": false,
"description": "The timestamp when the customer group was last updated, in RFC 3339 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the customer group was last updated, in RFC 3339 format."
},
"inferrable": true,
"http_endpoint_parameter_name": "group.updated_at"
}
]
},
"output": {
"description": "Response from the API endpoint 'CreateCustomerGroup'.",
"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.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/customers/groups",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "idempotency_key",
"tool_parameter_name": "idempotency_key",
"description": "The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "group.id",
"tool_parameter_name": "customer_group_id",
"description": "A unique Square-generated ID for the customer group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique Square-generated ID for the customer group."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "group.name",
"tool_parameter_name": "customer_group_name",
"description": "The name of the customer group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the customer group."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "group.created_at",
"tool_parameter_name": "group_created_timestamp",
"description": "The timestamp when the customer group was created, in RFC 3339 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the customer group was created, in RFC 3339 format."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "group.updated_at",
"tool_parameter_name": "group_last_updated_time",
"description": "The timestamp when the customer group was last updated, in RFC 3339 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the customer group was last updated, in RFC 3339 format."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Defines the body parameters that can be included in a request to the\\n[CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"group\"\n ],\n \"properties\": {\n \"idempotency_key\": {\n \"type\": \"string\",\n \"description\": \"The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\"\n },\n \"group\": {\n \"type\": \"object\",\n \"description\": \"Represents a group of customer profiles. \\n\\nCustomer groups can be created, be modified, and have their membership defined using \\nthe Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique Square-generated ID for the customer group.\",\n \"maxLength\": 255,\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the customer group.\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the customer group was created, in RFC 3339 format.\",\n \"readOnly\": true\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the customer group was last updated, in RFC 3339 format.\",\n \"readOnly\": true\n }\n }\n }\n },\n \"example\": {\n \"group\": {\n \"name\": \"Loyal Customers\"\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