@fourier-labs/harbour-contracts 0.73.0 → 0.76.0

package/schema/integration-execute-result.schema.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://schemas.harbour.dev/integration-execute-result.schema.json",
   "title": "IntegrationExecuteResult",
-  "description": "The `data` member of a successful execute response `{data, requestId}`; the SDK unwraps `data`. Exactly one of the operation results (twelve operations since 0.71.0, ADR 0018): slack.channel.history -> {messages, hasMore, nextCursor?} (plain text/IDs/time, plus the display name and emoji icon a per-app-named app post carries \u2014 authorName/authorIcon, 0.55.0 \u2014 never the provider payload; `nextCursor` when hasMore, to pass as the next read's `cursor`); slack.message.post, slack.message.update, slack.message.delete -> {messageId} (the Slack ts); slack.dm.send -> {messageId, channelId} (the ts and the DM channel it went to); slack.user.lookup -> {userId, displayName}; gmail.thread.list -> {threads, hasMore, nextPageToken?} (newest matching threads; each `messageId` is the thread's newest message, what gmail.message.read takes; `nextPageToken` when hasMore); gmail.thread.read -> {id, emails} (every message of the thread, oldest first, each shaped like a gmail.message.read result); gmail.message.read -> {id, threadId, subject, from, to, date, text, truncated, attachments?} (headers plus the plain text with html stripped, cut at 16 KiB with `truncated` set; `attachments` lists the files without their bytes, which gmail.attachment.read fetches by id); gmail.attachment.read -> {filename, mimeType, size, dataBase64}; gmail.message.send -> {messageId, threadId} (the Gmail ids of the sent message and its thread); warehouse.view.read -> {rows, truncated} (rows keyed by the selected columns, or for an aggregate read by the groupBy columns then the aggregate aliases; decimal/64-bit values as strings, dates as ISO strings; since 0.70.0 every server sends `truncated`, true when more rows matched than `limit` \u2014 the server reads limit+1 rows to know \u2014 so the rows are incomplete and must not be totalled or averaged; a server before 0.70.0 omitted it). An unknown send outcome is never a result; it is an error with details.code SEND_OUTCOME_UNKNOWN. A whole result over 1 MiB is rejected, never cut down to fit \u2014 except a gmail.attachment.read, whose single attachment is bounded by its own 2 MiB.",
+  "description": "The `data` member of a successful execute response `{data, requestId}`; the SDK unwraps `data`. Exactly one of the operation results (twenty-four operations since 0.76.0, ADR 0018 and ADR 0022): slack.channel.history -> {messages, hasMore, nextCursor?} (plain text/IDs/time, plus the display name and emoji icon a per-app-named app post carries \u2014 authorName/authorIcon, 0.55.0 \u2014 never the provider payload; `nextCursor` when hasMore, to pass as the next read's `cursor`); slack.message.post, slack.message.update, slack.message.delete -> {messageId} (the Slack ts); slack.dm.send -> {messageId, channelId} (the ts and the DM channel it went to); slack.user.lookup -> {userId, displayName}; gmail.thread.list -> {threads, hasMore, nextPageToken?} (newest matching threads; each `messageId` is the thread's newest message, what gmail.message.read takes; `nextPageToken` when hasMore); gmail.thread.read -> {id, emails} (every message of the thread, oldest first, each shaped like a gmail.message.read result); gmail.message.read -> {id, threadId, subject, from, to, date, text, truncated, attachments?} (headers plus the plain text with html stripped, cut at 16 KiB with `truncated` set; `attachments` lists the files without their bytes, which gmail.attachment.read fetches by id); gmail.attachment.read -> {filename, mimeType, size, dataBase64}; gmail.message.send -> {messageId, threadId} (the Gmail ids of the sent message and its thread); warehouse.view.read -> {rows, truncated} (rows keyed by the selected columns, or for an aggregate read by the groupBy columns then the aggregate aliases; decimal/64-bit values as strings, dates as ISO strings; since 0.70.0 every server sends `truncated`, true when more rows matched than `limit` \u2014 the server reads limit+1 rows to know \u2014 so the rows are incomplete and must not be totalled or averaged; a server before 0.70.0 omitted it). Basecamp (0.76.0, ADR 0022; every id a string of digits, every page at most 100 items, `nextPageToken` only when hasMore, text cut at 16 KiB like Gmail): basecamp.project.list -> {projects, hasMore, nextPageToken?}; basecamp.todolist.list -> {todolists, hasMore, nextPageToken?}; basecamp.todo.list -> {todos, hasMore, nextPageToken?}; basecamp.message.list -> {boardMessages, hasMore, nextPageToken?} (`boardMessages`, not `messages`, which is the Slack history shape); basecamp.comment.list -> {comments, hasMore, nextPageToken?}; basecamp.people.list -> {people, hasMore, nextPageToken?}; basecamp.todo.create, basecamp.message.post, basecamp.comment.post, basecamp.campfire.post -> {id, appUrl} (the new recording and its Basecamp page); basecamp.todo.complete -> {id, completed} with completed always true. An unknown send outcome is never a result; it is an error with details.code SEND_OUTCOME_UNKNOWN. A whole result over 1 MiB is rejected, never cut down to fit \u2014 except a gmail.attachment.read, whose single attachment is bounded by its own 2 MiB.",
   "type": "object",
   "additionalProperties": false,
   "properties": {
@@ -90,6 +90,10 @@
       "type": "boolean",
       "description": "gmail.message.read: the text was cut at 16 KiB. warehouse.view.read (0.70.0): more rows matched than the read's limit, so `rows` is incomplete."
     },
+    "sample": {
+      "type": "boolean",
+      "description": "warehouse.view.read (0.74.0): true when `rows` came from the app's sample rows (integration-execute-request.sampleRows) because the development read had no development copy of the source; the rows were never read from the source. Absent or false: the rows came from the source."
+    },
     "attachments": {
       "type": "array",
       "maxItems": 100,
@@ -135,6 +139,65 @@
         "description": "One row keyed by the selected column names, or by the groupBy columns then the aggregate aliases."
       }
     },
+    "projects": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampProject"
+      },
+      "description": "basecamp.project.list (0.76.0): one page of the pinned account's projects the signed-in person can see."
+    },
+    "todolists": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampTodolist"
+      },
+      "description": "basecamp.todolist.list (0.76.0): one page of the project's to-do lists."
+    },
+    "todos": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampTodo"
+      },
+      "description": "basecamp.todo.list (0.76.0): one page of the list's open to-dos, or its completed ones when the read said `completed`."
+    },
+    "boardMessages": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampMessage"
+      },
+      "description": "basecamp.message.list (0.76.0): one page of the project's message board, newest first. Named apart from `messages`, the Slack history shape."
+    },
+    "comments": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampComment"
+      },
+      "description": "basecamp.comment.list (0.76.0): one page of the recording's comments, oldest first."
+    },
+    "people": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "#/definitions/BasecampPerson"
+      },
+      "description": "basecamp.people.list (0.76.0): one page of the people on the project."
+    },
+    "appUrl": {
+      "type": "string",
+      "format": "uri",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "basecamp.todo.create / basecamp.message.post / basecamp.comment.post / basecamp.campfire.post (0.76.0): the Basecamp page of the new recording, for a person to open."
+    },
+    "completed": {
+      "type": "boolean",
+      "description": "basecamp.todo.complete (0.76.0): always true; the to-do is complete whether this call or an earlier one completed it."
+    },
     "status": {
       "type": "integer"
     },
@@ -248,9 +311,102 @@
       "propertyNames": {
         "enum": [
           "rows",
-          "truncated"
+          "truncated",
+          "sample"
+        ]
+      }
+    },
+    {
+      "required": [
+        "projects",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "projects",
+          "hasMore",
+          "nextPageToken"
+        ]
+      }
+    },
+    {
+      "required": [
+        "todolists",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "todolists",
+          "hasMore",
+          "nextPageToken"
+        ]
+      }
+    },
+    {
+      "required": [
+        "todos",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "todos",
+          "hasMore",
+          "nextPageToken"
+        ]
+      }
+    },
+    {
+      "required": [
+        "boardMessages",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "boardMessages",
+          "hasMore",
+          "nextPageToken"
+        ]
+      }
+    },
+    {
+      "required": [
+        "comments",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "comments",
+          "hasMore",
+          "nextPageToken"
+        ]
+      }
+    },
+    {
+      "required": [
+        "people",
+        "hasMore"
+      ],
+      "propertyNames": {
+        "enum": [
+          "people",
+          "hasMore",
+          "nextPageToken"
         ]
       }
+    },
+    {
+      "required": [
+        "id",
+        "appUrl"
+      ],
+      "maxProperties": 2
+    },
+    {
+      "required": [
+        "id",
+        "completed"
+      ],
+      "maxProperties": 2
     }
   ],
   "definitions": {
@@ -422,6 +578,280 @@
           "description": "The emoji shortcode such a post carries as its icon (0.55.0), when it has one; never an image URL."
         }
       }
+    },
+    "BasecampPersonRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name"
+      ],
+      "description": "A person named on a Basecamp recording (0.76.0): an author or an assignee.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256
+        }
+      }
+    },
+    "BasecampTool": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "title"
+      ],
+      "description": "One enabled tool of a Basecamp project (0.76.0), from its dock: `name` is Basecamp's kind (todoset, message_board, chat, schedule, vault, questionnaire, inbox, kanban_board), `title` what the project calls it.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "title": {
+          "type": "string",
+          "maxLength": 256
+        }
+      }
+    },
+    "BasecampProject": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "appUrl",
+        "tools"
+      ],
+      "description": "One Basecamp project of a basecamp.project.list result (0.76.0). `id` is what IT maps a project alias to on the connection.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "appUrl": {
+          "type": "string",
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 2048
+        },
+        "tools": {
+          "type": "array",
+          "maxItems": 32,
+          "items": {
+            "$ref": "#/definitions/BasecampTool"
+          }
+        }
+      }
+    },
+    "BasecampTodolist": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "completedRatio",
+        "appUrl"
+      ],
+      "description": "One to-do list of a basecamp.todolist.list result (0.76.0); `id` is what basecamp.todo.list and basecamp.todo.create take as `todolistId`.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "completedRatio": {
+          "type": "string",
+          "maxLength": 32,
+          "description": "Basecamp's `completed_ratio`, e.g. `3/10`."
+        },
+        "appUrl": {
+          "type": "string",
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 2048
+        }
+      }
+    },
+    "BasecampTodo": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "content",
+        "description",
+        "completed",
+        "assignees",
+        "appUrl",
+        "createdAt"
+      ],
+      "description": "One to-do of a basecamp.todo.list result (0.76.0): `content` is its title, `description` its notes as plain text (empty when none), each cut at 16 KiB.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "content": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "completed": {
+          "type": "boolean"
+        },
+        "dueOn": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+        },
+        "assignees": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "$ref": "#/definitions/BasecampPersonRef"
+          }
+        },
+        "appUrl": {
+          "type": "string",
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 2048
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "BasecampMessage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "subject",
+        "content",
+        "author",
+        "createdAt",
+        "appUrl",
+        "commentsCount"
+      ],
+      "description": "One message-board post of a basecamp.message.list result (0.76.0); `content` is plain text cut at 16 KiB; `id` is a recordingId for basecamp.comment.list and basecamp.comment.post.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "subject": {
+          "type": "string",
+          "maxLength": 2048
+        },
+        "content": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "author": {
+          "$ref": "#/definitions/BasecampPersonRef"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "appUrl": {
+          "type": "string",
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 2048
+        },
+        "commentsCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "BasecampComment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "content",
+        "author",
+        "createdAt",
+        "appUrl"
+      ],
+      "description": "One comment of a basecamp.comment.list result (0.76.0); `content` is plain text cut at 16 KiB.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "content": {
+          "type": "string",
+          "maxLength": 16384
+        },
+        "author": {
+          "$ref": "#/definitions/BasecampPersonRef"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "appUrl": {
+          "type": "string",
+          "format": "uri",
+          "minLength": 1,
+          "maxLength": 2048
+        }
+      }
+    },
+    "BasecampPerson": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "admin"
+      ],
+      "description": "One person of a basecamp.people.list result (0.76.0); `id` is what basecamp.todo.create takes in `assigneeIds`. `email` and `title` when Basecamp shows them.",
+      "properties": {
+        "id": {
+          "$ref": "app-integrations-declaration.schema.json#/definitions/BasecampId"
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "email": {
+          "type": "string",
+          "maxLength": 254
+        },
+        "title": {
+          "type": "string",
+          "maxLength": 256
+        },
+        "admin": {
+          "type": "boolean",
+          "description": "Whether the person is an administrator of the Basecamp account."
+        }
+      }
     }
   },
   "examples": [
@@ -579,6 +1009,132 @@
       "mimeType": "application/pdf",
       "size": 20,
       "dataBase64": "JVBERi0xLjQKJcOkw7zDtsOfCg=="
+    },
+    {
+      "rows": [
+        {
+          "week": "2026-W36",
+          "total": "1234.50"
+        }
+      ],
+      "truncated": false,
+      "sample": true
+    },
+    {
+      "projects": [
+        {
+          "id": "2085958499",
+          "name": "Launch",
+          "description": "Everything for the October launch.",
+          "appUrl": "https://3.basecamp.com/195539477/projects/2085958499",
+          "tools": [
+            {
+              "id": "1069479338",
+              "name": "todoset",
+              "title": "To-dos"
+            },
+            {
+              "id": "1069479339",
+              "name": "message_board",
+              "title": "Message Board"
+            },
+            {
+              "id": "1069479340",
+              "name": "chat",
+              "title": "Campfire"
+            }
+          ]
+        }
+      ],
+      "hasMore": false
+    },
+    {
+      "todolists": [
+        {
+          "id": "1069479520",
+          "name": "Week 42",
+          "completedRatio": "3/10",
+          "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/todolists/1069479520"
+        }
+      ],
+      "hasMore": true,
+      "nextPageToken": "2"
+    },
+    {
+      "todos": [
+        {
+          "id": "1069479526",
+          "content": "Ship the weekly report",
+          "description": "Attach the PDF to the message board post.",
+          "completed": false,
+          "dueOn": "2026-10-17",
+          "assignees": [
+            {
+              "id": "1049715914",
+              "name": "Jane Doe"
+            }
+          ],
+          "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/todos/1069479526",
+          "createdAt": "2026-10-11T08:00:00Z"
+        }
+      ],
+      "hasMore": false
+    },
+    {
+      "boardMessages": [
+        {
+          "id": "1069479530",
+          "subject": "Weekly report",
+          "content": "The weekly report is attached.",
+          "author": {
+            "id": "1049715914",
+            "name": "Jane Doe"
+          },
+          "createdAt": "2026-10-11T08:00:00Z",
+          "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/messages/1069479530",
+          "commentsCount": 1
+        }
+      ],
+      "hasMore": false
+    },
+    {
+      "comments": [
+        {
+          "id": "1069479531",
+          "content": "Shipped, thanks.",
+          "author": {
+            "id": "1049715915",
+            "name": "Sam Lee"
+          },
+          "createdAt": "2026-10-11T09:00:00Z",
+          "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/messages/1069479530#__recording_1069479531"
+        }
+      ],
+      "hasMore": false
+    },
+    {
+      "people": [
+        {
+          "id": "1049715914",
+          "name": "Jane Doe",
+          "email": "jane@example.com",
+          "title": "Product",
+          "admin": true
+        }
+      ],
+      "hasMore": false
+    },
+    {
+      "id": "1069479526",
+      "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/todos/1069479526"
+    },
+    {
+      "id": "1069479540",
+      "appUrl": "https://3.basecamp.com/195539477/buckets/2085958499/chats/1069479340@1069479540"
+    },
+    {
+      "id": "1069479526",
+      "completed": true
     }
   ]
 }