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

307 lines
14 KiB
JSON
Raw Blame History

{
"name": "UpdateJobDetails",
"fully_qualified_name": "SquareupApi.UpdateJobDetails@2.0.0",
"description": "Update job title or tip eligibility in the system.\n\nUse this tool to update the title or tip eligibility of a job within the system. The changes will affect all related job assignments, shifts, and team member wages associated with the job ID.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "job_id_to_update",
"required": true,
"description": "The unique ID of the job to update. This specifies which job's title or tip eligibility you want to modify.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the job to update."
},
"inferrable": true,
"http_endpoint_parameter_name": "job_id"
},
{
"name": "job_id",
"required": false,
"description": "The unique Square-assigned ID of the job. Obtainable via ListJobs API or from team member wage settings.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,\ncall [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.\nYou can also get job IDs from a team member's wage setting."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.id"
},
{
"name": "job_title",
"required": false,
"description": "The new title of the job to update.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The title of the job."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.title"
},
{
"name": "job_creation_timestamp",
"required": false,
"description": "The timestamp representing when the job was created, formatted in RFC 3339.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the job was created, in RFC 3339 format."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.created_at"
},
{
"name": "job_last_updated_timestamp",
"required": false,
"description": "The timestamp when the job was last updated, in RFC 3339 format. Used for optimistic concurrency control.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The timestamp when the job was last updated, in RFC 3339 format."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.updated_at"
},
{
"name": "job_version_for_concurrency",
"required": false,
"description": "The current version of the job for optimistic concurrency control. Must match the server version to proceed with updates.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable\n[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\ncontrol and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't\nmatch the server version at the time of the request."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.version"
},
{
"name": "enable_tips_for_job",
"required": false,
"description": "Set to true to allow team members to earn tips for the job, false to prevent them.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether team members can earn tips for the job."
},
"inferrable": true,
"http_endpoint_parameter_name": "job.is_tip_eligible"
}
]
},
"output": {
"description": "Response from the API endpoint 'UpdateJob'.",
"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_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/team-members/jobs/{job_id}",
"http_method": "PUT",
"headers": {},
"parameters": [
{
"name": "job_id",
"tool_parameter_name": "job_id_to_update",
"description": "The ID of the job to update.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the job to update."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.id",
"tool_parameter_name": "job_id",
"description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,\ncall [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.\nYou can also get job IDs from a team member's wage setting.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,\ncall [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.\nYou can also get job IDs from a team member's wage setting."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.title",
"tool_parameter_name": "job_title",
"description": "The title of the job.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The title of the job."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.is_tip_eligible",
"tool_parameter_name": "enable_tips_for_job",
"description": "Indicates whether team members can earn tips for the job.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether team members can earn tips for the job."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.created_at",
"tool_parameter_name": "job_creation_timestamp",
"description": "The timestamp when the job 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 job was created, in RFC 3339 format."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.updated_at",
"tool_parameter_name": "job_last_updated_timestamp",
"description": "The timestamp when the job 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 job was last updated, in RFC 3339 format."
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "job.version",
"tool_parameter_name": "job_version_for_concurrency",
"description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable\n[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\ncontrol and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't\nmatch the server version at the time of the request.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable\n[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\ncontrol and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't\nmatch the server version at the time of the 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 \"description\": \"Represents an [UpdateJob](api-endpoint:Team-UpdateJob) request.\",\n \"x-release-status\": \"BETA\",\n \"required\": [\n \"job\"\n ],\n \"properties\": {\n \"job\": {\n \"type\": \"object\",\n \"description\": \"Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the\\njob's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment)\\nin a team member's wage setting.\",\n \"x-release-status\": \"BETA\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,\\ncall [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.\\nYou can also get job IDs from a team member's wage setting.\"\n },\n \"title\": {\n \"type\": \"string\",\n \"description\": \"The title of the job.\",\n \"maxLength\": 150,\n \"nullable\": true\n },\n \"is_tip_eligible\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether team members can earn tips for the job.\",\n \"nullable\": true\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the job was created, in RFC 3339 format.\",\n \"readOnly\": true\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the job was last updated, in RFC 3339 format.\",\n \"readOnly\": true\n },\n \"version\": {\n \"type\": \"integer\",\n \"description\": \"**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable\\n[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\\ncontrol and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't\\nmatch the server version at the time of the request.\"\n }\n }\n }\n },\n \"example\": {\n \"job\": {\n \"is_tip_eligible\": true,\n \"title\": \"Cashier 1\"\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