From 709b028fcf38d8d04478965909eceb9bc8add261 Mon Sep 17 00:00:00 2001 From: Amadeo Pellicce Date: Thu, 23 Jan 2025 15:06:33 -0800 Subject: [PATCH 1/5] filepicker APIs --- README.md | 2 +- sdks/sdk-openint/openint.oas.json | 5867 ++++++++++++++--------- sdks/sdk-openint/openint.oas.types.d.ts | 6 - sdks/sdk-openint/package.json | 2 +- 4 files changed, 3624 insertions(+), 2253 deletions(-) diff --git a/README.md b/README.md index c960441..98feb41 100644 --- a/README.md +++ b/README.md @@ -463,9 +463,9 @@ On the other hand OpenSDKs is most valuable when you are working with multiple 3 Or use this single command ``` +cp -r ../repo/kits/sdk/openapi.json sdks/sdk-openint/openint.oas.json && \ SDK=sdk-openint && \ turbo run build --filter 'cli' && \ -turbo run download --filter $SDK && \ turbo run generate --filter $SDK && \ turbo run build --filter $SDK ``` diff --git a/sdks/sdk-openint/openint.oas.json b/sdks/sdk-openint/openint.oas.json index b89cf93..309aa49 100644 --- a/sdks/sdk-openint/openint.oas.json +++ b/sdks/sdk-openint/openint.oas.json @@ -1,125 +1,15 @@ { "openapi": "3.1.0", - "info": {"title": "OpenInt OpenAPI", "version": "0.0.0"}, - "servers": [{"url": "https://api.openint.dev/v0"}], + "info": { + "title": "OpenInt OpenAPI", + "version": "0.0.0" + }, + "servers": [ + { + "url": "https://api.openint.dev/v0" + } + ], "paths": { - "/health": { - "get": { - "operationId": "health", - "summary": "Health check", - "tags": ["Internal"], - "parameters": [ - {"in": "query", "name": "exp", "schema": {"type": "boolean"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "healthy": {"type": "boolean"}, - "error": {"type": "string"}, - "deps": { - "type": "object", - "properties": { - "nango": {"type": "boolean"}, - "inngest": {"type": "boolean"}, - "clerk": {"type": "boolean"} - }, - "required": ["nango", "inngest", "clerk"] - } - }, - "required": ["healthy"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/clerk-testing-token": { - "get": { - "operationId": "createClerkTestingToken", - "summary": "Create clerk testing token", - "tags": ["Internal"], - "parameters": [ - { - "in": "query", - "name": "secret", - "schema": {"type": "string"}, - "required": true - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {"testing_token": {"type": "string"}}, - "required": ["testing_token"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, "/connect/token": { "post": { "operationId": "createConnectToken", @@ -154,7 +44,11 @@ "application/json": { "schema": { "type": "object", - "properties": {"token": {"type": "string"}}, + "properties": { + "token": { + "type": "string" + } + }, "required": ["token"] } } @@ -164,7 +58,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -219,6 +115,10 @@ "type": ["string", "null"], "description": "Filter integrations by comma separated integration ids" }, + "connectionId": { + "type": ["string", "null"], + "description": "Filter managed connections by connection id" + }, "theme": { "type": ["string", "null"], "enum": ["light", "dark"], @@ -233,16 +133,7 @@ "add-deeplink" ], "description": "Magic Link tab view" - }, - "connectorConfigDisplayName": { - "type": ["string", "null"], - "description": "Filter connector config by displayName " - }, - "connectorConfigId": { - "type": "string", - "description": "Must start with 'ccfg_'" - }, - "showExisting": {"type": "boolean", "default": true} + } } } } @@ -255,7 +146,11 @@ "application/json": { "schema": { "type": "object", - "properties": {"url": {"type": "string"}}, + "properties": { + "url": { + "type": "string" + } + }, "required": ["url"] } } @@ -265,7 +160,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -282,24 +179,115 @@ } } }, - "/core/customer/{id}": { - "put": { - "operationId": "upsertCustomer", - "summary": "Upsert customer", - "tags": ["Core"], - "parameters": [ - { - "in": "path", - "name": "id", - "schema": {"type": "string"}, - "required": true - } - ], + "/connect/file-picker": { + "post": { + "operationId": "createFilePickerLink", + "summary": "Create file picker link", + "tags": ["Connect"], "requestBody": { "required": true, "content": { "application/json": { - "schema": {"type": "object", "properties": {"metadata": {}}} + "schema": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "minLength": 1, + "description": "Anything that uniquely identifies the customer that you will be sending the magic link to" + }, + "validityInSeconds": { + "type": "number", + "default": 2592000, + "description": "How long the magic link will be valid for (in seconds) before it expires" + }, + "theme": { + "type": ["string", "null"], + "enum": ["light", "dark"] + }, + "multiSelect": { + "type": ["boolean", "null"] + }, + "folderSelect": { + "type": ["boolean", "null"] + }, + "themeColors": { + "type": ["object", "null"], + "properties": { + "accent": { + "type": ["string", "null"] + }, + "background": { + "type": ["string", "null"] + }, + "border": { + "type": ["string", "null"] + }, + "button": { + "type": ["string", "null"] + }, + "buttonLight": { + "type": ["string", "null"] + }, + "buttonForeground": { + "type": ["string", "null"] + }, + "buttonHover": { + "type": ["string", "null"] + }, + "buttonStroke": { + "type": ["string", "null"] + }, + "buttonSecondary": { + "type": ["string", "null"] + }, + "buttonSecondaryForeground": { + "type": ["string", "null"] + }, + "buttonSecondaryStroke": { + "type": ["string", "null"] + }, + "buttonSecondaryHover": { + "type": ["string", "null"] + }, + "card": { + "type": ["string", "null"] + }, + "cardForeground": { + "type": ["string", "null"] + }, + "foreground": { + "type": ["string", "null"] + }, + "navbar": { + "type": ["string", "null"] + }, + "primary": { + "type": ["string", "null"] + }, + "primaryForeground": { + "type": ["string", "null"] + }, + "secondary": { + "type": ["string", "null"] + }, + "secondaryForeground": { + "type": ["string", "null"] + }, + "sidebar": { + "type": ["string", "null"] + }, + "tab": { + "type": ["string", "null"] + } + } + }, + "connectionId": { + "type": "string" + } + }, + "required": ["connectionId"] + } } } }, @@ -311,82 +299,24 @@ "schema": { "type": "object", "properties": { - "id": {"type": "string"}, - "orgId": {"type": "string"}, - "metadata": {} + "url": { + "type": "string" + } }, - "required": ["id", "orgId"] + "required": ["url"] } } } }, "400": { "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + "$ref": "#/components/schemas/error.BAD_REQUEST" } } } - } - } - } - }, - "/passthrough": { - "post": { - "operationId": "passthrough", - "summary": "Passthrough", - "tags": ["Internal"], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "method": { - "type": "string", - "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"] - }, - "path": {"type": "string"}, - "query": {"type": "object", "additionalProperties": {}}, - "headers": {"type": "object", "additionalProperties": {}}, - "body": {"type": "object", "additionalProperties": {}} - }, - "required": ["method", "path"] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", - "content": {"application/json": {"schema": {}}} - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } }, "500": { "description": "Internal server error", @@ -401,19 +331,17 @@ } } }, - "/core/connection/{id}/source_sync": { - "post": { - "operationId": "sourceSync", - "summary": "Source sync", - "description": "Return records that would have otherwise been emitted during a sync and return it instead", - "tags": ["Internal"], + "/core/customer/{id}": { + "put": { + "operationId": "upsertCustomer", + "summary": "Upsert customer", + "tags": ["Core"], "parameters": [ { "in": "path", "name": "id", "schema": { - "type": "string", - "description": "Must start with 'conn_'" + "type": "string" }, "required": true } @@ -425,11 +353,7 @@ "schema": { "type": "object", "properties": { - "state": {"type": "object", "additionalProperties": {}}, - "streams": { - "type": "object", - "additionalProperties": {"type": "boolean"} - } + "metadata": {} } } } @@ -441,8 +365,17 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": {"type": "object", "additionalProperties": {}} + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "orgId": { + "type": "string" + }, + "metadata": {} + }, + "required": ["id", "orgId"] } } } @@ -451,7 +384,19 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -488,11 +433,18 @@ "type": ["object", "null"], "additionalProperties": {} }, - "displayName": {"type": ["string", "null"]}, - "customerId": {"type": ["string", "null"], "minLength": 1}, - "disabled": {"type": "boolean"}, - "metadata": { - "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" + "displayName": { + "type": ["string", "null"] + }, + "customerId": { + "type": ["string", "null"], + "minLength": 1 + }, + "disabled": { + "type": "boolean" + }, + "metadata": { + "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, "integrationId": { "type": ["string", "null"], @@ -507,13 +459,21 @@ "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {"type": "string"}}} + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -534,12 +494,27 @@ "summary": "List connections", "tags": ["Core"], "parameters": [ - {"in": "query", "name": "limit", "schema": {"type": "number"}}, - {"in": "query", "name": "offset", "schema": {"type": "number"}}, + { + "in": "query", + "name": "limit", + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "offset", + "schema": { + "type": "number" + } + }, { "in": "query", "name": "customerId", - "schema": {"type": ["string", "null"], "minLength": 1} + "schema": { + "type": ["string", "null"], + "minLength": 1 + } }, { "in": "query", @@ -552,14 +527,24 @@ { "in": "query", "name": "connectorName", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, { "in": "query", "name": "forceRefresh", - "schema": {"type": "boolean"} + "schema": { + "type": "boolean" + } }, - {"in": "query", "name": "expand", "schema": {"type": "string"}} + { + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -569,7 +554,11 @@ "schema": { "type": "array", "items": { - "allOf": [{"$ref": "#/components/schemas/Connection"}], + "allOf": [ + { + "$ref": "#/components/schemas/Connection" + } + ], "type": "object", "properties": { "integration": { @@ -579,8 +568,13 @@ "type": "string", "description": "Must start with 'int_'" }, - "name": {"type": "string"}, - "logoUrl": {"type": "string", "format": "uri"} + "name": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "format": "uri" + } }, "required": ["id", "name", "logoUrl"] }, @@ -591,8 +585,13 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "name": {"type": "string"}, - "logoUrl": {"type": "string", "format": "uri"} + "name": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "format": "uri" + } }, "required": ["id", "name", "logoUrl"] } @@ -606,7 +605,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -614,7 +615,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -658,12 +661,19 @@ "type": ["object", "null"], "additionalProperties": {} }, - "displayName": {"type": ["string", "null"]}, + "displayName": { + "type": ["string", "null"] + }, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": {"type": "boolean"}, - "customerId": {"type": ["string", "null"], "minLength": 1}, + "disabled": { + "type": "boolean" + }, + "customerId": { + "type": ["string", "null"], + "minLength": 1 + }, "integrationId": { "type": ["string", "null"], "description": "Must start with 'int_'" @@ -678,7 +688,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/Connection"} + "schema": { + "$ref": "#/components/schemas/Connection" + } } } }, @@ -686,7 +698,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -694,7 +708,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -724,14 +740,23 @@ }, "required": true }, - {"in": "query", "name": "skipRevoke", "schema": {"type": "boolean"}} + { + "in": "query", + "name": "skipRevoke", + "schema": { + "type": "boolean" + } + } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { - "schema": {"type": "object", "properties": {}} + "schema": { + "type": "object", + "properties": {} + } } } }, @@ -739,7 +764,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -747,7 +774,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -780,9 +809,17 @@ { "in": "query", "name": "forceRefresh", - "schema": {"type": "boolean"} + "schema": { + "type": "boolean" + } }, - {"in": "query", "name": "expand", "schema": {"type": "string"}} + { + "in": "query", + "name": "expand", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -790,7 +827,11 @@ "content": { "application/json": { "schema": { - "allOf": [{"$ref": "#/components/schemas/Connection"}], + "allOf": [ + { + "$ref": "#/components/schemas/Connection" + } + ], "type": "object", "properties": { "connector_config": { @@ -804,7 +845,9 @@ "type": "string", "description": "Must start with 'org_'" }, - "connectorName": {"type": "string"} + "connectorName": { + "type": "string" + } }, "required": ["id", "orgId", "connectorName"] }, @@ -815,8 +858,13 @@ "type": "string", "description": "Must start with 'int_'" }, - "name": {"type": "string"}, - "logoUrl": {"type": "string", "format": "uri"} + "name": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "format": "uri" + } }, "required": ["id", "name", "logoUrl"] }, @@ -827,8 +875,13 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "name": {"type": "string"}, - "logoUrl": {"type": "string", "format": "uri"} + "name": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "format": "uri" + } }, "required": ["id", "name", "logoUrl"] } @@ -842,7 +895,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -850,7 +905,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -890,11 +947,21 @@ "schema": { "type": "object", "properties": { - "skipCache": {"type": ["boolean", "null"]}, - "import": {"type": ["boolean", "null"]}, - "updateWebhook": {"type": ["boolean", "null"]}, - "sandboxSimulateUpdate": {"type": ["boolean", "null"]}, - "sandboxSimulateDisconnect": {"type": ["boolean", "null"]} + "skipCache": { + "type": ["boolean", "null"] + }, + "import": { + "type": ["boolean", "null"] + }, + "updateWebhook": { + "type": ["boolean", "null"] + }, + "sandboxSimulateUpdate": { + "type": ["boolean", "null"] + }, + "sandboxSimulateDisconnect": { + "type": ["boolean", "null"] + } } } } @@ -903,13 +970,19 @@ "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} + "content": { + "application/json": { + "schema": {} + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -982,14 +1055,20 @@ "schema": { "type": "object", "properties": { - "connection_requested_event_id": {"type": "string"}, + "connection_requested_event_id": { + "type": "string" + }, "pipeline_syncs": { "type": "array", "items": { "type": "object", "properties": { - "pipeline_id": {"type": "string"}, - "sync_completed_event_id": {"type": "string"} + "pipeline_id": { + "type": "string" + }, + "sync_completed_event_id": { + "type": "string" + } }, "required": ["pipeline_id", "sync_completed_event_id"] } @@ -1003,7 +1082,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1032,7 +1113,9 @@ "application/json": { "schema": { "type": "array", - "items": {"$ref": "#/components/schemas/ConnectorConfig"} + "items": { + "$ref": "#/components/schemas/ConnectorConfig" + } } } } @@ -1064,7 +1147,9 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "connectorName": {"type": "string"}, + "connectorName": { + "type": "string" + }, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -1073,17 +1158,23 @@ "type": ["object", "null"], "additionalProperties": {} }, - "displayName": {"type": ["string", "null"]}, + "displayName": { + "type": ["string", "null"] + }, "defaultPipeOut": { "type": ["object", "null"], "properties": { "streams": { "type": ["object", "null"], - "additionalProperties": {"type": "boolean"} + "additionalProperties": { + "type": "boolean" + } }, "links": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/Link"}, + "items": { + "$ref": "#/components/schemas/Link" + }, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "destination_id": { @@ -1098,7 +1189,9 @@ "properties": { "links": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/Link"}, + "items": { + "$ref": "#/components/schemas/Link" + }, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "source_id": { @@ -1125,7 +1218,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/ConnectorConfig"} + "schema": { + "$ref": "#/components/schemas/ConnectorConfig" + } } } }, @@ -1133,7 +1228,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1176,7 +1273,9 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "displayName": {"type": ["string", "null"]}, + "displayName": { + "type": ["string", "null"] + }, "disabled": { "type": "boolean", "title": "Disabled", @@ -1192,7 +1291,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/ConnectorConfig"} + "schema": { + "$ref": "#/components/schemas/ConnectorConfig" + } } } }, @@ -1200,7 +1301,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1208,7 +1311,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -1242,13 +1347,19 @@ "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} + "content": { + "application/json": { + "schema": {} + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1256,7 +1367,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -1292,7 +1405,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/ConnectorConfig"} + "schema": { + "$ref": "#/components/schemas/ConnectorConfig" + } } } }, @@ -1300,7 +1415,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1308,7 +1425,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -1351,7 +1470,9 @@ { "in": "query", "name": "connectorName", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -1368,11 +1489,21 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "envName": {"type": ["string", "null"]}, - "displayName": {"type": ["string", "null"]}, - "connectorName": {"type": "string"}, - "isSource": {"type": "boolean"}, - "isDestination": {"type": "boolean"}, + "envName": { + "type": ["string", "null"] + }, + "displayName": { + "type": ["string", "null"] + }, + "connectorName": { + "type": "string" + }, + "isSource": { + "type": "boolean" + }, + "isDestination": { + "type": "boolean" + }, "verticals": { "type": "array", "items": { @@ -1402,7 +1533,9 @@ }, "integrations": { "type": "array", - "items": {"type": "string"} + "items": { + "type": "string" + } } }, "required": [ @@ -1422,7 +1555,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1430,7 +1565,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -1447,121 +1584,59 @@ } } }, - "/connector": { + "/core/pipeline": { "get": { - "operationId": "listConnectorMetas", - "summary": "List connector metas", - "description": "Get catalog of all available connectors", - "tags": ["Connectors"], + "operationId": "listPipelines", + "summary": "List pipelines", + "tags": ["Core"], "parameters": [ - {"in": "query", "name": "includeOas", "schema": {"type": "boolean"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": {"application/json": {"schema": {}}} - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } + { + "in": "query", + "name": "limit", + "schema": { + "type": "number" } }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } + { + "in": "query", + "name": "offset", + "schema": { + "type": "number" } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } + { + "in": "query", + "name": "connectionIds", + "schema": { + "type": "array", + "items": { + "type": "string", + "description": "Must start with 'conn_'" } } } - } - } - }, - "/connector/{name}": { - "get": { - "operationId": "getConnectorMeta", - "summary": "Get connector meta", - "tags": ["Connectors"], - "parameters": [ - { - "in": "path", - "name": "name", - "schema": {"type": "string"}, - "required": true - }, - {"in": "query", "name": "includeOas", "schema": {"type": "boolean"}} ], "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + "type": "array", + "items": { + "$ref": "#/components/schemas/Pipeline" + } } } } - } - } - } - }, - "/connector/{name}/oas": { - "get": { - "operationId": "getConnectorOpenApiSpec", - "summary": "Get connector open api spec", - "tags": ["Connectors"], - "parameters": [ - { - "in": "path", - "name": "name", - "schema": {"type": "string"}, - "required": true - }, - {"in": "query", "name": "original", "schema": {"type": "boolean"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1569,287 +1644,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/connector/{name}/schemas": { - "get": { - "operationId": "getConnectorSchemas", - "summary": "Get connector schemas", - "tags": ["Connectors"], - "parameters": [ - { - "in": "path", - "name": "name", - "schema": {"type": "string"}, - "required": true - }, - {"in": "query", "name": "type", "schema": {"type": "string"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": {"application/json": {"schema": {}}} - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/connector/{name}/integrations": { - "get": { - "operationId": "listConnectorIntegrations", - "summary": "List connector integrations", - "tags": ["Connectors"], - "parameters": [ - { - "in": "path", - "name": "name", - "schema": {"type": "string"}, - "required": true - }, - { - "in": "query", - "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} - }, - { - "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, - { - "in": "query", - "name": "search_text", - "schema": {"type": ["string", "null"]} - }, - { - "in": "query", - "name": "ccfgId", - "schema": { - "type": "string", - "description": "Must start with 'ccfg_'" - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": { - "type": "array", - "items": {"$ref": "#/components/schemas/core.integration"} - } - }, - "required": ["has_next_page", "items"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/configured_integrations": { - "get": { - "operationId": "listConfiguredIntegrations", - "summary": "List configured integrations", - "tags": ["Connectors"], - "parameters": [ - { - "in": "query", - "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} - }, - { - "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, - {"in": "query", "name": "search_text", "schema": {"type": "string"}}, - { - "in": "query", - "name": "connector_config_ids", - "schema": {"type": "array", "items": {"type": "string"}} - }, - { - "in": "query", - "name": "connectorNames", - "schema": {"type": "array", "items": {"type": "string"}} - }, - { - "in": "query", - "name": "integrationIds", - "schema": {"type": "array", "items": {"type": "string"}} - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/core.configured_integration" - } - } - }, - "required": ["has_next_page", "items"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/core/pipeline": { - "get": { - "operationId": "listPipelines", - "summary": "List pipelines", - "tags": ["Core"], - "parameters": [ - {"in": "query", "name": "limit", "schema": {"type": "number"}}, - {"in": "query", "name": "offset", "schema": {"type": "number"}}, - { - "in": "query", - "name": "connectionIds", - "schema": { - "type": "array", - "items": { - "type": "string", - "description": "Must start with 'conn_'" - } - } - } - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {"$ref": "#/components/schemas/Pipeline"} - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -1883,7 +1680,9 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": {"type": "boolean"}, + "disabled": { + "type": "boolean" + }, "sourceId": { "type": "string", "description": "Must start with 'conn_'" @@ -1893,8 +1692,15 @@ "additionalProperties": { "type": "object", "properties": { - "disabled": {"type": "boolean"}, - "fields": {"type": "array", "items": {"type": "string"}} + "disabled": { + "type": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + } } } }, @@ -1913,7 +1719,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/Pipeline"} + "schema": { + "$ref": "#/components/schemas/Pipeline" + } } } }, @@ -1921,7 +1729,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -1964,14 +1774,23 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": {"type": "boolean"}, + "disabled": { + "type": "boolean" + }, "streams": { "type": ["object", "null"], "additionalProperties": { "type": "object", "properties": { - "disabled": {"type": "boolean"}, - "fields": {"type": "array", "items": {"type": "string"}} + "disabled": { + "type": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + } } } } @@ -1985,7 +1804,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/Pipeline"} + "schema": { + "$ref": "#/components/schemas/Pipeline" + } } } }, @@ -1993,7 +1814,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2001,7 +1824,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2037,7 +1862,10 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"type": "boolean", "enum": [true]} + "schema": { + "type": "boolean", + "enum": [true] + } } } }, @@ -2045,7 +1873,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2053,7 +1883,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2123,7 +1955,10 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"type": "object", "properties": {}} + "schema": { + "type": "object", + "properties": {} + } } } }, @@ -2131,8 +1966,10 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } + } } }, "500": { @@ -2157,29 +1994,47 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", "name": "since", - "schema": {"type": "integer"}, + "schema": { + "type": "integer" + }, "required": true }, { "in": "query", "name": "customerId", - "schema": {"type": ["string", "null"], "minLength": 1} + "schema": { + "type": ["string", "null"], + "minLength": 1 + } }, { "in": "query", "name": "name", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2190,11 +2045,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/Event"} + "items": { + "$ref": "#/components/schemas/Event" + } } }, "required": ["has_next_page", "items"] @@ -2204,251 +2065,23 @@ }, "400": { "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/viewer": { - "get": { - "operationId": "getViewer", - "summary": "Get current viewer accessing the API", - "tags": ["Internal"], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/Viewer"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/viewer/organization": { - "get": { - "operationId": "getCurrentOrganization", - "summary": "Get current organization of viewer accessing the API", - "tags": ["Internal"], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Must start with 'org_'" - }, - "slug": {"type": ["string", "null"]}, - "publicMetadata": { - "type": "object", - "properties": { - "database_url": { - "type": "string", - "title": "PostgreSQL Database URL", - "description": "This is where data from connections are synced to by default", - "example": "postgres://username:password@host:port/database" - }, - "synced_data_schema": { - "type": "string", - "title": "Synced Data Schema", - "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." - }, - "webhook_url": { - "type": "string", - "title": "Webhook URL", - "description": "Events like sync.completed and connection.created can be sent to url of your choosing" - }, - "migrate_tables": { - "type": "boolean", - "title": "Migrate Tables", - "description": "If enabled, table migrations will be run if needed when entities are persisted", - "default": true - } - } - } - }, - "required": ["id", "publicMetadata"] - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - }, - "patch": { - "operationId": "updateCurrentOrganization", - "summary": "Update current organization", - "tags": ["Internal"], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "publicMetadata": { - "type": "object", - "properties": { - "database_url": { - "type": "string", - "title": "PostgreSQL Database URL", - "description": "This is where data from connections are synced to by default", - "example": "postgres://username:password@host:port/database" - }, - "synced_data_schema": { - "type": "string", - "title": "Synced Data Schema", - "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." - }, - "webhook_url": { - "type": "string", - "title": "Webhook URL", - "description": "Events like sync.completed and connection.created can be sent to url of your choosing" - }, - "migrate_tables": { - "type": "boolean", - "title": "Migrate Tables", - "description": "If enabled, table migrations will be run if needed when entities are persisted", - "default": true - } - } - } - }, - "required": ["publicMetadata"] - } - } - } - }, - "responses": { - "200": { - "description": "Successful response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Must start with 'org_'" - }, - "slug": {"type": ["string", "null"]}, - "publicMetadata": { - "type": "object", - "properties": { - "database_url": { - "type": "string", - "title": "PostgreSQL Database URL", - "description": "This is where data from connections are synced to by default", - "example": "postgres://username:password@host:port/database" - }, - "synced_data_schema": { - "type": "string", - "title": "Synced Data Schema", - "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." - }, - "webhook_url": { - "type": "string", - "title": "Webhook URL", - "description": "Events like sync.completed and connection.created can be sent to url of your choosing" - }, - "migrate_tables": { - "type": "boolean", - "title": "Migrate Tables", - "description": "If enabled, table migrations will be run if needed when entities are persisted", - "default": true - } - } - } - }, - "required": ["id", "publicMetadata"] + "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, "404": { "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + "$ref": "#/components/schemas/error.NOT_FOUND" } } } - } - } - } - }, - "/openapi.json": { - "get": { - "operationId": "public-getOpenapiDocument", - "summary": "Get openapi document", - "tags": ["Internal"], - "responses": { - "200": { - "description": "Successful response", - "content": {"application/json": {"schema": {}}} }, "500": { "description": "Internal server error", @@ -2472,7 +2105,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2483,7 +2118,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2500,7 +2137,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2508,7 +2147,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2534,7 +2175,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2545,7 +2188,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2562,7 +2207,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2570,7 +2217,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2596,7 +2245,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2607,7 +2258,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2624,7 +2277,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2632,7 +2287,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2697,7 +2354,11 @@ "properties": { "record": { "type": "object", - "properties": {"id": {"type": "string"}}, + "properties": { + "id": { + "type": "string" + } + }, "required": ["id"] } } @@ -2709,7 +2370,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2735,7 +2398,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2746,7 +2411,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2763,7 +2430,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2771,7 +2440,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2797,7 +2468,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2808,7 +2481,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2825,7 +2500,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2833,7 +2510,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2859,7 +2538,9 @@ { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } } ], "responses": { @@ -2870,7 +2551,9 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": {"type": ["string", "null"]}, + "next_page_cursor": { + "type": ["string", "null"] + }, "items": { "type": "array", "items": { @@ -2887,7 +2570,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -2895,7 +2580,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -2978,7 +2665,11 @@ "properties": { "record": { "type": "object", - "properties": {"id": {"type": "string"}}, + "properties": { + "id": { + "type": "string" + } + }, "required": ["id"] } } @@ -2990,7 +2681,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3037,12 +2730,24 @@ "address": { "type": "object", "properties": { - "city": {"type": ["string", "null"]}, - "country": {"type": ["string", "null"]}, - "postal_code": {"type": ["string", "null"]}, - "state": {"type": ["string", "null"]}, - "street_1": {"type": ["string", "null"]}, - "street_2": {"type": ["string", "null"]} + "city": { + "type": ["string", "null"] + }, + "country": { + "type": ["string", "null"] + }, + "postal_code": { + "type": ["string", "null"] + }, + "state": { + "type": ["string", "null"] + }, + "street_1": { + "type": ["string", "null"] + }, + "street_2": { + "type": ["string", "null"] + } }, "example": { "city": "San Francisco", @@ -3058,7 +2763,9 @@ "items": { "type": "object", "properties": { - "email_address": {"type": "string"}, + "email_address": { + "type": "string" + }, "email_address_type": { "type": ["string", "null"], "enum": ["primary", "personal", "work"] @@ -3078,7 +2785,9 @@ "items": { "type": "object", "properties": { - "phone_number": {"type": "string"}, + "phone_number": { + "type": "string" + }, "phone_number_type": { "type": "string", "enum": [ @@ -3139,7 +2848,11 @@ "properties": { "record": { "type": "object", - "properties": {"id": {"type": "string"}}, + "properties": { + "id": { + "type": "string" + } + }, "required": ["id"] } } @@ -3151,7 +2864,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3177,7 +2892,9 @@ { "in": "path", "name": "entity", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -3188,7 +2905,11 @@ "application/json": { "schema": { "type": "object", - "properties": {"count": {"type": "number"}}, + "properties": { + "count": { + "type": "number" + } + }, "required": ["count"] } } @@ -3198,7 +2919,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3206,7 +2929,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3232,14 +2957,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} - }, + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } + }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -3249,11 +2985,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.account"} + "items": { + "$ref": "#/components/schemas/crm.account" + } } }, "required": ["has_next_page", "items"] @@ -3265,7 +3007,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3273,7 +3017,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3300,7 +3046,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account_input"} + "record": { + "$ref": "#/components/schemas/crm.account_input" + } }, "required": ["record"] } @@ -3315,7 +3063,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account"} + "record": { + "$ref": "#/components/schemas/crm.account" + } }, "required": ["record"] } @@ -3326,7 +3076,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3352,7 +3104,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -3364,7 +3118,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account"}, + "record": { + "$ref": "#/components/schemas/crm.account" + }, "raw": {} }, "required": ["record"] @@ -3376,7 +3132,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3384,7 +3142,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3408,7 +3168,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -3419,7 +3181,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account_input"} + "record": { + "$ref": "#/components/schemas/crm.account_input" + } }, "required": ["record"] } @@ -3434,7 +3198,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account"} + "record": { + "$ref": "#/components/schemas/crm.account" + } }, "required": ["record"] } @@ -3445,7 +3211,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3453,7 +3221,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3482,8 +3252,18 @@ "schema": { "type": "object", "properties": { - "ids": {"type": "array", "items": {"type": "string"}}, - "properties": {"type": "array", "items": {"type": "string"}} + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "array", + "items": { + "type": "string" + } + } }, "required": ["ids", "properties"] } @@ -3497,7 +3277,9 @@ "application/json": { "schema": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.account"} + "items": { + "$ref": "#/components/schemas/crm.account" + } } } } @@ -3506,7 +3288,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3545,13 +3329,17 @@ }, "values": { "type": "array", - "items": {"type": "string"}, + "items": { + "type": "string" + }, "description": "The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown." } }, "required": ["key", "values"] }, - "record": {"$ref": "#/components/schemas/crm.account_input"} + "record": { + "$ref": "#/components/schemas/crm.account_input" + } }, "required": ["upsert_on", "record"] } @@ -3566,7 +3354,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.account"} + "record": { + "$ref": "#/components/schemas/crm.account" + } }, "required": ["record"] } @@ -3577,7 +3367,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3603,14 +3395,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -3620,11 +3423,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.contact"} + "items": { + "$ref": "#/components/schemas/crm.contact" + } } }, "required": ["has_next_page", "items"] @@ -3636,7 +3445,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3644,7 +3455,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3671,7 +3484,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact_input"} + "record": { + "$ref": "#/components/schemas/crm.contact_input" + } }, "required": ["record"] } @@ -3686,7 +3501,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact"} + "record": { + "$ref": "#/components/schemas/crm.contact" + } }, "required": ["record"] } @@ -3697,7 +3514,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3723,7 +3542,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -3735,7 +3556,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact"}, + "record": { + "$ref": "#/components/schemas/crm.contact" + }, "raw": {} }, "required": ["record"] @@ -3747,7 +3570,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3755,7 +3580,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3779,7 +3606,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -3790,7 +3619,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact_input"} + "record": { + "$ref": "#/components/schemas/crm.contact_input" + } }, "required": ["record"] } @@ -3805,7 +3636,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact"} + "record": { + "$ref": "#/components/schemas/crm.contact" + } }, "required": ["record"] } @@ -3816,7 +3649,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3824,7 +3659,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -3853,8 +3690,18 @@ "schema": { "type": "object", "properties": { - "ids": {"type": "array", "items": {"type": "string"}}, - "properties": {"type": "array", "items": {"type": "string"}} + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "array", + "items": { + "type": "string" + } + } }, "required": ["ids", "properties"] } @@ -3868,7 +3715,9 @@ "application/json": { "schema": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.contact"} + "items": { + "$ref": "#/components/schemas/crm.contact" + } } } } @@ -3877,7 +3726,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3916,13 +3767,17 @@ }, "values": { "type": "array", - "items": {"type": "string"}, + "items": { + "type": "string" + }, "description": "The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one record is found that matches, then an error will be thrown." } }, "required": ["key", "values"] }, - "record": {"$ref": "#/components/schemas/crm.contact_input"} + "record": { + "$ref": "#/components/schemas/crm.contact_input" + } }, "required": ["upsert_on", "record"] } @@ -3937,7 +3792,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.contact"} + "record": { + "$ref": "#/components/schemas/crm.contact" + } }, "required": ["record"] } @@ -3948,7 +3805,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -3974,14 +3833,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -3991,11 +3861,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.lead"} + "items": { + "$ref": "#/components/schemas/crm.lead" + } } }, "required": ["has_next_page", "items"] @@ -4007,7 +3883,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4015,7 +3893,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4041,7 +3921,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4053,7 +3935,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.lead"}, + "record": { + "$ref": "#/components/schemas/crm.lead" + }, "raw": {} }, "required": ["record"] @@ -4065,7 +3949,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4073,7 +3959,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4099,14 +3987,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -4116,11 +4015,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.opportunity"} + "items": { + "$ref": "#/components/schemas/crm.opportunity" + } } }, "required": ["has_next_page", "items"] @@ -4132,7 +4037,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4140,7 +4047,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4166,7 +4075,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4178,7 +4089,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.opportunity"}, + "record": { + "$ref": "#/components/schemas/crm.opportunity" + }, "raw": {} }, "required": ["record"] @@ -4190,7 +4103,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4198,7 +4113,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4224,14 +4141,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -4241,11 +4169,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.note"} + "items": { + "$ref": "#/components/schemas/crm.note" + } } }, "required": ["has_next_page", "items"] @@ -4257,7 +4191,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4265,7 +4201,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4292,7 +4230,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.note_input"} + "record": { + "$ref": "#/components/schemas/crm.note_input" + } }, "required": ["record"] } @@ -4307,7 +4247,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.note"} + "record": { + "$ref": "#/components/schemas/crm.note" + } }, "required": ["record"] } @@ -4318,7 +4260,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4344,14 +4288,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -4361,11 +4316,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.user"} + "items": { + "$ref": "#/components/schemas/crm.user" + } } }, "required": ["has_next_page", "items"] @@ -4377,7 +4338,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4385,7 +4348,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4411,7 +4376,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4423,7 +4390,9 @@ "schema": { "type": "object", "properties": { - "record": {"$ref": "#/components/schemas/crm.user"}, + "record": { + "$ref": "#/components/schemas/crm.user" + }, "raw": {} }, "required": ["record"] @@ -4435,7 +4404,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4443,7 +4414,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4469,20 +4442,33 @@ { "in": "path", "name": "object_name", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true }, { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -4492,9 +4478,16 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": {"type": "array", "items": {}} + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": {} + } }, "required": ["has_next_page", "items"] } @@ -4505,7 +4498,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4513,7 +4508,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4537,7 +4534,9 @@ { "in": "path", "name": "object_name", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4548,7 +4547,10 @@ "schema": { "type": "object", "properties": { - "record": {"type": "object", "additionalProperties": {}} + "record": { + "type": "object", + "additionalProperties": {} + } }, "required": ["record"] } @@ -4566,7 +4568,9 @@ "record": {}, "warnings": { "type": "array", - "items": {"$ref": "#/components/schemas/warning"} + "items": { + "$ref": "#/components/schemas/warning" + } } } } @@ -4577,7 +4581,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4603,7 +4609,10 @@ { "in": "query", "name": "type", - "schema": {"type": "string", "enum": ["standard", "custom"]} + "schema": { + "type": "string", + "enum": ["standard", "custom"] + } } ], "responses": { @@ -4613,7 +4622,9 @@ "application/json": { "schema": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.meta.object"} + "items": { + "$ref": "#/components/schemas/crm.meta.object" + } } } } @@ -4622,7 +4633,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4630,7 +4643,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4658,17 +4673,27 @@ "schema": { "type": "object", "properties": { - "name": {"type": "string"}, - "description": {"type": ["string", "null"]}, + "name": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, "labels": { "type": "object", "properties": { - "singular": {"type": "string"}, - "plural": {"type": "string"} + "singular": { + "type": "string" + }, + "plural": { + "type": "string" + } }, "required": ["singular", "plural"] }, - "primary_field_id": {"type": "string"}, + "primary_field_id": { + "type": "string" + }, "fields": { "type": "array", "items": { @@ -4693,7 +4718,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/crm.meta.object"} + "schema": { + "$ref": "#/components/schemas/crm.meta.object" + } } } }, @@ -4701,7 +4728,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4727,7 +4756,9 @@ { "in": "path", "name": "object_name", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4738,7 +4769,9 @@ "application/json": { "schema": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.meta.property"} + "items": { + "$ref": "#/components/schemas/crm.meta.property" + } } } } @@ -4747,7 +4780,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4755,7 +4790,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4779,7 +4816,9 @@ { "in": "path", "name": "object_name", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -4822,7 +4861,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/crm.meta.property"} + "schema": { + "$ref": "#/components/schemas/crm.meta.property" + } } } }, @@ -4830,7 +4871,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4859,13 +4902,19 @@ "schema": { "type": "object", "properties": { - "source_object": {"type": "string"}, - "target_object": {"type": "string"}, + "source_object": { + "type": "string" + }, + "target_object": { + "type": "string" + }, "suggested_key_name": { "type": "string", "description": "The underlying provider may change this (e.g. adding `__c` for Salesforce)." }, - "display_name": {"type": "string"} + "display_name": { + "type": "string" + } }, "required": [ "source_object", @@ -4890,7 +4939,9 @@ }, "warnings": { "type": "array", - "items": {"$ref": "#/components/schemas/warning"} + "items": { + "$ref": "#/components/schemas/warning" + } } }, "required": ["association_schema"] @@ -4902,7 +4953,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4928,14 +4981,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -4945,11 +5009,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/banking.account"} + "items": { + "$ref": "#/components/schemas/banking.account" + } } }, "required": ["has_next_page", "items"] @@ -4961,7 +5031,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -4969,7 +5041,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -4995,14 +5069,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5012,11 +5097,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/banking.merchant"} + "items": { + "$ref": "#/components/schemas/banking.merchant" + } } }, "required": ["has_next_page", "items"] @@ -5028,7 +5119,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5036,7 +5129,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5062,14 +5157,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5079,11 +5185,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/banking.category"} + "items": { + "$ref": "#/components/schemas/banking.category" + } } }, "required": ["has_next_page", "items"] @@ -5095,7 +5207,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5103,7 +5217,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5129,14 +5245,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5146,8 +5273,12 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { @@ -5164,7 +5295,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5172,7 +5305,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5198,14 +5333,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5215,34 +5361,62 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": {"type": "string"}, - "number": {"type": ["string", "null"]}, - "name": {"type": "string"}, - "type": {"type": "string"}, - "subAccount": {"type": "boolean"}, - "accountType": {"type": "string"}, - "accountSubType": {"type": "string"}, - "currentBalance": {"type": "number"}, + "id": { + "type": "string" + }, + "number": { + "type": ["string", "null"] + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "subAccount": { + "type": "boolean" + }, + "accountType": { + "type": "string" + }, + "accountSubType": { + "type": "string" + }, + "currentBalance": { + "type": "number" + }, "currencyRef": { "type": "object", "properties": { - "value": {"type": "string"}, - "name": {"type": "string"} + "value": { + "type": "string" + }, + "name": { + "type": "string" + } }, "required": ["value", "name"] }, "metaData": { "type": "object", "properties": { - "createTime": {"type": "string"}, - "lastUpdatedTime": {"type": "string"} + "createTime": { + "type": "string" + }, + "lastUpdatedTime": { + "type": "string" + } }, "required": ["createTime", "lastUpdatedTime"] } @@ -5260,7 +5434,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5268,7 +5444,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5294,14 +5472,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5311,17 +5500,29 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": {"type": "string"}, - "amount": {"type": "number"}, - "currency": {"type": "string"}, - "payment_account": {"type": "string"} + "id": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "currency": { + "type": "string" + }, + "payment_account": { + "type": "string" + } }, "required": [ "id", @@ -5341,7 +5542,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5349,7 +5552,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5375,14 +5580,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -5392,16 +5608,26 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "url": {"type": "string"} + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + } }, "required": ["id", "name", "url"] } @@ -5416,7 +5642,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5424,7 +5652,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5447,13 +5677,55 @@ "summary": "Get Balance Sheet", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, - {"in": "query", "name": "customer", "schema": {"type": "string"}}, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, - {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "customer", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "summarize_by", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -5463,20 +5735,50 @@ "schema": { "type": "object", "properties": { - "startPeriod": {"type": "string", "format": "date"}, - "endPeriod": {"type": "string", "format": "date"}, - "currency": {"type": "string"}, - "accountingStandard": {"type": "string"}, - "totalCurrentAssets": {"type": ["number", "null"]}, - "totalFixedAssets": {"type": ["number", "null"]}, - "totalAssets": {"type": ["number", "null"]}, - "totalCurrentLiabilities": {"type": ["number", "null"]}, - "totalLongTermLiabilities": {"type": ["number", "null"]}, - "totalLiabilities": {"type": ["number", "null"]}, - "openingBalanceEquity": {"type": ["number", "null"]}, - "netIncome": {"type": ["number", "null"]}, - "totalEquity": {"type": ["number", "null"]}, - "totalLiabilitiesAndEquity": {"type": ["number", "null"]} + "startPeriod": { + "type": "string", + "format": "date" + }, + "endPeriod": { + "type": "string", + "format": "date" + }, + "currency": { + "type": "string" + }, + "accountingStandard": { + "type": "string" + }, + "totalCurrentAssets": { + "type": ["number", "null"] + }, + "totalFixedAssets": { + "type": ["number", "null"] + }, + "totalAssets": { + "type": ["number", "null"] + }, + "totalCurrentLiabilities": { + "type": ["number", "null"] + }, + "totalLongTermLiabilities": { + "type": ["number", "null"] + }, + "totalLiabilities": { + "type": ["number", "null"] + }, + "openingBalanceEquity": { + "type": ["number", "null"] + }, + "netIncome": { + "type": ["number", "null"] + }, + "totalEquity": { + "type": ["number", "null"] + }, + "totalLiabilitiesAndEquity": { + "type": ["number", "null"] + } }, "required": [ "startPeriod", @@ -5502,7 +5804,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5510,7 +5814,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5533,32 +5839,96 @@ "summary": "Get Profit and Loss", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, - {"in": "query", "name": "customer", "schema": {"type": "string"}}, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, - {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportName": {"type": "string"}, - "startPeriod": {"type": "string", "format": "date"}, - "endPeriod": {"type": "string", "format": "date"}, - "currency": {"type": "string"}, - "accountingStandard": {"type": "string"}, - "totalIncome": {"type": ["number", "null"]}, - "grossProfit": {"type": ["number", "null"]}, - "totalExpenses": {"type": ["number", "null"]}, - "netOperatingIncome": {"type": ["number", "null"]}, - "netIncome": {"type": ["number", "null"]} + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "customer", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "summarize_by", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportName": { + "type": "string" + }, + "startPeriod": { + "type": "string", + "format": "date" + }, + "endPeriod": { + "type": "string", + "format": "date" + }, + "currency": { + "type": "string" + }, + "accountingStandard": { + "type": "string" + }, + "totalIncome": { + "type": ["number", "null"] + }, + "grossProfit": { + "type": ["number", "null"] + }, + "totalExpenses": { + "type": ["number", "null"] + }, + "netOperatingIncome": { + "type": ["number", "null"] + }, + "netIncome": { + "type": ["number", "null"] + } }, "required": [ "reportName", @@ -5580,7 +5950,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5588,7 +5960,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5611,13 +5985,55 @@ "summary": "Get Cash Flow", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, - {"in": "query", "name": "customer", "schema": {"type": "string"}}, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, - {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "customer", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "summarize_by", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -5627,20 +6043,38 @@ "schema": { "type": "object", "properties": { - "reportName": {"type": "string"}, - "startPeriod": {"type": "string", "format": "date"}, - "endPeriod": {"type": "string", "format": "date"}, - "currency": {"type": "string"}, - "netIncome": {"type": ["number", "null"]}, - "totalOperatingAdjustments": {"type": ["number", "null"]}, + "reportName": { + "type": "string" + }, + "startPeriod": { + "type": "string", + "format": "date" + }, + "endPeriod": { + "type": "string", + "format": "date" + }, + "currency": { + "type": "string" + }, + "netIncome": { + "type": ["number", "null"] + }, + "totalOperatingAdjustments": { + "type": ["number", "null"] + }, "netCashFromOperatingActivities": { "type": ["number", "null"] }, "netCashFromFinancingActivities": { "type": ["number", "null"] }, - "netCashIncrease": {"type": ["number", "null"]}, - "endingCash": {"type": ["number", "null"]} + "netCashIncrease": { + "type": ["number", "null"] + }, + "endingCash": { + "type": ["number", "null"] + } }, "required": [ "reportName", @@ -5662,7 +6096,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5670,7 +6106,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5693,24 +6131,76 @@ "summary": "Get Transaction List", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, - {"in": "query", "name": "customer", "schema": {"type": "string"}}, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "customer", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "payment_method", - "schema": {"type": "string"} + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "arpaid", + "schema": { + "type": "string" + } }, - {"in": "query", "name": "arpaid", "schema": {"type": "string"}}, { "in": "query", "name": "transaction_type", - "schema": {"type": "string"} + "schema": { + "type": "string" + } }, - {"in": "query", "name": "sort_by", "schema": {"type": "string"}} + { + "in": "query", + "name": "sort_by", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -5720,26 +6210,56 @@ "schema": { "type": "object", "properties": { - "reportName": {"type": "string"}, - "startPeriod": {"type": "string"}, - "endPeriod": {"type": "string"}, - "currency": {"type": "string"}, + "reportName": { + "type": "string" + }, + "startPeriod": { + "type": "string" + }, + "endPeriod": { + "type": "string" + }, + "currency": { + "type": "string" + }, "transactions": { "type": "array", "items": { "type": "object", "properties": { - "id": {"type": "string"}, - "date": {"type": "string"}, - "transactionType": {"type": "string"}, - "documentNumber": {"type": "string"}, - "posting": {"type": "string"}, - "name": {"type": "string"}, - "department": {"type": "string"}, - "memo": {"type": "string"}, - "account": {"type": "string"}, - "split": {"type": "string"}, - "amount": {"type": "number"}, + "id": { + "type": "string" + }, + "date": { + "type": "string" + }, + "transactionType": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "posting": { + "type": "string" + }, + "name": { + "type": "string" + }, + "department": { + "type": "string" + }, + "memo": { + "type": "string" + }, + "account": { + "type": "string" + }, + "split": { + "type": "string" + }, + "amount": { + "type": "number" + }, "raw_data": {} }, "required": ["id", "date", "transactionType", "amount"] @@ -5761,7 +6281,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5769,7 +6291,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5792,18 +6316,56 @@ "summary": "Get Customer Balance", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "customer", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true }, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, - {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "summarize_by", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -5813,22 +6375,36 @@ "schema": { "type": "object", "properties": { - "reportName": {"type": "string"}, - "reportDate": {"type": "string"}, - "currency": {"type": "string"}, + "reportName": { + "type": "string" + }, + "reportDate": { + "type": "string" + }, + "currency": { + "type": "string" + }, "entries": { "type": "array", "items": { "type": "object", "properties": { - "customerId": {"type": "string"}, - "customerName": {"type": "string"}, - "balance": {"type": "number"} + "customerId": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "balance": { + "type": "number" + } }, "required": ["customerId", "customerName", "balance"] } }, - "totalBalance": {"type": "number"} + "totalBalance": { + "type": "number" + } }, "required": [ "reportName", @@ -5845,7 +6421,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5853,7 +6431,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5876,18 +6456,56 @@ "summary": "Get Customer Income", "tags": ["Accounting"], "parameters": [ - {"in": "query", "name": "start_date", "schema": {"type": "string"}}, - {"in": "query", "name": "end_date", "schema": {"type": "string"}}, - {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + { + "in": "query", + "name": "start_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "end_date", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sort_order", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "customer", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true }, - {"in": "query", "name": "department", "schema": {"type": "string"}}, - {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, - {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} + { + "in": "query", + "name": "department", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "date_macro", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "summarize_by", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -5897,20 +6515,38 @@ "schema": { "type": "object", "properties": { - "reportName": {"type": "string"}, - "startPeriod": {"type": "string"}, - "endPeriod": {"type": "string"}, - "currency": {"type": "string"}, + "reportName": { + "type": "string" + }, + "startPeriod": { + "type": "string" + }, + "endPeriod": { + "type": "string" + }, + "currency": { + "type": "string" + }, "entries": { "type": "array", "items": { "type": "object", "properties": { - "customerId": {"type": "string"}, - "customerName": {"type": "string"}, - "totalIncome": {"type": "number"}, - "totalExpenses": {"type": "number"}, - "netIncome": {"type": "number"} + "customerId": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "totalIncome": { + "type": "number" + }, + "totalExpenses": { + "type": "number" + }, + "netIncome": { + "type": "number" + } }, "required": [ "customerId", @@ -5921,9 +6557,15 @@ ] } }, - "totalIncome": {"type": "number"}, - "totalExpenses": {"type": "number"}, - "netIncome": {"type": "number"} + "totalIncome": { + "type": "number" + }, + "totalExpenses": { + "type": "number" + }, + "netIncome": { + "type": "number" + } }, "required": [ "reportName", @@ -5943,7 +6585,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -5951,7 +6595,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -5977,7 +6623,9 @@ { "in": "query", "name": "customer", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -5991,16 +6639,36 @@ "items": { "type": "object", "properties": { - "updated": {"type": "string"}, - "name": {"type": "string"}, - "accountNumber": {"type": "string"}, - "default": {"type": "boolean"}, - "created": {"type": "string"}, - "inputType": {"type": "string"}, - "phone": {"type": "string"}, - "accountType": {"type": "string"}, - "routingNumber": {"type": "string"}, - "id": {"type": "string"} + "updated": { + "type": "string" + }, + "name": { + "type": "string" + }, + "accountNumber": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "created": { + "type": "string" + }, + "inputType": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "accountType": { + "type": "string" + }, + "routingNumber": { + "type": "string" + }, + "id": { + "type": "string" + } }, "required": [ "updated", @@ -6023,7 +6691,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6031,7 +6701,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6057,20 +6729,28 @@ { "in": "query", "name": "customer_transaction_id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} + "content": { + "application/json": { + "schema": {} + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6078,7 +6758,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6104,148 +6786,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": { - "type": "array", - "items": {"type": "object", "properties": {}} - } - }, - "required": ["has_next_page", "items"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } + "schema": { + "type": ["string", "null"] } - } - } - } - }, - "/unified/pta/transaction": { - "get": { - "operationId": "pta-listTransactions", - "summary": "List Transactions", - "tags": ["PTA"], - "parameters": [ - { - "in": "query", - "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": { - "type": "array", - "items": {"type": "object", "properties": {}} - } - }, - "required": ["has_next_page", "items"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } + "name": "page_size", + "schema": { + "type": "number" } } - } - } - }, - "/unified/pta/commodity": { - "get": { - "operationId": "pta-listCommodities", - "summary": "List Commodities", - "tags": ["PTA"], - "parameters": [ - { - "in": "query", - "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} - }, - { - "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -6255,11 +6814,18 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"type": "object", "properties": {}} + "items": { + "type": "object", + "properties": {} + } } }, "required": ["has_next_page", "items"] @@ -6271,7 +6837,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6279,7 +6847,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6296,96 +6866,34 @@ } } }, - "/unified/ats/job": { + "/unified/pta/transaction": { "get": { - "operationId": "ats-listJobs", - "summary": "List Jobs", - "tags": ["ATS"], + "operationId": "pta-listTransactions", + "summary": "List Transactions", + "tags": ["PTA"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} - }, - { - "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} - ], - "responses": { - "200": { - "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": { - "type": "array", - "items": {"$ref": "#/components/schemas/ats.job"} - } - }, - "required": ["has_next_page", "items"] - } - } - } - }, - "400": { - "description": "Invalid input data", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } + "schema": { + "type": "string", + "enum": ["full", "incremental"] } - } - } - } - }, - "/unified/ats/job/{jobId}/opening": { - "get": { - "operationId": "ats-listJobOpenings", - "summary": "List Job Openings", - "tags": ["ATS"], - "parameters": [ - { - "in": "path", - "name": "jobId", - "schema": {"type": "string"}, - "required": true }, { "in": "query", - "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "name": "cursor", + "schema": { + "type": ["string", "null"] + } }, { "in": "query", - "name": "cursor", - "schema": {"type": ["string", "null"]} - }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -6395,11 +6903,18 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/ats.opening"} + "items": { + "type": "object", + "properties": {} + } } }, "required": ["has_next_page", "items"] @@ -6411,7 +6926,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6419,7 +6936,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6436,23 +6955,34 @@ } } }, - "/unified/ats/offer": { + "/unified/pta/commodity": { "get": { - "operationId": "ats-listOffers", - "summary": "List Offers", - "tags": ["ATS"], + "operationId": "pta-listCommodities", + "summary": "List Commodities", + "tags": ["PTA"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -6462,11 +6992,18 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/ats.offer"} + "items": { + "type": "object", + "properties": {} + } } }, "required": ["has_next_page", "items"] @@ -6478,7 +7015,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6486,7 +7025,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6503,23 +7044,34 @@ } } }, - "/unified/ats/candidate": { + "/unified/ats/job": { "get": { - "operationId": "ats-listCandidates", - "summary": "List Candidates", + "operationId": "ats-listJobs", + "summary": "List Jobs", "tags": ["ATS"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -6529,11 +7081,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/ats.candidate"} + "items": { + "$ref": "#/components/schemas/ats.job" + } } }, "required": ["has_next_page", "items"] @@ -6545,7 +7103,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6553,7 +7113,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6570,23 +7132,42 @@ } } }, - "/unified/ats/department": { + "/unified/ats/job/{jobId}/opening": { "get": { - "operationId": "ats-listDepartments", - "summary": "List Departments", + "operationId": "ats-listJobOpenings", + "summary": "List Job Openings", "tags": ["ATS"], "parameters": [ + { + "in": "path", + "name": "jobId", + "schema": { + "type": "string" + }, + "required": true + }, { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -6596,11 +7177,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/ats.department"} + "items": { + "$ref": "#/components/schemas/ats.opening" + } } }, "required": ["has_next_page", "items"] @@ -6612,7 +7199,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6620,7 +7209,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6637,23 +7228,34 @@ } } }, - "/unified/hris/individual": { + "/unified/ats/offer": { "get": { - "operationId": "hris-listIndividual", - "summary": "List Individuals", - "tags": ["HRIS"], + "operationId": "ats-listOffers", + "summary": "List Offers", + "tags": ["ATS"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -6663,20 +7265,16 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { - "type": "object", - "properties": { - "id": {"type": "string"}, - "raw_data": { - "type": "object", - "additionalProperties": {} - } - }, - "required": ["id"] + "$ref": "#/components/schemas/ats.offer" } } }, @@ -6689,7 +7287,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6697,7 +7297,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6714,33 +7316,33 @@ } } }, - "/unified/sync/read/{stream}": { + "/unified/ats/candidate": { "get": { - "operationId": "sync-readStream", - "summary": "Read Stream", - "tags": ["Sync"], + "operationId": "ats-listCandidates", + "summary": "List Candidates", + "tags": ["ATS"], "parameters": [ - { - "in": "path", - "name": "stream", - "schema": {"type": "string"}, - "required": true - }, { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", - "name": "fields", - "schema": {"type": "array", "items": {"type": "string"}} + "name": "page_size", + "schema": { + "type": "number" + } } ], "responses": { @@ -6751,9 +7353,18 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, - "items": {"type": "array", "items": {}} + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ats.candidate" + } + } }, "required": ["has_next_page", "items"] } @@ -6764,7 +7375,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -6772,7 +7385,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6789,11 +7404,35 @@ } } }, - "/unified/sync/discover": { + "/unified/ats/department": { "get": { - "operationId": "sync-discover", - "summary": "Discover", - "tags": ["Sync"], + "operationId": "ats-listDepartments", + "summary": "List Departments", + "tags": ["ATS"], + "parameters": [ + { + "in": "query", + "name": "sync_mode", + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } + ], "responses": { "200": { "description": "Successful response", @@ -6802,168 +7441,41 @@ "schema": { "type": "object", "properties": { - "streams": { + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, + "items": { "type": "array", "items": { - "type": "object", - "properties": { - "name": {"type": "string"}, - "json_schema": { - "type": "object", - "additionalProperties": {} - }, - "source_defined_primary_key": { - "type": "array", - "items": { - "type": "array", - "items": {"type": "string"} - } - } - }, - "required": ["name", "json_schema"] - } - }, - "type": {"type": "string", "enum": ["CATALOG"]} - }, - "required": ["streams", "type"] - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" - } - } - } - } - } - } - }, - "/unified/sync/read": { - "post": { - "operationId": "sync-read", - "summary": "Read Data", - "tags": ["Sync"], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "catalog": { - "type": "object", - "properties": { - "streams": { - "type": "array", - "items": { - "type": "object", - "properties": { - "stream": { - "type": "object", - "properties": { - "name": {"type": "string"}, - "json_schema": { - "type": "object", - "additionalProperties": {} - }, - "source_defined_primary_key": { - "type": "array", - "items": { - "type": "array", - "items": {"type": "string"} - } - } - }, - "required": ["name", "json_schema"] - }, - "sync_mode": { - "type": "string", - "enum": ["full_refresh", "incremental"] - }, - "additional_fields": { - "type": "array", - "items": {"type": "string"} - } - }, - "required": ["stream", "sync_mode"] - } + "$ref": "#/components/schemas/ats.department" } - }, - "required": ["streams"] + } }, - "state": { - "type": "object", - "properties": { - "shared_state": { - "type": "object", - "additionalProperties": {} - }, - "stream_states": { - "type": "array", - "items": { - "type": "object", - "properties": { - "stream_description": { - "type": "object", - "properties": { - "name": {"type": "string"}, - "namespace": {"type": "string"} - }, - "required": ["name", "namespace"] - }, - "stream_state": { - "type": "object", - "additionalProperties": {} - } - }, - "required": ["stream_description", "stream_state"] - } - } - }, - "required": ["stream_states"] - } - }, - "required": ["catalog", "state"] + "required": ["has_next_page", "items"] + } } } - } - }, - "responses": { - "200": { - "description": "Successful response", + }, + "400": { + "description": "Invalid input data", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "record": { - "type": "object", - "properties": { - "data": {}, - "stream": {"type": "string"} - }, - "required": ["stream"] - }, - "type": {"type": "string", "enum": ["RECORD"]} - }, - "required": ["record", "type"] - } + "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, - "400": { - "description": "Invalid input data", + "404": { + "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -6980,104 +7492,67 @@ } } }, - "/unified/sync/write": { - "post": { - "operationId": "sync-write", - "summary": "Write Data", - "tags": ["Sync"], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "messages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "record": { - "type": "object", - "properties": { - "data": {}, - "stream": {"type": "string"} - }, - "required": ["stream"] - }, - "type": {"type": "string", "enum": ["RECORD"]} - }, - "required": ["record", "type"] - } - } - }, - "required": ["messages"] - } + "/unified/hris/individual": { + "get": { + "operationId": "hris-listIndividual", + "summary": "List Individuals", + "tags": ["HRIS"], + "parameters": [ + { + "in": "query", + "name": "sync_mode", + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" } } - }, + ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "oneOf": [ - { + "type": "object", + "properties": { + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { "type": "object", "properties": { - "streams": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": {"type": "string"}, - "json_schema": { - "type": "object", - "additionalProperties": {} - }, - "source_defined_primary_key": { - "type": "array", - "items": { - "type": "array", - "items": {"type": "string"} - } - } - }, - "required": ["name", "json_schema"] - } + "id": { + "type": "string" }, - "type": {"type": "string", "enum": ["CATALOG"]} - }, - "required": ["streams", "type"] - }, - { - "type": "object", - "properties": { - "record": { + "raw_data": { "type": "object", - "properties": { - "data": {}, - "stream": {"type": "string"} - }, - "required": ["stream"] - }, - "type": {"type": "string", "enum": ["RECORD"]} - }, - "required": ["record", "type"] - }, - { - "type": "object", - "properties": { - "state": {}, - "type": {"type": "string", "enum": ["STATE"]} + "additionalProperties": {} + } }, - "required": ["type"] + "required": ["id"] } - ] - } + } + }, + "required": ["has_next_page", "items"] } } } @@ -7086,7 +7561,19 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7112,14 +7599,25 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}} + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + } ], "responses": { "200": { @@ -7129,8 +7627,12 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", "items": { @@ -7147,7 +7649,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7155,7 +7659,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7181,18 +7687,31 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", "name": "drive_group_id", - "schema": {"type": "string"} + "schema": { + "type": "string" + } } ], "responses": { @@ -7203,11 +7722,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/unified.drive"} + "items": { + "$ref": "#/components/schemas/unified.drive" + } } }, "required": ["has_next_page", "items"] @@ -7219,7 +7744,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7227,7 +7754,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7253,16 +7782,39 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "drive_id", + "schema": { + "type": "string" + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, - {"in": "query", "name": "drive_id", "schema": {"type": "string"}}, - {"in": "query", "name": "folder_id", "schema": {"type": "string"}} + { + "in": "query", + "name": "folder_id", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -7272,11 +7824,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/unified.file"} + "items": { + "$ref": "#/components/schemas/unified.file" + } } }, "required": ["has_next_page", "items"] @@ -7288,7 +7846,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7296,7 +7856,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7322,7 +7884,9 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], @@ -7331,7 +7895,9 @@ "description": "Successful response", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/unified.file"} + "schema": { + "$ref": "#/components/schemas/unified.file" + } } } }, @@ -7339,7 +7905,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7347,7 +7915,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7373,26 +7943,36 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true }, { "in": "query", "name": "format", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} + "content": { + "application/json": { + "schema": {} + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7400,7 +7980,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7426,20 +8008,28 @@ { "in": "path", "name": "id", - "schema": {"type": "string"}, + "schema": { + "type": "string" + }, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": {"application/json": {"schema": {}}} + "content": { + "application/json": { + "schema": {} + } + } }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7447,7 +8037,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7473,15 +8065,32 @@ { "in": "query", "name": "sync_mode", - "schema": {"type": "string", "enum": ["full", "incremental"]} + "schema": { + "type": "string", + "enum": ["full", "incremental"] + } }, { "in": "query", "name": "cursor", - "schema": {"type": ["string", "null"]} + "schema": { + "type": ["string", "null"] + } + }, + { + "in": "query", + "name": "page_size", + "schema": { + "type": "number" + } }, - {"in": "query", "name": "page_size", "schema": {"type": "number"}}, - {"in": "query", "name": "drive_id", "schema": {"type": "string"}} + { + "in": "query", + "name": "drive_id", + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -7491,11 +8100,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": {"type": ["string", "null"]}, - "has_next_page": {"type": "boolean"}, + "next_cursor": { + "type": ["string", "null"] + }, + "has_next_page": { + "type": "boolean" + }, "items": { "type": "array", - "items": {"$ref": "#/components/schemas/unified.folder"} + "items": { + "$ref": "#/components/schemas/unified.folder" + } } }, "required": ["has_next_page", "items"] @@ -7507,7 +8122,9 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + "schema": { + "$ref": "#/components/schemas/error.BAD_REQUEST" + } } } }, @@ -7515,7 +8132,9 @@ "description": "Not found", "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + "schema": { + "$ref": "#/components/schemas/error.NOT_FOUND" + } } } }, @@ -7539,7 +8158,9 @@ "requestBody": { "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/webhooks.sync.completed"} + "schema": { + "$ref": "#/components/schemas/webhooks.sync.completed" + } } } }, @@ -7551,7 +8172,9 @@ "requestBody": { "content": { "application/json": { - "schema": {"$ref": "#/components/schemas/webhooks.pageview"} + "schema": { + "$ref": "#/components/schemas/webhooks.pageview" + } } } }, @@ -7561,13 +8184,21 @@ }, "components": { "securitySchemes": { - "apikey": {"type": "apiKey", "name": "x-apikey", "in": "header"}, + "apikey": { + "type": "apiKey", + "name": "x-apikey", + "in": "header" + }, "connectionId": { "type": "apiKey", "name": "x-connection-id", "in": "header" }, - "token": {"type": "apiKey", "name": "authorization", "in": "header"} + "token": { + "type": "apiKey", + "name": "authorization", + "in": "header" + } }, "schemas": { "webhooks.sync.completed": { @@ -7591,8 +8222,13 @@ }, "required": ["pipeline_id", "source_id", "destination_id"] }, - "name": {"type": "string", "enum": ["sync.completed"]}, - "id": {"type": "string"} + "name": { + "type": "string", + "enum": ["sync.completed"] + }, + "id": { + "type": "string" + } }, "required": ["data", "name"] }, @@ -7602,13 +8238,22 @@ "data": { "type": "object", "properties": { - "current_url": {"type": "string"}, - "path": {"type": "string"} + "current_url": { + "type": "string" + }, + "path": { + "type": "string" + } }, "required": ["current_url", "path"] }, - "name": {"type": "string", "enum": ["pageview"]}, - "id": {"type": "string"} + "name": { + "type": "string", + "enum": ["pageview"] + }, + "id": { + "type": "string" + } }, "required": ["data", "name"] }, @@ -7629,7 +8274,11 @@ "type": "array", "items": { "type": "object", - "properties": {"message": {"type": "string"}}, + "properties": { + "message": { + "type": "string" + } + }, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -7662,7 +8311,11 @@ "type": "array", "items": { "type": "object", - "properties": {"message": {"type": "string"}}, + "properties": { + "message": { + "type": "string" + } + }, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -7672,7 +8325,11 @@ "required": ["message", "code"], "title": "Error", "description": "The error information", - "example": {"code": "NOT_FOUND", "message": "Not found", "issues": []} + "example": { + "code": "NOT_FOUND", + "message": "Not found", + "issues": [] + } }, "error.INTERNAL_SERVER_ERROR": { "type": "object", @@ -7691,7 +8348,11 @@ "type": "array", "items": { "type": "object", - "properties": {"message": {"type": "string"}}, + "properties": { + "message": { + "type": "string" + } + }, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -7710,15 +8371,27 @@ "Connection": { "type": "object", "properties": { - "createdAt": {"type": "string"}, - "updatedAt": {"type": "string"}, - "id": {"type": "string", "description": "Must start with 'conn_'"}, + "createdAt": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Must start with 'conn_'" + }, "connectorName": { "type": "string", "description": "Unique name of the connector" }, - "displayName": {"type": ["string", "null"]}, - "customerId": {"type": ["string", "null"], "minLength": 1}, + "displayName": { + "type": ["string", "null"] + }, + "customerId": { + "type": ["string", "null"], + "minLength": 1 + }, "connectorConfigId": { "type": "string", "description": "Must start with 'ccfg_'" @@ -7727,20 +8400,34 @@ "type": ["string", "null"], "description": "Must start with 'int_'" }, - "settings": {"type": ["object", "null"], "additionalProperties": {}}, + "settings": { + "type": ["object", "null"], + "additionalProperties": {} + }, "standard": { "type": ["object", "null"], "properties": { - "displayName": {"type": ["string", "null"]}, + "displayName": { + "type": ["string", "null"] + }, "status": { "type": ["string", "null"], "enum": ["healthy", "disconnected", "error", "manual"] }, - "statusMessage": {"type": ["string", "null"]}, - "labels": {"type": "array", "items": {"type": "string"}} + "statusMessage": { + "type": ["string", "null"] + }, + "labels": { + "type": "array", + "items": { + "type": "string" + } + } } }, - "disabled": {"type": "boolean"}, + "disabled": { + "type": "boolean" + }, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -7756,13 +8443,30 @@ "ConnectorConfig": { "type": "object", "properties": { - "createdAt": {"type": "string"}, - "updatedAt": {"type": "string"}, - "id": {"type": "string", "description": "Must start with 'ccfg_'"}, - "connectorName": {"type": "string"}, - "config": {"type": ["object", "null"], "additionalProperties": {}}, - "orgId": {"type": "string", "description": "Must start with 'org_'"}, - "displayName": {"type": ["string", "null"]}, + "createdAt": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Must start with 'ccfg_'" + }, + "connectorName": { + "type": "string" + }, + "config": { + "type": ["object", "null"], + "additionalProperties": {} + }, + "orgId": { + "type": "string", + "description": "Must start with 'org_'" + }, + "displayName": { + "type": ["string", "null"] + }, "disabled": { "type": "boolean", "title": "Disabled", @@ -7773,11 +8477,15 @@ "properties": { "streams": { "type": ["object", "null"], - "additionalProperties": {"type": "boolean"} + "additionalProperties": { + "type": "boolean" + } }, "links": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/Link"}, + "items": { + "$ref": "#/components/schemas/Link" + }, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "destination_id": { @@ -7792,7 +8500,9 @@ "properties": { "links": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/Link"}, + "items": { + "$ref": "#/components/schemas/Link" + }, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "source_id": { @@ -7803,7 +8513,9 @@ "required": ["source_id"], "description": "Automatically sync data from any connections associated with this config to the destination connection, which is typically a Postgres database. Think ETL" }, - "envName": {"type": ["string", "null"]}, + "envName": { + "type": ["string", "null"] + }, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -7824,15 +8536,26 @@ "core.integration": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "name": {"type": "string"}, - "logo_url": {"type": ["string", "null"]}, - "login_url": {"type": ["string", "null"]}, + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "name": { + "type": "string" + }, + "logo_url": { + "type": ["string", "null"] + }, + "login_url": { + "type": ["string", "null"] + }, "verticals": { "type": ["array", "null"], "items": { @@ -7860,12 +8583,18 @@ ] } }, - "connector_name": {"type": "string"} + "connector_name": { + "type": "string" + } }, "required": ["id", "name", "connector_name"] }, "core.configured_integration": { - "allOf": [{"$ref": "#/components/schemas/core.integration"}], + "allOf": [ + { + "$ref": "#/components/schemas/core.integration" + } + ], "type": "object", "properties": { "connector_config_id": { @@ -7878,22 +8607,41 @@ "Pipeline": { "type": "object", "properties": { - "createdAt": {"type": "string"}, - "updatedAt": {"type": "string"}, - "id": {"type": "string", "description": "Must start with 'pipe_'"}, + "createdAt": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Must start with 'pipe_'" + }, "sourceId": { "type": "string", "description": "Must start with 'conn_'" }, - "sourceState": {"type": "object", "additionalProperties": {}}, - "sourceVertical": {"type": ["string", "null"]}, + "sourceState": { + "type": "object", + "additionalProperties": {} + }, + "sourceVertical": { + "type": ["string", "null"] + }, "streams": { "type": ["object", "null"], "additionalProperties": { "type": "object", "properties": { - "disabled": {"type": "boolean"}, - "fields": {"type": "array", "items": {"type": "string"}} + "disabled": { + "type": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + } } } }, @@ -7901,12 +8649,26 @@ "type": "string", "description": "Must start with 'conn_'" }, - "destinationState": {"type": "object", "additionalProperties": {}}, - "destinationVertical": {"type": ["string", "null"]}, - "linkOptions": {"type": ["array", "null"], "items": {}}, - "lastSyncStartedAt": {"type": ["string", "null"]}, - "lastSyncCompletedAt": {"type": ["string", "null"]}, - "disabled": {"type": "boolean"}, + "destinationState": { + "type": "object", + "additionalProperties": {} + }, + "destinationVertical": { + "type": ["string", "null"] + }, + "linkOptions": { + "type": ["array", "null"], + "items": {} + }, + "lastSyncStartedAt": { + "type": ["string", "null"] + }, + "lastSyncCompletedAt": { + "type": ["string", "null"] + }, + "disabled": { + "type": "boolean" + }, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -7916,16 +8678,32 @@ "Event": { "type": "object", "properties": { - "id": {"type": "string", "description": "Must start with 'evt_'"}, - "name": {"type": "string"}, - "data": {"type": ["object", "null"], "additionalProperties": {}}, - "timestamp": {"type": "string"}, - "user": {"type": ["object", "null"], "additionalProperties": {}}, + "id": { + "type": "string", + "description": "Must start with 'evt_'" + }, + "name": { + "type": "string" + }, + "data": { + "type": ["object", "null"], + "additionalProperties": {} + }, + "timestamp": { + "type": "string" + }, + "user": { + "type": ["object", "null"], + "additionalProperties": {} + }, "org_id": { "type": ["string", "null"], "description": "Must start with 'org_'" }, - "customer_id": {"type": ["string", "null"], "minLength": 1}, + "customer_id": { + "type": ["string", "null"], + "minLength": 1 + }, "user_id": { "type": ["string", "null"], "description": "Must start with 'user_'" @@ -7937,14 +8715,25 @@ "oneOf": [ { "type": "object", - "properties": {"role": {"type": "string", "enum": ["anon"]}}, + "properties": { + "role": { + "type": "string", + "enum": ["anon"] + } + }, "required": ["role"] }, { "type": "object", "properties": { - "role": {"type": "string", "enum": ["customer"]}, - "customerId": {"type": "string", "minLength": 1}, + "role": { + "type": "string", + "enum": ["customer"] + }, + "customerId": { + "type": "string", + "minLength": 1 + }, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -7955,7 +8744,10 @@ { "type": "object", "properties": { - "role": {"type": "string", "enum": ["user"]}, + "role": { + "type": "string", + "enum": ["user"] + }, "userId": { "type": "string", "description": "Must start with 'user_'" @@ -7975,7 +8767,10 @@ { "type": "object", "properties": { - "role": {"type": "string", "enum": ["org"]}, + "role": { + "type": "string", + "enum": ["org"] + }, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -7990,7 +8785,12 @@ }, { "type": "object", - "properties": {"role": {"type": "string", "enum": ["system"]}}, + "properties": { + "role": { + "type": "string", + "enum": ["system"] + } + }, "required": ["role"] } ] @@ -7998,13 +8798,27 @@ "sales-engagement.contact": { "type": "object", "properties": { - "id": {"type": "string"}, - "first_name": {"type": "string"}, - "last_name": {"type": "string"}, - "owner_id": {"type": "string"}, - "account_id": {"type": "string"}, - "job_title": {"type": "string"}, - "address": {"$ref": "#/components/schemas/sales-engagement.address"}, + "id": { + "type": "string" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "owner_id": { + "type": "string" + }, + "account_id": { + "type": "string" + }, + "job_title": { + "type": "string" + }, + "address": { + "$ref": "#/components/schemas/sales-engagement.address" + }, "email_addresses": { "type": "array", "items": { @@ -8017,14 +8831,30 @@ "$ref": "#/components/schemas/sales-engagement.phone_number" } }, - "open_count": {"type": "number"}, - "click_count": {"type": "number"}, - "reply_count": {"type": "number"}, - "bounced_count": {"type": "number"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, + "open_count": { + "type": "number" + }, + "click_count": { + "type": "number" + }, + "reply_count": { + "type": "number" + }, + "bounced_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, "raw_data": { "type": "object", "properties": {}, @@ -8053,12 +8883,24 @@ "sales-engagement.address": { "type": "object", "properties": { - "city": {"type": "string"}, - "country": {"type": "string"}, - "postal_code": {"type": "string"}, - "state": {"type": "string"}, - "street_1": {"type": "string"}, - "street_2": {"type": "string"} + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "street_1": { + "type": "string" + }, + "street_2": { + "type": "string" + } }, "required": [ "city", @@ -8072,7 +8914,9 @@ "sales-engagement.email_address": { "type": "object", "properties": { - "email_address": {"type": "string"}, + "email_address": { + "type": "string" + }, "email_address_type": { "type": "string", "enum": ["primary", "personal", "work", "other"] @@ -8083,7 +8927,9 @@ "sales-engagement.phone_number": { "type": "object", "properties": { - "phone_number": {"type": "string"}, + "phone_number": { + "type": "string" + }, "phone_number_type": { "type": "string", "enum": ["primary", "work", "home", "mobile", "other"] @@ -8094,21 +8940,44 @@ "sales-engagement.sequence": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, - "owner_id": {"type": "string"}, - "tags": {"type": "array", "items": {"type": "string"}}, - "num_steps": {"type": "number"}, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, + "owner_id": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "num_steps": { + "type": "number" + }, "metrics": { "type": "object", "properties": {}, "additionalProperties": {} }, - "is_enabled": {"type": "boolean"}, + "is_enabled": { + "type": "boolean" + }, "raw_data": { "type": "object", "properties": {}, @@ -8130,16 +8999,36 @@ "sales-engagement.sequenceState": { "type": "object", "properties": { - "id": {"type": "string"}, - "state": {"type": "string"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, - "sequence_id": {"type": "string"}, - "contact_id": {"type": "string"}, - "mailbox_id": {"type": "string"}, - "user_id": {"type": "string"}, + "id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, + "sequence_id": { + "type": "string" + }, + "contact_id": { + "type": "string" + }, + "mailbox_id": { + "type": "string" + }, + "user_id": { + "type": "string" + }, "raw_data": { "type": "object", "properties": {}, @@ -8162,14 +9051,30 @@ "sales-engagement.user": { "type": "object", "properties": { - "id": {"type": "string"}, - "first_name": {"type": "string"}, - "last_name": {"type": "string"}, - "email": {"type": "string"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, + "id": { + "type": "string" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, "raw_data": { "type": "object", "properties": {}, @@ -8190,14 +9095,30 @@ "sales-engagement.account": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, - "domain": {"type": "string"}, - "owner_id": {"type": "string"}, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "owner_id": { + "type": "string" + }, "raw_data": { "type": "object", "properties": {}, @@ -8218,13 +9139,27 @@ "sales-engagement.mailbox": { "type": "object", "properties": { - "id": {"type": "string"}, - "email": {"type": "string"}, - "created_at": {"type": "string"}, - "updated_at": {"type": "string"}, - "is_deleted": {"type": "boolean"}, - "last_modified_at": {"type": "string"}, - "user_id": {"type": "string"}, + "id": { + "type": "string" + }, + "email": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "is_deleted": { + "type": "boolean" + }, + "last_modified_at": { + "type": "string" + }, + "user_id": { + "type": "string" + }, "raw_data": { "type": "object", "properties": {}, @@ -8244,19 +9179,38 @@ "crm.account": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "name": {"type": ["string", "null"]}, - "is_deleted": {"type": ["boolean", "null"]}, - "website": {"type": ["string", "null"]}, - "industry": {"type": ["string", "null"]}, - "number_of_employees": {"type": ["number", "null"]}, - "owner_id": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "name": { + "type": ["string", "null"] + }, + "is_deleted": { + "type": ["boolean", "null"] + }, + "website": { + "type": ["string", "null"] + }, + "industry": { + "type": ["string", "null"] + }, + "number_of_employees": { + "type": ["number", "null"] + }, + "owner_id": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, "description": { "type": ["string", "null"], "example": "Integration API" @@ -8267,14 +9221,18 @@ }, "addresses": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/crm.address"} + "items": { + "$ref": "#/components/schemas/crm.address" + } }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": {"type": ["string", "null"]}, + "phone_number": { + "type": ["string", "null"] + }, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -8284,24 +9242,44 @@ }, "lifecycle_stage": { "oneOf": [ - {"$ref": "#/components/schemas/crm.lifecycle_stage"}, - {"type": "null"} + { + "$ref": "#/components/schemas/crm.lifecycle_stage" + }, + { + "type": "null" + } ] }, - "last_modified_at": {"type": ["string", "null"]} + "last_modified_at": { + "type": ["string", "null"] + } }, "required": ["id", "updated_at"] }, "crm.address": { "type": "object", "properties": { - "address_type": {"$ref": "#/components/schemas/crm.address_type"}, - "city": {"type": ["string", "null"]}, - "country": {"type": ["string", "null"]}, - "postal_code": {"type": ["string", "null"]}, - "state": {"type": ["string", "null"]}, - "street_1": {"type": ["string", "null"]}, - "street_2": {"type": ["string", "null"]} + "address_type": { + "$ref": "#/components/schemas/crm.address_type" + }, + "city": { + "type": ["string", "null"] + }, + "country": { + "type": ["string", "null"] + }, + "postal_code": { + "type": ["string", "null"] + }, + "state": { + "type": ["string", "null"] + }, + "street_1": { + "type": ["string", "null"] + }, + "street_2": { + "type": ["string", "null"] + } }, "required": [ "address_type", @@ -8341,20 +9319,32 @@ "type": ["string", "null"], "example": "Integration API" }, - "industry": {"type": ["string", "null"]}, - "name": {"type": ["string", "null"]}, - "number_of_employees": {"type": ["number", "null"]}, - "website": {"type": ["string", "null"]}, + "industry": { + "type": ["string", "null"] + }, + "name": { + "type": ["string", "null"] + }, + "number_of_employees": { + "type": ["number", "null"] + }, + "website": { + "type": ["string", "null"] + }, "addresses": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/crm.address"} + "items": { + "$ref": "#/components/schemas/crm.address" + } }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": {"type": ["string", "null"]}, + "phone_number": { + "type": ["string", "null"] + }, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -8362,11 +9352,17 @@ "required": ["phone_number", "phone_number_type"] } }, - "owner_id": {"type": ["string", "null"]}, + "owner_id": { + "type": ["string", "null"] + }, "lifecycle_stage": { "oneOf": [ - {"$ref": "#/components/schemas/crm.lifecycle_stage"}, - {"type": "null"} + { + "$ref": "#/components/schemas/crm.lifecycle_stage" + }, + { + "type": "null" + } ] }, "passthrough_fields": { @@ -8378,14 +9374,23 @@ "crm.contact": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "first_name": {"type": ["string", "null"]}, - "last_name": {"type": ["string", "null"]}, + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "first_name": { + "type": ["string", "null"] + }, + "last_name": { + "type": ["string", "null"] + }, "email": { "type": ["string", "null"], "description": "Primary email address" @@ -8400,8 +9405,12 @@ "crm.contact_input": { "type": "object", "properties": { - "first_name": {"type": ["string", "null"]}, - "last_name": {"type": ["string", "null"]}, + "first_name": { + "type": ["string", "null"] + }, + "last_name": { + "type": ["string", "null"] + }, "email": { "type": ["string", "null"], "description": "Primary email address" @@ -8419,36 +9428,67 @@ "crm.lead": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "name": {"type": ["string", "null"]}, - "first_name": {"type": ["string", "null"]}, - "last_name": {"type": ["string", "null"]}, - "owner_id": {"type": ["string", "null"]}, - "title": {"type": ["string", "null"]}, - "company": {"type": ["string", "null"]}, - "converted_date": {"type": ["string", "null"]}, - "lead_source": {"type": ["string", "null"]}, - "converted_account_id": {"type": ["string", "null"]}, - "converted_contact_id": {"type": ["string", "null"]}, + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "name": { + "type": ["string", "null"] + }, + "first_name": { + "type": ["string", "null"] + }, + "last_name": { + "type": ["string", "null"] + }, + "owner_id": { + "type": ["string", "null"] + }, + "title": { + "type": ["string", "null"] + }, + "company": { + "type": ["string", "null"] + }, + "converted_date": { + "type": ["string", "null"] + }, + "lead_source": { + "type": ["string", "null"] + }, + "converted_account_id": { + "type": ["string", "null"] + }, + "converted_contact_id": { + "type": ["string", "null"] + }, "addresses": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/crm.address"} + "items": { + "$ref": "#/components/schemas/crm.address" + } }, "email_addresses": { "type": ["array", "null"], - "items": {"$ref": "#/components/schemas/crm.email_address"} + "items": { + "$ref": "#/components/schemas/crm.email_address" + } }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": {"type": ["string", "null"]}, + "phone_number": { + "type": ["string", "null"] + }, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -8456,16 +9496,24 @@ "required": ["phone_number", "phone_number_type"] } }, - "created_at": {"type": ["string", "null"]}, - "is_deleted": {"type": ["boolean", "null"]}, - "last_modified_at": {"type": ["string", "null"]} + "created_at": { + "type": ["string", "null"] + }, + "is_deleted": { + "type": ["boolean", "null"] + }, + "last_modified_at": { + "type": ["string", "null"] + } }, "required": ["id", "updated_at"] }, "crm.email_address": { "type": "object", "properties": { - "email_address": {"type": "string"}, + "email_address": { + "type": "string" + }, "email_address_type": { "$ref": "#/components/schemas/crm.email_address_type" } @@ -8479,30 +9527,63 @@ "crm.opportunity": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "name": {"type": ["string", "null"]}, - "description": {"type": ["string", "null"]}, - "owner_id": {"type": ["string", "null"]}, + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "name": { + "type": ["string", "null"] + }, + "description": { + "type": ["string", "null"] + }, + "owner_id": { + "type": ["string", "null"] + }, "status": { "oneOf": [ - {"$ref": "#/components/schemas/crm.opportunity_status"}, - {"type": "null"} + { + "$ref": "#/components/schemas/crm.opportunity_status" + }, + { + "type": "null" + } ] }, - "stage": {"type": ["string", "null"]}, - "close_date": {"type": ["string", "null"]}, - "account_id": {"type": ["string", "null"]}, - "pipeline": {"type": ["string", "null"]}, - "amount": {"type": ["number", "null"]}, - "last_activity_at": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, - "is_deleted": {"type": ["boolean", "null"]}, - "last_modified_at": {"type": ["string", "null"]} + "stage": { + "type": ["string", "null"] + }, + "close_date": { + "type": ["string", "null"] + }, + "account_id": { + "type": ["string", "null"] + }, + "pipeline": { + "type": ["string", "null"] + }, + "amount": { + "type": ["number", "null"] + }, + "last_activity_at": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, + "is_deleted": { + "type": ["boolean", "null"] + }, + "last_modified_at": { + "type": ["string", "null"] + } }, "required": ["id", "updated_at"] }, @@ -8513,20 +9594,29 @@ "crm.note": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "content": {"type": ["string", "null"]} + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "content": { + "type": ["string", "null"] + } }, "required": ["id", "updated_at"] }, "crm.note_input": { "type": "object", "properties": { - "content": {"type": ["string", "null"]}, + "content": { + "type": ["string", "null"] + }, "passthrough_fields": { "type": ["object", "null"], "additionalProperties": {} @@ -8540,32 +9630,62 @@ "crm.user": { "type": "object", "properties": { - "id": {"type": "string"}, + "id": { + "type": "string" + }, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": {"type": "object", "additionalProperties": {}}, - "name": {"type": ["string", "null"]}, - "email": {"type": ["string", "null"]}, - "is_active": {"type": ["boolean", "null"]}, - "created_at": {"type": ["string", "null"]}, - "is_deleted": {"type": ["boolean", "null"]}, - "last_modified_at": {"type": ["string", "null"]} + "raw_data": { + "type": "object", + "additionalProperties": {} + }, + "name": { + "type": ["string", "null"] + }, + "email": { + "type": ["string", "null"] + }, + "is_active": { + "type": ["boolean", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, + "is_deleted": { + "type": ["boolean", "null"] + }, + "last_modified_at": { + "type": ["string", "null"] + } }, "required": ["id", "updated_at"] }, "warning": { "type": "object", "properties": { - "title": {"type": "string"}, - "problem_type": {"type": "string"}, - "detail": {"type": "string"} + "title": { + "type": "string" + }, + "problem_type": { + "type": "string" + }, + "detail": { + "type": "string" + } } }, "crm.meta.object": { "type": "object", - "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, "required": ["id", "name"] }, "crm.meta.custom_object_field": { @@ -8589,9 +9709,15 @@ }, "default_value": { "anyOf": [ - {"type": "string"}, - {"type": "number"}, - {"type": "boolean"} + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } ], "description": "The default value for the property. Only supported for Salesforce." }, @@ -8600,7 +9726,9 @@ "description": "Only applicable for Hubspot. If specified, OpenInt will attempt to attach the field to this group if it exists, or create it if it doesn't.", "example": "my group" }, - "type": {"$ref": "#/components/schemas/crm.meta.property_type"}, + "type": { + "$ref": "#/components/schemas/crm.meta.property_type" + }, "precision": { "type": "number", "description": "Only applicable in Salesforce. If not given, will default to 18." @@ -8611,7 +9739,9 @@ }, "options": { "type": "array", - "items": {"$ref": "#/components/schemas/crm.meta.pick_list_option"}, + "items": { + "$ref": "#/components/schemas/crm.meta.pick_list_option" + }, "description": "The list of options for a picklist/multipicklist field." }, "raw_details": { @@ -8641,10 +9771,21 @@ "crm.meta.pick_list_option": { "type": "object", "properties": { - "label": {"type": "string", "example": "Option 1"}, - "value": {"type": "string", "example": "option_1"}, - "description": {"type": "string"}, - "hidden": {"type": "boolean", "description": "Defaults to false."} + "label": { + "type": "string", + "example": "Option 1" + }, + "value": { + "type": "string", + "example": "option_1" + }, + "description": { + "type": "string" + }, + "hidden": { + "type": "boolean", + "description": "Defaults to false." + } }, "required": ["label", "value"] }, @@ -8678,76 +9819,150 @@ "crm.meta.association_schema": { "type": "object", "properties": { - "id": {"type": "string"}, - "source_object": {"type": "string", "example": "contact"}, - "target_object": {"type": "string", "example": "my_custom_object"}, - "display_name": {"type": "string"} + "id": { + "type": "string" + }, + "source_object": { + "type": "string", + "example": "contact" + }, + "target_object": { + "type": "string", + "example": "my_custom_object" + }, + "display_name": { + "type": "string" + } }, "required": ["id", "source_object", "target_object", "display_name"] }, "banking.account": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "current_balance": {"type": "number"}, - "currency": {"type": "string"} + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "current_balance": { + "type": "number" + }, + "currency": { + "type": "string" + } }, "required": ["id", "name"] }, "banking.merchant": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "url": {"type": ["string", "null"]} + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": ["string", "null"] + } }, "required": ["id", "name"] }, "banking.category": { "type": "object", - "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, "required": ["id", "name"] }, "banking.transaction": { "type": "object", "properties": { - "id": {"type": "string"}, - "date": {"type": "string"}, - "description": {"type": ["string", "null"]}, - "category_id": {"type": ["string", "null"]}, - "category_name": {"type": ["string", "null"]}, - "amount": {"type": "number"}, - "currency": {"type": "string"}, - "merchant_id": {"type": ["string", "null"]}, - "merchant_name": {"type": ["string", "null"]}, - "account_id": {"type": ["string", "null"]}, - "account_name": {"type": ["string", "null"]} + "id": { + "type": "string" + }, + "date": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, + "category_id": { + "type": ["string", "null"] + }, + "category_name": { + "type": ["string", "null"] + }, + "amount": { + "type": "number" + }, + "currency": { + "type": "string" + }, + "merchant_id": { + "type": ["string", "null"] + }, + "merchant_name": { + "type": ["string", "null"] + }, + "account_id": { + "type": ["string", "null"] + }, + "account_name": { + "type": ["string", "null"] + } }, "required": ["id", "date", "amount", "currency"] }, "ats.job": { "type": "object", "properties": { - "id": {"type": "string"}, - "created_at": {"type": "string"}, - "modified_at": {"type": "string"}, - "name": {"type": "string"}, - "confidential": {"type": "boolean"}, + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "modified_at": { + "type": "string" + }, + "name": { + "type": "string" + }, + "confidential": { + "type": "boolean" + }, "departments": { "type": "array", - "items": {"$ref": "#/components/schemas/ats.department"} + "items": { + "$ref": "#/components/schemas/ats.department" + } }, "offices": { "type": ["array", "null"], - "items": {"type": "object", "additionalProperties": {}} + "items": { + "type": "object", + "additionalProperties": {} + } }, "hiring_managers": {}, "recruiters": { "type": ["array", "null"], - "items": {"type": "object", "additionalProperties": {}} + "items": { + "type": "object", + "additionalProperties": {} + } }, - "raw_data": {"type": "object", "additionalProperties": {}} + "raw_data": { + "type": "object", + "additionalProperties": {} + } }, "required": [ "id", @@ -8762,33 +9977,65 @@ "ats.department": { "type": "object", "properties": { - "id": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, - "modified_at": {"type": ["string", "null"]}, - "name": {"type": ["string", "null"]}, - "parent_id": {"type": ["string", "null"]}, - "parent_department_external_id": {"type": ["string", "null"]}, + "id": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, + "modified_at": { + "type": ["string", "null"] + }, + "name": { + "type": ["string", "null"] + }, + "parent_id": { + "type": ["string", "null"] + }, + "parent_department_external_id": { + "type": ["string", "null"] + }, "child_ids": { "type": ["array", "null"], - "items": {"type": ["string", "null"]} + "items": { + "type": ["string", "null"] + } }, "child_department_external_ids": { "type": ["array", "null"], - "items": {"type": ["string", "null"]} + "items": { + "type": ["string", "null"] + } }, - "raw_data": {"type": "object", "additionalProperties": {}} + "raw_data": { + "type": "object", + "additionalProperties": {} + } }, "description": "A department in an organization" }, "ats.opening": { "type": "object", "properties": { - "id": {"type": "string"}, - "created_at": {"type": "string"}, - "modified_at": {"type": "string"}, - "status": {"type": "string"}, - "job_id": {"type": "string"}, - "raw_data": {"type": "object", "additionalProperties": {}} + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "modified_at": { + "type": "string" + }, + "status": { + "type": "string" + }, + "job_id": { + "type": "string" + }, + "raw_data": { + "type": "object", + "additionalProperties": {} + } }, "required": ["id", "created_at", "modified_at", "status", "job_id"], "description": "An opening for a job" @@ -8796,15 +10043,34 @@ "ats.offer": { "type": "object", "properties": { - "id": {"type": "string"}, - "created_at": {"type": "string"}, - "modified_at": {"type": "string"}, - "application": {"type": ["string", "null"]}, - "closed_at": {"type": ["string", "null"]}, - "sent_at": {"type": ["string", "null"]}, - "start_date": {"type": ["string", "null"]}, - "status": {"type": ["string", "null"]}, - "raw_data": {"type": "object", "additionalProperties": {}} + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "modified_at": { + "type": "string" + }, + "application": { + "type": ["string", "null"] + }, + "closed_at": { + "type": ["string", "null"] + }, + "sent_at": { + "type": ["string", "null"] + }, + "start_date": { + "type": ["string", "null"] + }, + "status": { + "type": ["string", "null"] + }, + "raw_data": { + "type": "object", + "additionalProperties": {} + } }, "required": ["id", "created_at", "modified_at"], "description": "An offer to a candidate" @@ -8812,30 +10078,75 @@ "ats.candidate": { "type": "object", "properties": { - "id": {"type": "string"}, - "created_at": {"type": ["string", "null"]}, - "modified_at": {"type": ["string", "null"]}, - "name": {"type": ["string", "null"]}, - "first_name": {"type": ["string", "null"]}, - "last_name": {"type": ["string", "null"]}, - "company": {"type": ["string", "null"]}, - "title": {"type": ["string", "null"]}, - "last_interaction_at": {"type": ["string", "null"]}, - "is_private": {"type": ["boolean", "null"]}, - "can_email": {"type": ["boolean", "null"]}, - "locations": {"type": ["array", "null"], "items": {}}, + "id": { + "type": "string" + }, + "created_at": { + "type": ["string", "null"] + }, + "modified_at": { + "type": ["string", "null"] + }, + "name": { + "type": ["string", "null"] + }, + "first_name": { + "type": ["string", "null"] + }, + "last_name": { + "type": ["string", "null"] + }, + "company": { + "type": ["string", "null"] + }, + "title": { + "type": ["string", "null"] + }, + "last_interaction_at": { + "type": ["string", "null"] + }, + "is_private": { + "type": ["boolean", "null"] + }, + "can_email": { + "type": ["boolean", "null"] + }, + "locations": { + "type": ["array", "null"], + "items": {} + }, "phone_numbers": { "type": ["array", "null"], - "items": {"type": "object", "additionalProperties": {}} + "items": { + "type": "object", + "additionalProperties": {} + } }, "email_addresses": { "type": ["array", "null"], - "items": {"type": "object", "additionalProperties": {}} + "items": { + "type": "object", + "additionalProperties": {} + } + }, + "tags": { + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "applications": { + "type": ["array", "null"], + "items": {} + }, + "attachments": { + "type": ["array", "null"], + "items": {} }, - "tags": {"type": ["array", "null"], "items": {"type": "string"}}, - "applications": {"type": ["array", "null"], "items": {}}, - "attachments": {"type": ["array", "null"], "items": {}}, - "raw_data": {"type": "object", "additionalProperties": {}} + "raw_data": { + "type": "object", + "additionalProperties": {} + } }, "required": ["id"], "description": "A candidate for a job" @@ -8843,11 +10154,21 @@ "unified.drivegroup": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "description": {"type": ["string", "null"]}, - "updated_at": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, + "updated_at": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, "raw_data": {} }, "required": ["id", "name"], @@ -8856,11 +10177,21 @@ "unified.drive": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "description": {"type": ["string", "null"]}, - "updated_at": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, + "updated_at": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, "raw_data": {} }, "required": ["id", "name"], @@ -8869,26 +10200,55 @@ "unified.file": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": ["string", "null"]}, - "description": {"type": ["string", "null"]}, - "type": {"type": "string", "enum": ["file", "folder", "url"]}, - "path": {"type": ["string", "null"]}, - "mime_type": {"type": ["string", "null"]}, - "downloadable": {"type": "boolean"}, - "size": {"type": ["number", "null"]}, + "id": { + "type": "string" + }, + "name": { + "type": ["string", "null"] + }, + "description": { + "type": ["string", "null"] + }, + "type": { + "type": "string", + "enum": ["file", "folder", "url"] + }, + "path": { + "type": ["string", "null"] + }, + "mime_type": { + "type": ["string", "null"] + }, + "downloadable": { + "type": "boolean" + }, + "size": { + "type": ["number", "null"] + }, "permissions": { "type": "object", - "properties": {"download": {"type": "boolean"}}, + "properties": { + "download": { + "type": "boolean" + } + }, "required": ["download"] }, - "exportable": {"type": "boolean"}, + "exportable": { + "type": "boolean" + }, "export_formats": { "type": ["array", "null"], - "items": {"type": "string"} + "items": { + "type": "string" + } + }, + "updated_at": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] }, - "updated_at": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, "raw_data": {} }, "required": ["id", "type", "downloadable", "permissions", "exportable"], @@ -8897,12 +10257,24 @@ "unified.folder": { "type": "object", "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "description": {"type": ["string", "null"]}, - "path": {"type": "string"}, - "updated_at": {"type": ["string", "null"]}, - "created_at": {"type": ["string", "null"]}, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, + "path": { + "type": "string" + }, + "updated_at": { + "type": ["string", "null"] + }, + "created_at": { + "type": ["string", "null"] + }, "raw_data": {} }, "required": ["id", "name", "path"], @@ -8910,5 +10282,10 @@ } } }, - "security": [{"apikey": [], "connectionId": []}] + "security": [ + { + "apikey": [], + "connectionId": [] + } + ] } diff --git a/sdks/sdk-openint/openint.oas.types.d.ts b/sdks/sdk-openint/openint.oas.types.d.ts index 4bba259..6d04946 100644 --- a/sdks/sdk-openint/openint.oas.types.d.ts +++ b/sdks/sdk-openint/openint.oas.types.d.ts @@ -2705,12 +2705,6 @@ export interface operations { * @enum {string|null} */ view?: 'manage' | 'manage-deeplink' | 'add' | 'add-deeplink' | null - /** @description Filter connector config by displayName */ - connectorConfigDisplayName?: string | null - /** @description Must start with 'ccfg_' */ - connectorConfigId?: string - /** @default true */ - showExisting?: boolean } } } diff --git a/sdks/sdk-openint/package.json b/sdks/sdk-openint/package.json index c178ca7..def3609 100644 --- a/sdks/sdk-openint/package.json +++ b/sdks/sdk-openint/package.json @@ -1,6 +1,6 @@ { "name": "@opensdks/sdk-openint", - "version": "0.1.7", + "version": "0.1.10", "type": "module", "exports": { ".": { From 060665128bffef07da1fd4767f6a46483607d625 Mon Sep 17 00:00:00 2001 From: Amadeo Pellicce Date: Thu, 23 Jan 2025 19:44:32 -0800 Subject: [PATCH 2/5] new sdk version --- sdks/sdk-openint/openint.oas.json | 5942 +++++++++-------------- sdks/sdk-openint/openint.oas.types.d.ts | 100 + sdks/sdk-openint/package.json | 2 +- 3 files changed, 2429 insertions(+), 3615 deletions(-) diff --git a/sdks/sdk-openint/openint.oas.json b/sdks/sdk-openint/openint.oas.json index 309aa49..5533306 100644 --- a/sdks/sdk-openint/openint.oas.json +++ b/sdks/sdk-openint/openint.oas.json @@ -1,15 +1,125 @@ { "openapi": "3.1.0", - "info": { - "title": "OpenInt OpenAPI", - "version": "0.0.0" - }, - "servers": [ - { - "url": "https://api.openint.dev/v0" - } - ], + "info": {"title": "OpenInt OpenAPI", "version": "0.0.0"}, + "servers": [{"url": "https://api.openint.dev/v0"}], "paths": { + "/health": { + "get": { + "operationId": "health", + "summary": "Health check", + "tags": ["Internal"], + "parameters": [ + {"in": "query", "name": "exp", "schema": {"type": "boolean"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "healthy": {"type": "boolean"}, + "error": {"type": "string"}, + "deps": { + "type": "object", + "properties": { + "nango": {"type": "boolean"}, + "inngest": {"type": "boolean"}, + "clerk": {"type": "boolean"} + }, + "required": ["nango", "inngest", "clerk"] + } + }, + "required": ["healthy"] + } + } + } + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/clerk-testing-token": { + "get": { + "operationId": "createClerkTestingToken", + "summary": "Create clerk testing token", + "tags": ["Internal"], + "parameters": [ + { + "in": "query", + "name": "secret", + "schema": {"type": "string"}, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {"testing_token": {"type": "string"}}, + "required": ["testing_token"] + } + } + } + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, "/connect/token": { "post": { "operationId": "createConnectToken", @@ -44,11 +154,7 @@ "application/json": { "schema": { "type": "object", - "properties": { - "token": { - "type": "string" - } - }, + "properties": {"token": {"type": "string"}}, "required": ["token"] } } @@ -58,9 +164,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -146,11 +250,7 @@ "application/json": { "schema": { "type": "object", - "properties": { - "url": { - "type": "string" - } - }, + "properties": {"url": {"type": "string"}}, "required": ["url"] } } @@ -160,9 +260,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -205,86 +303,36 @@ "type": ["string", "null"], "enum": ["light", "dark"] }, - "multiSelect": { - "type": ["boolean", "null"] - }, - "folderSelect": { - "type": ["boolean", "null"] - }, + "multiSelect": {"type": ["boolean", "null"]}, + "folderSelect": {"type": ["boolean", "null"]}, "themeColors": { "type": ["object", "null"], "properties": { - "accent": { - "type": ["string", "null"] - }, - "background": { - "type": ["string", "null"] - }, - "border": { - "type": ["string", "null"] - }, - "button": { - "type": ["string", "null"] - }, - "buttonLight": { - "type": ["string", "null"] - }, - "buttonForeground": { - "type": ["string", "null"] - }, - "buttonHover": { - "type": ["string", "null"] - }, - "buttonStroke": { - "type": ["string", "null"] - }, - "buttonSecondary": { - "type": ["string", "null"] - }, - "buttonSecondaryForeground": { - "type": ["string", "null"] - }, - "buttonSecondaryStroke": { - "type": ["string", "null"] - }, - "buttonSecondaryHover": { - "type": ["string", "null"] - }, - "card": { - "type": ["string", "null"] - }, - "cardForeground": { - "type": ["string", "null"] - }, - "foreground": { - "type": ["string", "null"] - }, - "navbar": { - "type": ["string", "null"] - }, - "primary": { - "type": ["string", "null"] - }, - "primaryForeground": { - "type": ["string", "null"] - }, - "secondary": { - "type": ["string", "null"] - }, - "secondaryForeground": { - "type": ["string", "null"] - }, - "sidebar": { - "type": ["string", "null"] - }, - "tab": { - "type": ["string", "null"] - } + "accent": {"type": ["string", "null"]}, + "background": {"type": ["string", "null"]}, + "border": {"type": ["string", "null"]}, + "button": {"type": ["string", "null"]}, + "buttonLight": {"type": ["string", "null"]}, + "buttonForeground": {"type": ["string", "null"]}, + "buttonHover": {"type": ["string", "null"]}, + "buttonStroke": {"type": ["string", "null"]}, + "buttonSecondary": {"type": ["string", "null"]}, + "buttonSecondaryForeground": {"type": ["string", "null"]}, + "buttonSecondaryStroke": {"type": ["string", "null"]}, + "buttonSecondaryHover": {"type": ["string", "null"]}, + "card": {"type": ["string", "null"]}, + "cardForeground": {"type": ["string", "null"]}, + "foreground": {"type": ["string", "null"]}, + "navbar": {"type": ["string", "null"]}, + "primary": {"type": ["string", "null"]}, + "primaryForeground": {"type": ["string", "null"]}, + "secondary": {"type": ["string", "null"]}, + "secondaryForeground": {"type": ["string", "null"]}, + "sidebar": {"type": ["string", "null"]}, + "tab": {"type": ["string", "null"]} } }, - "connectionId": { - "type": "string" - } + "connectionId": {"type": "string"} }, "required": ["connectionId"] } @@ -298,11 +346,7 @@ "application/json": { "schema": { "type": "object", - "properties": { - "url": { - "type": "string" - } - }, + "properties": {"url": {"type": "string"}}, "required": ["url"] } } @@ -312,9 +356,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -340,9 +382,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -350,12 +390,7 @@ "required": true, "content": { "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": {} - } - } + "schema": {"type": "object", "properties": {"metadata": {}}} } } }, @@ -367,12 +402,8 @@ "schema": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "orgId": { - "type": "string" - }, + "id": {"type": "string"}, + "orgId": {"type": "string"}, "metadata": {} }, "required": ["id", "orgId"] @@ -384,9 +415,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -394,9 +423,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -413,11 +440,11 @@ } } }, - "/core/connection": { + "/passthrough": { "post": { - "operationId": "createConnection", - "summary": "Create connection", - "tags": ["Core"], + "operationId": "passthrough", + "summary": "Passthrough", + "tags": ["Internal"], "requestBody": { "required": true, "content": { @@ -425,33 +452,16 @@ "schema": { "type": "object", "properties": { - "connectorConfigId": { + "method": { "type": "string", - "description": "Must start with 'ccfg_'" - }, - "settings": { - "type": ["object", "null"], - "additionalProperties": {} - }, - "displayName": { - "type": ["string", "null"] - }, - "customerId": { - "type": ["string", "null"], - "minLength": 1 - }, - "disabled": { - "type": "boolean" - }, - "metadata": { - "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" + "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"] }, - "integrationId": { - "type": ["string", "null"], - "description": "Must start with 'int_'" - } + "path": {"type": "string"}, + "query": {"type": "object", "additionalProperties": {}}, + "headers": {"type": "object", "additionalProperties": {}}, + "body": {"type": "object", "additionalProperties": {}} }, - "required": ["connectorConfigId"] + "required": ["method", "path"] } } } @@ -459,21 +469,13 @@ "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -488,64 +490,42 @@ } } } - }, - "get": { - "operationId": "listConnection", - "summary": "List connections", - "tags": ["Core"], + } + }, + "/core/connection/{id}/source_sync": { + "post": { + "operationId": "sourceSync", + "summary": "Source sync", + "description": "Return records that would have otherwise been emitted during a sync and return it instead", + "tags": ["Internal"], "parameters": [ { - "in": "query", - "name": "limit", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "offset", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "customerId", - "schema": { - "type": ["string", "null"], - "minLength": 1 - } - }, - { - "in": "query", - "name": "connectorConfigId", - "schema": { - "type": ["string", "null"], - "description": "Must start with 'ccfg_'" - } - }, - { - "in": "query", - "name": "connectorName", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "forceRefresh", - "schema": { - "type": "boolean" - } - }, - { - "in": "query", - "name": "expand", + "in": "path", + "name": "id", "schema": { - "type": "string" - } + "type": "string", + "description": "Must start with 'conn_'" + }, + "required": true } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": {"type": "object", "additionalProperties": {}}, + "streams": { + "type": "object", + "additionalProperties": {"type": "boolean"} + } + } + } + } + } + }, "responses": { "200": { "description": "Successful response", @@ -553,14 +533,136 @@ "application/json": { "schema": { "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/Connection" - } - ], - "type": "object", - "properties": { + "items": {"type": "object", "additionalProperties": {}} + } + } + } + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/core/connection": { + "post": { + "operationId": "createConnection", + "summary": "Create connection", + "tags": ["Core"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "connectorConfigId": { + "type": "string", + "description": "Must start with 'ccfg_'" + }, + "settings": { + "type": ["object", "null"], + "additionalProperties": {} + }, + "displayName": {"type": ["string", "null"]}, + "customerId": {"type": ["string", "null"], "minLength": 1}, + "disabled": {"type": "boolean"}, + "metadata": { + "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" + }, + "integrationId": { + "type": ["string", "null"], + "description": "Must start with 'int_'" + } + }, + "required": ["connectorConfigId"] + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {"type": "string"}}} + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + }, + "get": { + "operationId": "listConnection", + "summary": "List connections", + "tags": ["Core"], + "parameters": [ + {"in": "query", "name": "limit", "schema": {"type": "number"}}, + {"in": "query", "name": "offset", "schema": {"type": "number"}}, + { + "in": "query", + "name": "customerId", + "schema": {"type": ["string", "null"], "minLength": 1} + }, + { + "in": "query", + "name": "connectorConfigId", + "schema": { + "type": ["string", "null"], + "description": "Must start with 'ccfg_'" + } + }, + { + "in": "query", + "name": "connectorName", + "schema": {"type": ["string", "null"]} + }, + { + "in": "query", + "name": "forceRefresh", + "schema": {"type": "boolean"} + }, + {"in": "query", "name": "expand", "schema": {"type": "string"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "allOf": [{"$ref": "#/components/schemas/Connection"}], + "type": "object", + "properties": { "integration": { "type": ["object", "null"], "properties": { @@ -568,13 +670,8 @@ "type": "string", "description": "Must start with 'int_'" }, - "name": { - "type": "string" - }, - "logoUrl": { - "type": "string", - "format": "uri" - } + "name": {"type": "string"}, + "logoUrl": {"type": "string", "format": "uri"} }, "required": ["id", "name", "logoUrl"] }, @@ -585,13 +682,8 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "name": { - "type": "string" - }, - "logoUrl": { - "type": "string", - "format": "uri" - } + "name": {"type": "string"}, + "logoUrl": {"type": "string", "format": "uri"} }, "required": ["id", "name", "logoUrl"] } @@ -605,9 +697,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -615,9 +705,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -661,19 +749,12 @@ "type": ["object", "null"], "additionalProperties": {} }, - "displayName": { - "type": ["string", "null"] - }, + "displayName": {"type": ["string", "null"]}, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": { - "type": "boolean" - }, - "customerId": { - "type": ["string", "null"], - "minLength": 1 - }, + "disabled": {"type": "boolean"}, + "customerId": {"type": ["string", "null"], "minLength": 1}, "integrationId": { "type": ["string", "null"], "description": "Must start with 'int_'" @@ -688,9 +769,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Connection" - } + "schema": {"$ref": "#/components/schemas/Connection"} } } }, @@ -698,9 +777,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -708,9 +785,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -740,23 +815,14 @@ }, "required": true }, - { - "in": "query", - "name": "skipRevoke", - "schema": { - "type": "boolean" - } - } + {"in": "query", "name": "skipRevoke", "schema": {"type": "boolean"}} ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { - "schema": { - "type": "object", - "properties": {} - } + "schema": {"type": "object", "properties": {}} } } }, @@ -764,9 +830,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -774,9 +838,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -809,17 +871,9 @@ { "in": "query", "name": "forceRefresh", - "schema": { - "type": "boolean" - } + "schema": {"type": "boolean"} }, - { - "in": "query", - "name": "expand", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "expand", "schema": {"type": "string"}} ], "responses": { "200": { @@ -827,11 +881,7 @@ "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Connection" - } - ], + "allOf": [{"$ref": "#/components/schemas/Connection"}], "type": "object", "properties": { "connector_config": { @@ -845,9 +895,7 @@ "type": "string", "description": "Must start with 'org_'" }, - "connectorName": { - "type": "string" - } + "connectorName": {"type": "string"} }, "required": ["id", "orgId", "connectorName"] }, @@ -858,13 +906,8 @@ "type": "string", "description": "Must start with 'int_'" }, - "name": { - "type": "string" - }, - "logoUrl": { - "type": "string", - "format": "uri" - } + "name": {"type": "string"}, + "logoUrl": {"type": "string", "format": "uri"} }, "required": ["id", "name", "logoUrl"] }, @@ -875,13 +918,8 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "name": { - "type": "string" - }, - "logoUrl": { - "type": "string", - "format": "uri" - } + "name": {"type": "string"}, + "logoUrl": {"type": "string", "format": "uri"} }, "required": ["id", "name", "logoUrl"] } @@ -895,9 +933,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -905,9 +941,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -947,21 +981,11 @@ "schema": { "type": "object", "properties": { - "skipCache": { - "type": ["boolean", "null"] - }, - "import": { - "type": ["boolean", "null"] - }, - "updateWebhook": { - "type": ["boolean", "null"] - }, - "sandboxSimulateUpdate": { - "type": ["boolean", "null"] - }, - "sandboxSimulateDisconnect": { - "type": ["boolean", "null"] - } + "skipCache": {"type": ["boolean", "null"]}, + "import": {"type": ["boolean", "null"]}, + "updateWebhook": {"type": ["boolean", "null"]}, + "sandboxSimulateUpdate": {"type": ["boolean", "null"]}, + "sandboxSimulateDisconnect": {"type": ["boolean", "null"]} } } } @@ -970,19 +994,13 @@ "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": {} - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1055,20 +1073,14 @@ "schema": { "type": "object", "properties": { - "connection_requested_event_id": { - "type": "string" - }, + "connection_requested_event_id": {"type": "string"}, "pipeline_syncs": { "type": "array", "items": { "type": "object", "properties": { - "pipeline_id": { - "type": "string" - }, - "sync_completed_event_id": { - "type": "string" - } + "pipeline_id": {"type": "string"}, + "sync_completed_event_id": {"type": "string"} }, "required": ["pipeline_id", "sync_completed_event_id"] } @@ -1082,9 +1094,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1113,9 +1123,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ConnectorConfig" - } + "items": {"$ref": "#/components/schemas/ConnectorConfig"} } } } @@ -1147,9 +1155,7 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "connectorName": { - "type": "string" - }, + "connectorName": {"type": "string"}, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -1158,23 +1164,17 @@ "type": ["object", "null"], "additionalProperties": {} }, - "displayName": { - "type": ["string", "null"] - }, + "displayName": {"type": ["string", "null"]}, "defaultPipeOut": { "type": ["object", "null"], "properties": { "streams": { "type": ["object", "null"], - "additionalProperties": { - "type": "boolean" - } + "additionalProperties": {"type": "boolean"} }, "links": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/Link" - }, + "items": {"$ref": "#/components/schemas/Link"}, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "destination_id": { @@ -1189,9 +1189,7 @@ "properties": { "links": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/Link" - }, + "items": {"$ref": "#/components/schemas/Link"}, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "source_id": { @@ -1218,9 +1216,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorConfig" - } + "schema": {"$ref": "#/components/schemas/ConnectorConfig"} } } }, @@ -1228,9 +1224,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1273,9 +1267,7 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "displayName": { - "type": ["string", "null"] - }, + "displayName": {"type": ["string", "null"]}, "disabled": { "type": "boolean", "title": "Disabled", @@ -1291,9 +1283,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorConfig" - } + "schema": {"$ref": "#/components/schemas/ConnectorConfig"} } } }, @@ -1301,9 +1291,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1311,9 +1299,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1347,19 +1333,13 @@ "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": {} - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1367,9 +1347,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1405,9 +1383,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorConfig" - } + "schema": {"$ref": "#/components/schemas/ConnectorConfig"} } } }, @@ -1415,9 +1391,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1425,9 +1399,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1470,9 +1442,7 @@ { "in": "query", "name": "connectorName", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -1489,21 +1459,11 @@ "type": "string", "description": "Must start with 'ccfg_'" }, - "envName": { - "type": ["string", "null"] - }, - "displayName": { - "type": ["string", "null"] - }, - "connectorName": { - "type": "string" - }, - "isSource": { - "type": "boolean" - }, - "isDestination": { - "type": "boolean" - }, + "envName": {"type": ["string", "null"]}, + "displayName": {"type": ["string", "null"]}, + "connectorName": {"type": "string"}, + "isSource": {"type": "boolean"}, + "isDestination": {"type": "boolean"}, "verticals": { "type": "array", "items": { @@ -1533,9 +1493,7 @@ }, "integrations": { "type": "array", - "items": { - "type": "string" - } + "items": {"type": "string"} } }, "required": [ @@ -1555,9 +1513,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1565,9 +1521,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1584,27 +1538,373 @@ } } }, - "/core/pipeline": { + "/connector": { "get": { - "operationId": "listPipelines", - "summary": "List pipelines", - "tags": ["Core"], + "operationId": "listConnectorMetas", + "summary": "List connector metas", + "description": "Get catalog of all available connectors", + "tags": ["Connectors"], "parameters": [ - { - "in": "query", - "name": "limit", - "schema": { - "type": "number" - } + {"in": "query", "name": "includeOas", "schema": {"type": "boolean"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {}}} }, - { - "in": "query", - "name": "offset", - "schema": { - "type": "number" + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } } }, - { + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/connector/{name}": { + "get": { + "operationId": "getConnectorMeta", + "summary": "Get connector meta", + "tags": ["Connectors"], + "parameters": [ + { + "in": "path", + "name": "name", + "schema": {"type": "string"}, + "required": true + }, + {"in": "query", "name": "includeOas", "schema": {"type": "boolean"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {}}} + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/connector/{name}/oas": { + "get": { + "operationId": "getConnectorOpenApiSpec", + "summary": "Get connector open api spec", + "tags": ["Connectors"], + "parameters": [ + { + "in": "path", + "name": "name", + "schema": {"type": "string"}, + "required": true + }, + {"in": "query", "name": "original", "schema": {"type": "boolean"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {}}} + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/connector/{name}/schemas": { + "get": { + "operationId": "getConnectorSchemas", + "summary": "Get connector schemas", + "tags": ["Connectors"], + "parameters": [ + { + "in": "path", + "name": "name", + "schema": {"type": "string"}, + "required": true + }, + {"in": "query", "name": "type", "schema": {"type": "string"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {}}} + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/connector/{name}/integrations": { + "get": { + "operationId": "listConnectorIntegrations", + "summary": "List connector integrations", + "tags": ["Connectors"], + "parameters": [ + { + "in": "path", + "name": "name", + "schema": {"type": "string"}, + "required": true + }, + { + "in": "query", + "name": "sync_mode", + "schema": {"type": "string", "enum": ["full", "incremental"]} + }, + { + "in": "query", + "name": "cursor", + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, + { + "in": "query", + "name": "search_text", + "schema": {"type": ["string", "null"]} + }, + { + "in": "query", + "name": "ccfgId", + "schema": { + "type": "string", + "description": "Must start with 'ccfg_'" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": { + "type": "array", + "items": {"$ref": "#/components/schemas/core.integration"} + } + }, + "required": ["has_next_page", "items"] + } + } + } + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/configured_integrations": { + "get": { + "operationId": "listConfiguredIntegrations", + "summary": "List configured integrations", + "tags": ["Connectors"], + "parameters": [ + { + "in": "query", + "name": "sync_mode", + "schema": {"type": "string", "enum": ["full", "incremental"]} + }, + { + "in": "query", + "name": "cursor", + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, + {"in": "query", "name": "search_text", "schema": {"type": "string"}}, + { + "in": "query", + "name": "connector_config_ids", + "schema": {"type": "array", "items": {"type": "string"}} + }, + { + "in": "query", + "name": "connectorNames", + "schema": {"type": "array", "items": {"type": "string"}} + }, + { + "in": "query", + "name": "integrationIds", + "schema": {"type": "array", "items": {"type": "string"}} + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/core.configured_integration" + } + } + }, + "required": ["has_next_page", "items"] + } + } + } + }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/core/pipeline": { + "get": { + "operationId": "listPipelines", + "summary": "List pipelines", + "tags": ["Core"], + "parameters": [ + {"in": "query", "name": "limit", "schema": {"type": "number"}}, + {"in": "query", "name": "offset", "schema": {"type": "number"}}, + { "in": "query", "name": "connectionIds", "schema": { @@ -1623,9 +1923,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/Pipeline" - } + "items": {"$ref": "#/components/schemas/Pipeline"} } } } @@ -1634,9 +1932,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1644,9 +1940,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1680,9 +1974,7 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": { - "type": "boolean" - }, + "disabled": {"type": "boolean"}, "sourceId": { "type": "string", "description": "Must start with 'conn_'" @@ -1692,15 +1984,8 @@ "additionalProperties": { "type": "object", "properties": { - "disabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - } + "disabled": {"type": "boolean"}, + "fields": {"type": "array", "items": {"type": "string"}} } } }, @@ -1719,9 +2004,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Pipeline" - } + "schema": {"$ref": "#/components/schemas/Pipeline"} } } }, @@ -1729,9 +2012,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1774,23 +2055,14 @@ "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" }, - "disabled": { - "type": "boolean" - }, + "disabled": {"type": "boolean"}, "streams": { "type": ["object", "null"], "additionalProperties": { "type": "object", "properties": { - "disabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - } + "disabled": {"type": "boolean"}, + "fields": {"type": "array", "items": {"type": "string"}} } } } @@ -1804,9 +2076,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Pipeline" - } + "schema": {"$ref": "#/components/schemas/Pipeline"} } } }, @@ -1814,9 +2084,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1824,9 +2092,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1862,10 +2128,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "type": "boolean", - "enum": [true] - } + "schema": {"type": "boolean", "enum": [true]} } } }, @@ -1873,9 +2136,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1883,9 +2144,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -1955,10 +2214,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "type": "object", - "properties": {} - } + "schema": {"type": "object", "properties": {}} } } }, @@ -1966,9 +2222,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -1994,47 +2248,29 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } + "schema": {"type": ["string", "null"]} }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", "name": "since", - "schema": { - "type": "integer" - }, + "schema": {"type": "integer"}, "required": true }, { "in": "query", "name": "customerId", - "schema": { - "type": ["string", "null"], - "minLength": 1 - } + "schema": {"type": ["string", "null"], "minLength": 1} }, { "in": "query", "name": "name", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2045,17 +2281,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } + "items": {"$ref": "#/components/schemas/Event"} } }, "required": ["has_next_page", "items"] @@ -2065,23 +2295,251 @@ }, "400": { "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/viewer": { + "get": { + "operationId": "getViewer", + "summary": "Get current viewer accessing the API", + "tags": ["Internal"], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/Viewer"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/viewer/organization": { + "get": { + "operationId": "getCurrentOrganization", + "summary": "Get current organization of viewer accessing the API", + "tags": ["Internal"], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Must start with 'org_'" + }, + "slug": {"type": ["string", "null"]}, + "publicMetadata": { + "type": "object", + "properties": { + "database_url": { + "type": "string", + "title": "PostgreSQL Database URL", + "description": "This is where data from connections are synced to by default", + "example": "postgres://username:password@host:port/database" + }, + "synced_data_schema": { + "type": "string", + "title": "Synced Data Schema", + "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." + }, + "webhook_url": { + "type": "string", + "title": "Webhook URL", + "description": "Events like sync.completed and connection.created can be sent to url of your choosing" + }, + "migrate_tables": { + "type": "boolean", + "title": "Migrate Tables", + "description": "If enabled, table migrations will be run if needed when entities are persisted", + "default": true + } + } + } + }, + "required": ["id", "publicMetadata"] + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + }, + "patch": { + "operationId": "updateCurrentOrganization", + "summary": "Update current organization", + "tags": ["Internal"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "publicMetadata": { + "type": "object", + "properties": { + "database_url": { + "type": "string", + "title": "PostgreSQL Database URL", + "description": "This is where data from connections are synced to by default", + "example": "postgres://username:password@host:port/database" + }, + "synced_data_schema": { + "type": "string", + "title": "Synced Data Schema", + "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." + }, + "webhook_url": { + "type": "string", + "title": "Webhook URL", + "description": "Events like sync.completed and connection.created can be sent to url of your choosing" + }, + "migrate_tables": { + "type": "boolean", + "title": "Migrate Tables", + "description": "If enabled, table migrations will be run if needed when entities are persisted", + "default": true + } + } + } + }, + "required": ["publicMetadata"] + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Must start with 'org_'" + }, + "slug": {"type": ["string", "null"]}, + "publicMetadata": { + "type": "object", + "properties": { + "database_url": { + "type": "string", + "title": "PostgreSQL Database URL", + "description": "This is where data from connections are synced to by default", + "example": "postgres://username:password@host:port/database" + }, + "synced_data_schema": { + "type": "string", + "title": "Synced Data Schema", + "description": "Postgres schema to pipe data synced from customer connections into. Defaults to \"synced\" if missing." + }, + "webhook_url": { + "type": "string", + "title": "Webhook URL", + "description": "Events like sync.completed and connection.created can be sent to url of your choosing" + }, + "migrate_tables": { + "type": "boolean", + "title": "Migrate Tables", + "description": "If enabled, table migrations will be run if needed when entities are persisted", + "default": true + } + } + } + }, + "required": ["id", "publicMetadata"] } } } }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, "404": { "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } + } + } + } + }, + "/openapi.json": { + "get": { + "operationId": "public-getOpenapiDocument", + "summary": "Get openapi document", + "tags": ["Internal"], + "responses": { + "200": { + "description": "Successful response", + "content": {"application/json": {"schema": {}}} }, "500": { "description": "Internal server error", @@ -2105,9 +2563,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2118,9 +2574,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2137,9 +2591,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2147,9 +2599,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2175,9 +2625,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2188,9 +2636,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2207,9 +2653,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2217,9 +2661,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2245,9 +2687,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2258,9 +2698,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2277,9 +2715,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2287,9 +2723,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2354,11 +2788,7 @@ "properties": { "record": { "type": "object", - "properties": { - "id": { - "type": "string" - } - }, + "properties": {"id": {"type": "string"}}, "required": ["id"] } } @@ -2370,9 +2800,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2398,9 +2826,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2411,9 +2837,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2430,9 +2854,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2440,9 +2862,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2468,9 +2888,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2481,9 +2899,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2500,9 +2916,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2510,9 +2924,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2538,9 +2950,7 @@ { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} } ], "responses": { @@ -2551,9 +2961,7 @@ "schema": { "type": "object", "properties": { - "next_page_cursor": { - "type": ["string", "null"] - }, + "next_page_cursor": {"type": ["string", "null"]}, "items": { "type": "array", "items": { @@ -2570,9 +2978,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2580,9 +2986,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2665,11 +3069,7 @@ "properties": { "record": { "type": "object", - "properties": { - "id": { - "type": "string" - } - }, + "properties": {"id": {"type": "string"}}, "required": ["id"] } } @@ -2681,9 +3081,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2730,24 +3128,12 @@ "address": { "type": "object", "properties": { - "city": { - "type": ["string", "null"] - }, - "country": { - "type": ["string", "null"] - }, - "postal_code": { - "type": ["string", "null"] - }, - "state": { - "type": ["string", "null"] - }, - "street_1": { - "type": ["string", "null"] - }, - "street_2": { - "type": ["string", "null"] - } + "city": {"type": ["string", "null"]}, + "country": {"type": ["string", "null"]}, + "postal_code": {"type": ["string", "null"]}, + "state": {"type": ["string", "null"]}, + "street_1": {"type": ["string", "null"]}, + "street_2": {"type": ["string", "null"]} }, "example": { "city": "San Francisco", @@ -2763,9 +3149,7 @@ "items": { "type": "object", "properties": { - "email_address": { - "type": "string" - }, + "email_address": {"type": "string"}, "email_address_type": { "type": ["string", "null"], "enum": ["primary", "personal", "work"] @@ -2785,9 +3169,7 @@ "items": { "type": "object", "properties": { - "phone_number": { - "type": "string" - }, + "phone_number": {"type": "string"}, "phone_number_type": { "type": "string", "enum": [ @@ -2848,11 +3230,7 @@ "properties": { "record": { "type": "object", - "properties": { - "id": { - "type": "string" - } - }, + "properties": {"id": {"type": "string"}}, "required": ["id"] } } @@ -2864,9 +3242,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2892,9 +3268,7 @@ { "in": "path", "name": "entity", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -2905,11 +3279,7 @@ "application/json": { "schema": { "type": "object", - "properties": { - "count": { - "type": "number" - } - }, + "properties": {"count": {"type": "number"}}, "required": ["count"] } } @@ -2919,9 +3289,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -2929,9 +3297,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -2957,25 +3323,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -2985,17 +3340,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.account" - } + "items": {"$ref": "#/components/schemas/crm.account"} } }, "required": ["has_next_page", "items"] @@ -3007,9 +3356,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3017,9 +3364,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3046,9 +3391,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account_input" - } + "record": {"$ref": "#/components/schemas/crm.account_input"} }, "required": ["record"] } @@ -3063,9 +3406,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account" - } + "record": {"$ref": "#/components/schemas/crm.account"} }, "required": ["record"] } @@ -3076,9 +3417,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3104,9 +3443,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -3118,9 +3455,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account" - }, + "record": {"$ref": "#/components/schemas/crm.account"}, "raw": {} }, "required": ["record"] @@ -3132,9 +3467,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3142,9 +3475,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3168,9 +3499,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -3181,9 +3510,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account_input" - } + "record": {"$ref": "#/components/schemas/crm.account_input"} }, "required": ["record"] } @@ -3198,9 +3525,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account" - } + "record": {"$ref": "#/components/schemas/crm.account"} }, "required": ["record"] } @@ -3211,9 +3536,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3221,9 +3544,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3252,18 +3573,8 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": { - "type": "array", - "items": { - "type": "string" - } - } + "ids": {"type": "array", "items": {"type": "string"}}, + "properties": {"type": "array", "items": {"type": "string"}} }, "required": ["ids", "properties"] } @@ -3277,9 +3588,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.account" - } + "items": {"$ref": "#/components/schemas/crm.account"} } } } @@ -3288,9 +3597,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3329,17 +3636,13 @@ }, "values": { "type": "array", - "items": { - "type": "string" - }, + "items": {"type": "string"}, "description": "The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown." } }, "required": ["key", "values"] }, - "record": { - "$ref": "#/components/schemas/crm.account_input" - } + "record": {"$ref": "#/components/schemas/crm.account_input"} }, "required": ["upsert_on", "record"] } @@ -3354,9 +3657,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.account" - } + "record": {"$ref": "#/components/schemas/crm.account"} }, "required": ["record"] } @@ -3367,9 +3668,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3395,25 +3694,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -3423,17 +3711,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.contact" - } + "items": {"$ref": "#/components/schemas/crm.contact"} } }, "required": ["has_next_page", "items"] @@ -3445,9 +3727,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3455,9 +3735,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3484,9 +3762,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact_input" - } + "record": {"$ref": "#/components/schemas/crm.contact_input"} }, "required": ["record"] } @@ -3501,9 +3777,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact" - } + "record": {"$ref": "#/components/schemas/crm.contact"} }, "required": ["record"] } @@ -3514,9 +3788,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3542,9 +3814,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -3556,9 +3826,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact" - }, + "record": {"$ref": "#/components/schemas/crm.contact"}, "raw": {} }, "required": ["record"] @@ -3570,9 +3838,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3580,9 +3846,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3606,9 +3870,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -3619,9 +3881,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact_input" - } + "record": {"$ref": "#/components/schemas/crm.contact_input"} }, "required": ["record"] } @@ -3636,9 +3896,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact" - } + "record": {"$ref": "#/components/schemas/crm.contact"} }, "required": ["record"] } @@ -3649,9 +3907,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3659,9 +3915,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3690,18 +3944,8 @@ "schema": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": { - "type": "array", - "items": { - "type": "string" - } - } + "ids": {"type": "array", "items": {"type": "string"}}, + "properties": {"type": "array", "items": {"type": "string"}} }, "required": ["ids", "properties"] } @@ -3715,9 +3959,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.contact" - } + "items": {"$ref": "#/components/schemas/crm.contact"} } } } @@ -3726,9 +3968,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3767,17 +4007,13 @@ }, "values": { "type": "array", - "items": { - "type": "string" - }, + "items": {"type": "string"}, "description": "The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one record is found that matches, then an error will be thrown." } }, "required": ["key", "values"] }, - "record": { - "$ref": "#/components/schemas/crm.contact_input" - } + "record": {"$ref": "#/components/schemas/crm.contact_input"} }, "required": ["upsert_on", "record"] } @@ -3792,9 +4028,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.contact" - } + "record": {"$ref": "#/components/schemas/crm.contact"} }, "required": ["record"] } @@ -3805,9 +4039,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3833,25 +4065,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -3861,17 +4082,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.lead" - } + "items": {"$ref": "#/components/schemas/crm.lead"} } }, "required": ["has_next_page", "items"] @@ -3883,9 +4098,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3893,9 +4106,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3921,9 +4132,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -3935,9 +4144,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.lead" - }, + "record": {"$ref": "#/components/schemas/crm.lead"}, "raw": {} }, "required": ["record"] @@ -3949,9 +4156,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -3959,9 +4164,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -3987,25 +4190,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -4015,17 +4207,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.opportunity" - } + "items": {"$ref": "#/components/schemas/crm.opportunity"} } }, "required": ["has_next_page", "items"] @@ -4037,9 +4223,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4047,9 +4231,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4075,9 +4257,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -4089,9 +4269,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.opportunity" - }, + "record": {"$ref": "#/components/schemas/crm.opportunity"}, "raw": {} }, "required": ["record"] @@ -4103,9 +4281,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4113,9 +4289,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4141,25 +4315,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -4169,17 +4332,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.note" - } + "items": {"$ref": "#/components/schemas/crm.note"} } }, "required": ["has_next_page", "items"] @@ -4191,9 +4348,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4201,9 +4356,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4230,9 +4383,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.note_input" - } + "record": {"$ref": "#/components/schemas/crm.note_input"} }, "required": ["record"] } @@ -4247,9 +4398,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.note" - } + "record": {"$ref": "#/components/schemas/crm.note"} }, "required": ["record"] } @@ -4260,9 +4409,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4288,25 +4435,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -4316,17 +4452,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.user" - } + "items": {"$ref": "#/components/schemas/crm.user"} } }, "required": ["has_next_page", "items"] @@ -4338,9 +4468,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4348,9 +4476,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4376,9 +4502,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -4390,9 +4514,7 @@ "schema": { "type": "object", "properties": { - "record": { - "$ref": "#/components/schemas/crm.user" - }, + "record": {"$ref": "#/components/schemas/crm.user"}, "raw": {} }, "required": ["record"] @@ -4404,9 +4526,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4414,9 +4534,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4442,33 +4560,20 @@ { "in": "path", "name": "object_name", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true }, { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -4476,18 +4581,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": {} - } + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": {"type": "array", "items": {}} }, "required": ["has_next_page", "items"] } @@ -4498,9 +4596,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4508,9 +4604,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4534,9 +4628,7 @@ { "in": "path", "name": "object_name", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -4547,10 +4639,7 @@ "schema": { "type": "object", "properties": { - "record": { - "type": "object", - "additionalProperties": {} - } + "record": {"type": "object", "additionalProperties": {}} }, "required": ["record"] } @@ -4568,9 +4657,7 @@ "record": {}, "warnings": { "type": "array", - "items": { - "$ref": "#/components/schemas/warning" - } + "items": {"$ref": "#/components/schemas/warning"} } } } @@ -4581,9 +4668,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4609,10 +4694,7 @@ { "in": "query", "name": "type", - "schema": { - "type": "string", - "enum": ["standard", "custom"] - } + "schema": {"type": "string", "enum": ["standard", "custom"]} } ], "responses": { @@ -4622,9 +4704,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.meta.object" - } + "items": {"$ref": "#/components/schemas/crm.meta.object"} } } } @@ -4633,9 +4713,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4643,9 +4721,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4673,27 +4749,17 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, + "name": {"type": "string"}, + "description": {"type": ["string", "null"]}, "labels": { "type": "object", "properties": { - "singular": { - "type": "string" - }, - "plural": { - "type": "string" - } + "singular": {"type": "string"}, + "plural": {"type": "string"} }, "required": ["singular", "plural"] }, - "primary_field_id": { - "type": "string" - }, + "primary_field_id": {"type": "string"}, "fields": { "type": "array", "items": { @@ -4718,9 +4784,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/crm.meta.object" - } + "schema": {"$ref": "#/components/schemas/crm.meta.object"} } } }, @@ -4728,9 +4792,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4756,9 +4818,7 @@ { "in": "path", "name": "object_name", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -4769,9 +4829,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.meta.property" - } + "items": {"$ref": "#/components/schemas/crm.meta.property"} } } } @@ -4780,9 +4838,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4790,9 +4846,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -4816,9 +4870,7 @@ { "in": "path", "name": "object_name", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -4861,9 +4913,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/crm.meta.property" - } + "schema": {"$ref": "#/components/schemas/crm.meta.property"} } } }, @@ -4871,9 +4921,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4902,19 +4950,13 @@ "schema": { "type": "object", "properties": { - "source_object": { - "type": "string" - }, - "target_object": { - "type": "string" - }, + "source_object": {"type": "string"}, + "target_object": {"type": "string"}, "suggested_key_name": { "type": "string", "description": "The underlying provider may change this (e.g. adding `__c` for Salesforce)." }, - "display_name": { - "type": "string" - } + "display_name": {"type": "string"} }, "required": [ "source_object", @@ -4939,9 +4981,7 @@ }, "warnings": { "type": "array", - "items": { - "$ref": "#/components/schemas/warning" - } + "items": {"$ref": "#/components/schemas/warning"} } }, "required": ["association_schema"] @@ -4953,9 +4993,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -4981,25 +5019,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5009,17 +5036,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/banking.account" - } + "items": {"$ref": "#/components/schemas/banking.account"} } }, "required": ["has_next_page", "items"] @@ -5031,9 +5052,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5041,9 +5060,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5069,25 +5086,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5097,17 +5103,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/banking.merchant" - } + "items": {"$ref": "#/components/schemas/banking.merchant"} } }, "required": ["has_next_page", "items"] @@ -5119,9 +5119,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5129,9 +5127,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5157,25 +5153,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5185,17 +5170,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/banking.category" - } + "items": {"$ref": "#/components/schemas/banking.category"} } }, "required": ["has_next_page", "items"] @@ -5207,9 +5186,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5217,9 +5194,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5245,25 +5220,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5273,12 +5237,8 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { @@ -5295,9 +5255,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5305,9 +5263,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5333,25 +5289,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5361,62 +5306,34 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "number": { - "type": ["string", "null"] - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "subAccount": { - "type": "boolean" - }, - "accountType": { - "type": "string" - }, - "accountSubType": { - "type": "string" - }, - "currentBalance": { - "type": "number" - }, + "id": {"type": "string"}, + "number": {"type": ["string", "null"]}, + "name": {"type": "string"}, + "type": {"type": "string"}, + "subAccount": {"type": "boolean"}, + "accountType": {"type": "string"}, + "accountSubType": {"type": "string"}, + "currentBalance": {"type": "number"}, "currencyRef": { "type": "object", "properties": { - "value": { - "type": "string" - }, - "name": { - "type": "string" - } + "value": {"type": "string"}, + "name": {"type": "string"} }, "required": ["value", "name"] }, "metaData": { "type": "object", "properties": { - "createTime": { - "type": "string" - }, - "lastUpdatedTime": { - "type": "string" - } + "createTime": {"type": "string"}, + "lastUpdatedTime": {"type": "string"} }, "required": ["createTime", "lastUpdatedTime"] } @@ -5434,9 +5351,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5444,9 +5359,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5472,25 +5385,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5500,29 +5402,17 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "currency": { - "type": "string" - }, - "payment_account": { - "type": "string" - } + "id": {"type": "string"}, + "amount": {"type": "number"}, + "currency": {"type": "string"}, + "payment_account": {"type": "string"} }, "required": [ "id", @@ -5542,9 +5432,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5552,9 +5440,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5580,25 +5466,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -5608,26 +5483,16 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - } + "id": {"type": "string"}, + "name": {"type": "string"}, + "url": {"type": "string"} }, "required": ["id", "name", "url"] } @@ -5642,9 +5507,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5652,9 +5515,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5677,55 +5538,13 @@ "summary": "Get Balance Sheet", "tags": ["Accounting"], "parameters": [ - { - "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "customer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "summarize_by", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + {"in": "query", "name": "customer", "schema": {"type": "string"}}, + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -5734,51 +5553,21 @@ "application/json": { "schema": { "type": "object", - "properties": { - "startPeriod": { - "type": "string", - "format": "date" - }, - "endPeriod": { - "type": "string", - "format": "date" - }, - "currency": { - "type": "string" - }, - "accountingStandard": { - "type": "string" - }, - "totalCurrentAssets": { - "type": ["number", "null"] - }, - "totalFixedAssets": { - "type": ["number", "null"] - }, - "totalAssets": { - "type": ["number", "null"] - }, - "totalCurrentLiabilities": { - "type": ["number", "null"] - }, - "totalLongTermLiabilities": { - "type": ["number", "null"] - }, - "totalLiabilities": { - "type": ["number", "null"] - }, - "openingBalanceEquity": { - "type": ["number", "null"] - }, - "netIncome": { - "type": ["number", "null"] - }, - "totalEquity": { - "type": ["number", "null"] - }, - "totalLiabilitiesAndEquity": { - "type": ["number", "null"] - } + "properties": { + "startPeriod": {"type": "string", "format": "date"}, + "endPeriod": {"type": "string", "format": "date"}, + "currency": {"type": "string"}, + "accountingStandard": {"type": "string"}, + "totalCurrentAssets": {"type": ["number", "null"]}, + "totalFixedAssets": {"type": ["number", "null"]}, + "totalAssets": {"type": ["number", "null"]}, + "totalCurrentLiabilities": {"type": ["number", "null"]}, + "totalLongTermLiabilities": {"type": ["number", "null"]}, + "totalLiabilities": {"type": ["number", "null"]}, + "openingBalanceEquity": {"type": ["number", "null"]}, + "netIncome": {"type": ["number", "null"]}, + "totalEquity": {"type": ["number", "null"]}, + "totalLiabilitiesAndEquity": {"type": ["number", "null"]} }, "required": [ "startPeriod", @@ -5804,9 +5593,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5814,9 +5601,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5839,55 +5624,13 @@ "summary": "Get Profit and Loss", "tags": ["Accounting"], "parameters": [ - { - "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "customer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "summarize_by", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + {"in": "query", "name": "customer", "schema": {"type": "string"}}, + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -5897,38 +5640,16 @@ "schema": { "type": "object", "properties": { - "reportName": { - "type": "string" - }, - "startPeriod": { - "type": "string", - "format": "date" - }, - "endPeriod": { - "type": "string", - "format": "date" - }, - "currency": { - "type": "string" - }, - "accountingStandard": { - "type": "string" - }, - "totalIncome": { - "type": ["number", "null"] - }, - "grossProfit": { - "type": ["number", "null"] - }, - "totalExpenses": { - "type": ["number", "null"] - }, - "netOperatingIncome": { - "type": ["number", "null"] - }, - "netIncome": { - "type": ["number", "null"] - } + "reportName": {"type": "string"}, + "startPeriod": {"type": "string", "format": "date"}, + "endPeriod": {"type": "string", "format": "date"}, + "currency": {"type": "string"}, + "accountingStandard": {"type": "string"}, + "totalIncome": {"type": ["number", "null"]}, + "grossProfit": {"type": ["number", "null"]}, + "totalExpenses": {"type": ["number", "null"]}, + "netOperatingIncome": {"type": ["number", "null"]}, + "netIncome": {"type": ["number", "null"]} }, "required": [ "reportName", @@ -5950,9 +5671,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -5960,9 +5679,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -5985,55 +5702,13 @@ "summary": "Get Cash Flow", "tags": ["Accounting"], "parameters": [ - { - "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "customer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "summarize_by", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + {"in": "query", "name": "customer", "schema": {"type": "string"}}, + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -6043,38 +5718,20 @@ "schema": { "type": "object", "properties": { - "reportName": { - "type": "string" - }, - "startPeriod": { - "type": "string", - "format": "date" - }, - "endPeriod": { - "type": "string", - "format": "date" - }, - "currency": { - "type": "string" - }, - "netIncome": { - "type": ["number", "null"] - }, - "totalOperatingAdjustments": { - "type": ["number", "null"] - }, + "reportName": {"type": "string"}, + "startPeriod": {"type": "string", "format": "date"}, + "endPeriod": {"type": "string", "format": "date"}, + "currency": {"type": "string"}, + "netIncome": {"type": ["number", "null"]}, + "totalOperatingAdjustments": {"type": ["number", "null"]}, "netCashFromOperatingActivities": { "type": ["number", "null"] }, "netCashFromFinancingActivities": { "type": ["number", "null"] }, - "netCashIncrease": { - "type": ["number", "null"] - }, - "endingCash": { - "type": ["number", "null"] - } + "netCashIncrease": {"type": ["number", "null"]}, + "endingCash": {"type": ["number", "null"]} }, "required": [ "reportName", @@ -6096,9 +5753,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6106,9 +5761,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6131,76 +5784,24 @@ "summary": "Get Transaction List", "tags": ["Accounting"], "parameters": [ - { - "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "customer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, + {"in": "query", "name": "customer", "schema": {"type": "string"}}, + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, { "in": "query", "name": "payment_method", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "arpaid", - "schema": { - "type": "string" - } + "schema": {"type": "string"} }, + {"in": "query", "name": "arpaid", "schema": {"type": "string"}}, { "in": "query", "name": "transaction_type", - "schema": { - "type": "string" - } + "schema": {"type": "string"} }, - { - "in": "query", - "name": "sort_by", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "sort_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -6210,56 +5811,26 @@ "schema": { "type": "object", "properties": { - "reportName": { - "type": "string" - }, - "startPeriod": { - "type": "string" - }, - "endPeriod": { - "type": "string" - }, - "currency": { - "type": "string" - }, + "reportName": {"type": "string"}, + "startPeriod": {"type": "string"}, + "endPeriod": {"type": "string"}, + "currency": {"type": "string"}, "transactions": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "date": { - "type": "string" - }, - "transactionType": { - "type": "string" - }, - "documentNumber": { - "type": "string" - }, - "posting": { - "type": "string" - }, - "name": { - "type": "string" - }, - "department": { - "type": "string" - }, - "memo": { - "type": "string" - }, - "account": { - "type": "string" - }, - "split": { - "type": "string" - }, - "amount": { - "type": "number" - }, + "id": {"type": "string"}, + "date": {"type": "string"}, + "transactionType": {"type": "string"}, + "documentNumber": {"type": "string"}, + "posting": {"type": "string"}, + "name": {"type": "string"}, + "department": {"type": "string"}, + "memo": {"type": "string"}, + "account": {"type": "string"}, + "split": {"type": "string"}, + "amount": {"type": "number"}, "raw_data": {} }, "required": ["id", "date", "transactionType", "amount"] @@ -6281,9 +5852,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6291,9 +5860,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6316,56 +5883,18 @@ "summary": "Get Customer Balance", "tags": ["Accounting"], "parameters": [ - { - "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, { "in": "query", "name": "customer", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "summarize_by", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -6375,36 +5904,22 @@ "schema": { "type": "object", "properties": { - "reportName": { - "type": "string" - }, - "reportDate": { - "type": "string" - }, - "currency": { - "type": "string" - }, + "reportName": {"type": "string"}, + "reportDate": {"type": "string"}, + "currency": {"type": "string"}, "entries": { "type": "array", "items": { "type": "object", "properties": { - "customerId": { - "type": "string" - }, - "customerName": { - "type": "string" - }, - "balance": { - "type": "number" - } + "customerId": {"type": "string"}, + "customerName": {"type": "string"}, + "balance": {"type": "number"} }, "required": ["customerId", "customerName", "balance"] } }, - "totalBalance": { - "type": "number" - } + "totalBalance": {"type": "number"} }, "required": [ "reportName", @@ -6421,9 +5936,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6431,9 +5944,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6456,56 +5967,18 @@ "summary": "Get Customer Income", "tags": ["Accounting"], "parameters": [ + {"in": "query", "name": "start_date", "schema": {"type": "string"}}, + {"in": "query", "name": "end_date", "schema": {"type": "string"}}, + {"in": "query", "name": "sort_order", "schema": {"type": "string"}}, { "in": "query", - "name": "start_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "end_date", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sort_order", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "customer", - "schema": { - "type": "string" - }, - "required": true - }, - { - "in": "query", - "name": "department", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "date_macro", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "summarize_by", - "schema": { - "type": "string" - } - } + "name": "customer", + "schema": {"type": "string"}, + "required": true + }, + {"in": "query", "name": "department", "schema": {"type": "string"}}, + {"in": "query", "name": "date_macro", "schema": {"type": "string"}}, + {"in": "query", "name": "summarize_by", "schema": {"type": "string"}} ], "responses": { "200": { @@ -6515,38 +5988,20 @@ "schema": { "type": "object", "properties": { - "reportName": { - "type": "string" - }, - "startPeriod": { - "type": "string" - }, - "endPeriod": { - "type": "string" - }, - "currency": { - "type": "string" - }, + "reportName": {"type": "string"}, + "startPeriod": {"type": "string"}, + "endPeriod": {"type": "string"}, + "currency": {"type": "string"}, "entries": { "type": "array", "items": { "type": "object", "properties": { - "customerId": { - "type": "string" - }, - "customerName": { - "type": "string" - }, - "totalIncome": { - "type": "number" - }, - "totalExpenses": { - "type": "number" - }, - "netIncome": { - "type": "number" - } + "customerId": {"type": "string"}, + "customerName": {"type": "string"}, + "totalIncome": {"type": "number"}, + "totalExpenses": {"type": "number"}, + "netIncome": {"type": "number"} }, "required": [ "customerId", @@ -6557,15 +6012,9 @@ ] } }, - "totalIncome": { - "type": "number" - }, - "totalExpenses": { - "type": "number" - }, - "netIncome": { - "type": "number" - } + "totalIncome": {"type": "number"}, + "totalExpenses": {"type": "number"}, + "netIncome": {"type": "number"} }, "required": [ "reportName", @@ -6585,9 +6034,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6595,9 +6042,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6623,9 +6068,7 @@ { "in": "query", "name": "customer", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -6639,36 +6082,16 @@ "items": { "type": "object", "properties": { - "updated": { - "type": "string" - }, - "name": { - "type": "string" - }, - "accountNumber": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "created": { - "type": "string" - }, - "inputType": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "routingNumber": { - "type": "string" - }, - "id": { - "type": "string" - } + "updated": {"type": "string"}, + "name": {"type": "string"}, + "accountNumber": {"type": "string"}, + "default": {"type": "boolean"}, + "created": {"type": "string"}, + "inputType": {"type": "string"}, + "phone": {"type": "string"}, + "accountType": {"type": "string"}, + "routingNumber": {"type": "string"}, + "id": {"type": "string"} }, "required": [ "updated", @@ -6691,9 +6114,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6701,9 +6122,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6729,28 +6148,20 @@ { "in": "query", "name": "customer_transaction_id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": {} - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6758,9 +6169,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6786,25 +6195,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -6814,18 +6212,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "type": "object", - "properties": {} - } + "items": {"type": "object", "properties": {}} } }, "required": ["has_next_page", "items"] @@ -6837,9 +6228,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -6847,9 +6236,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -6875,25 +6262,81 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}} + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": { + "type": "array", + "items": {"type": "object", "properties": {}} + } + }, + "required": ["has_next_page", "items"] + } + } } }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } } } + } + } + }, + "/unified/pta/commodity": { + "get": { + "operationId": "pta-listCommodities", + "summary": "List Commodities", + "tags": ["PTA"], + "parameters": [ + { + "in": "query", + "name": "sync_mode", + "schema": {"type": "string", "enum": ["full", "incremental"]} + }, + { + "in": "query", + "name": "cursor", + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -6903,18 +6346,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "type": "object", - "properties": {} - } + "items": {"type": "object", "properties": {}} } }, "required": ["has_next_page", "items"] @@ -6924,24 +6360,160 @@ }, "400": { "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/unified/ats/job": { + "get": { + "operationId": "ats-listJobs", + "summary": "List Jobs", + "tags": ["ATS"], + "parameters": [ + { + "in": "query", + "name": "sync_mode", + "schema": {"type": "string", "enum": ["full", "incremental"]} + }, + { + "in": "query", + "name": "cursor", + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}} + ], + "responses": { + "200": { + "description": "Successful response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": { + "type": "array", + "items": {"$ref": "#/components/schemas/ats.job"} + } + }, + "required": ["has_next_page", "items"] } } } }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, "404": { "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" + } + } + } + } + } + } + }, + "/unified/ats/job/{jobId}/opening": { + "get": { + "operationId": "ats-listJobOpenings", + "summary": "List Job Openings", + "tags": ["ATS"], + "parameters": [ + { + "in": "path", + "name": "jobId", + "schema": {"type": "string"}, + "required": true + }, + { + "in": "query", + "name": "sync_mode", + "schema": {"type": "string", "enum": ["full", "incremental"]} + }, + { + "in": "query", + "name": "cursor", + "schema": {"type": ["string", "null"]} + }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}} + ], + "responses": { + "200": { + "description": "Successful response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" + "type": "object", + "properties": { + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": { + "type": "array", + "items": {"$ref": "#/components/schemas/ats.opening"} + } + }, + "required": ["has_next_page", "items"] } } } }, + "400": { + "description": "Invalid input data", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} + } + } + }, "500": { "description": "Internal server error", "content": { @@ -6955,34 +6527,23 @@ } } }, - "/unified/pta/commodity": { + "/unified/ats/offer": { "get": { - "operationId": "pta-listCommodities", - "summary": "List Commodities", - "tags": ["PTA"], + "operationId": "ats-listOffers", + "summary": "List Offers", + "tags": ["ATS"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -6992,18 +6553,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "type": "object", - "properties": {} - } + "items": {"$ref": "#/components/schemas/ats.offer"} } }, "required": ["has_next_page", "items"] @@ -7015,9 +6569,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7025,9 +6577,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7044,34 +6594,23 @@ } } }, - "/unified/ats/job": { + "/unified/ats/candidate": { "get": { - "operationId": "ats-listJobs", - "summary": "List Jobs", + "operationId": "ats-listCandidates", + "summary": "List Candidates", "tags": ["ATS"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -7081,17 +6620,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/ats.job" - } + "items": {"$ref": "#/components/schemas/ats.candidate"} } }, "required": ["has_next_page", "items"] @@ -7103,9 +6636,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7113,9 +6644,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7132,42 +6661,23 @@ } } }, - "/unified/ats/job/{jobId}/opening": { + "/unified/ats/department": { "get": { - "operationId": "ats-listJobOpenings", - "summary": "List Job Openings", + "operationId": "ats-listDepartments", + "summary": "List Departments", "tags": ["ATS"], "parameters": [ - { - "in": "path", - "name": "jobId", - "schema": { - "type": "string" - }, - "required": true - }, { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -7177,17 +6687,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/ats.opening" - } + "items": {"$ref": "#/components/schemas/ats.department"} } }, "required": ["has_next_page", "items"] @@ -7199,9 +6703,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7209,9 +6711,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7228,34 +6728,23 @@ } } }, - "/unified/ats/offer": { + "/unified/hris/individual": { "get": { - "operationId": "ats-listOffers", - "summary": "List Offers", - "tags": ["ATS"], + "operationId": "hris-listIndividual", + "summary": "List Individuals", + "tags": ["HRIS"], "parameters": [ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -7265,16 +6754,20 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { - "$ref": "#/components/schemas/ats.offer" + "type": "object", + "properties": { + "id": {"type": "string"}, + "raw_data": { + "type": "object", + "additionalProperties": {} + } + }, + "required": ["id"] } } }, @@ -7287,9 +6780,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7297,9 +6788,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7316,33 +6805,33 @@ } } }, - "/unified/ats/candidate": { + "/unified/sync/read/{stream}": { "get": { - "operationId": "ats-listCandidates", - "summary": "List Candidates", - "tags": ["ATS"], + "operationId": "sync-readStream", + "summary": "Read Stream", + "tags": ["Sync"], "parameters": [ + { + "in": "path", + "name": "stream", + "schema": {"type": "string"}, + "required": true + }, { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } + "name": "fields", + "schema": {"type": "array", "items": {"type": "string"}} } ], "responses": { @@ -7353,18 +6842,9 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ats.candidate" - } - } + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, + "items": {"type": "array", "items": {}} }, "required": ["has_next_page", "items"] } @@ -7375,9 +6855,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7385,9 +6863,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7404,35 +6880,11 @@ } } }, - "/unified/ats/department": { + "/unified/sync/discover": { "get": { - "operationId": "ats-listDepartments", - "summary": "List Departments", - "tags": ["ATS"], - "parameters": [ - { - "in": "query", - "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } - }, - { - "in": "query", - "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } - ], + "operationId": "sync-discover", + "summary": "Discover", + "tags": ["Sync"], "responses": { "200": { "description": "Successful response", @@ -7441,41 +6893,168 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, - "items": { + "streams": { "type": "array", "items": { - "$ref": "#/components/schemas/ats.department" + "type": "object", + "properties": { + "name": {"type": "string"}, + "json_schema": { + "type": "object", + "additionalProperties": {} + }, + "source_defined_primary_key": { + "type": "array", + "items": { + "type": "array", + "items": {"type": "string"} + } + } + }, + "required": ["name", "json_schema"] } - } + }, + "type": {"type": "string", "enum": ["CATALOG"]} }, - "required": ["has_next_page", "items"] + "required": ["streams", "type"] } } } }, - "400": { - "description": "Invalid input data", + "500": { + "description": "Internal server error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" + "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } - }, - "404": { - "description": "Not found", + } + } + } + }, + "/unified/sync/read": { + "post": { + "operationId": "sync-read", + "summary": "Read Data", + "tags": ["Sync"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "catalog": { + "type": "object", + "properties": { + "streams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stream": { + "type": "object", + "properties": { + "name": {"type": "string"}, + "json_schema": { + "type": "object", + "additionalProperties": {} + }, + "source_defined_primary_key": { + "type": "array", + "items": { + "type": "array", + "items": {"type": "string"} + } + } + }, + "required": ["name", "json_schema"] + }, + "sync_mode": { + "type": "string", + "enum": ["full_refresh", "incremental"] + }, + "additional_fields": { + "type": "array", + "items": {"type": "string"} + } + }, + "required": ["stream", "sync_mode"] + } + } + }, + "required": ["streams"] + }, + "state": { + "type": "object", + "properties": { + "shared_state": { + "type": "object", + "additionalProperties": {} + }, + "stream_states": { + "type": "array", + "items": { + "type": "object", + "properties": { + "stream_description": { + "type": "object", + "properties": { + "name": {"type": "string"}, + "namespace": {"type": "string"} + }, + "required": ["name", "namespace"] + }, + "stream_state": { + "type": "object", + "additionalProperties": {} + } + }, + "required": ["stream_description", "stream_state"] + } + } + }, + "required": ["stream_states"] + } + }, + "required": ["catalog", "state"] + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "record": { + "type": "object", + "properties": { + "data": {}, + "stream": {"type": "string"} + }, + "required": ["stream"] + }, + "type": {"type": "string", "enum": ["RECORD"]} + }, + "required": ["record", "type"] + } + } + } + } + }, + "400": { + "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7492,67 +7071,104 @@ } } }, - "/unified/hris/individual": { - "get": { - "operationId": "hris-listIndividual", - "summary": "List Individuals", - "tags": ["HRIS"], - "parameters": [ - { - "in": "query", - "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } - }, - { - "in": "query", - "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" + "/unified/sync/write": { + "post": { + "operationId": "sync-write", + "summary": "Write Data", + "tags": ["Sync"], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "record": { + "type": "object", + "properties": { + "data": {}, + "stream": {"type": "string"} + }, + "required": ["stream"] + }, + "type": {"type": "string", "enum": ["RECORD"]} + }, + "required": ["record", "type"] + } + } + }, + "required": ["messages"] + } } } - ], + }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { + "type": "array", + "items": { + "oneOf": [ + { "type": "object", "properties": { - "id": { - "type": "string" + "streams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": {"type": "string"}, + "json_schema": { + "type": "object", + "additionalProperties": {} + }, + "source_defined_primary_key": { + "type": "array", + "items": { + "type": "array", + "items": {"type": "string"} + } + } + }, + "required": ["name", "json_schema"] + } }, - "raw_data": { + "type": {"type": "string", "enum": ["CATALOG"]} + }, + "required": ["streams", "type"] + }, + { + "type": "object", + "properties": { + "record": { "type": "object", - "additionalProperties": {} - } + "properties": { + "data": {}, + "stream": {"type": "string"} + }, + "required": ["stream"] + }, + "type": {"type": "string", "enum": ["RECORD"]} }, - "required": ["id"] + "required": ["record", "type"] + }, + { + "type": "object", + "properties": { + "state": {}, + "type": {"type": "string", "enum": ["STATE"]} + }, + "required": ["type"] } - } - }, - "required": ["has_next_page", "items"] + ] + } } } } @@ -7561,19 +7177,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } - } - } - }, - "404": { - "description": "Not found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7599,25 +7203,14 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}} ], "responses": { "200": { @@ -7627,12 +7220,8 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", "items": { @@ -7649,9 +7238,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7659,9 +7246,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7687,31 +7272,18 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } + "schema": {"type": ["string", "null"]} }, + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, { "in": "query", "name": "drive_group_id", - "schema": { - "type": "string" - } + "schema": {"type": "string"} } ], "responses": { @@ -7722,17 +7294,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/unified.drive" - } + "items": {"$ref": "#/components/schemas/unified.drive"} } }, "required": ["has_next_page", "items"] @@ -7744,9 +7310,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7754,9 +7318,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7782,39 +7344,16 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "drive_id", - "schema": { - "type": "string" - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "folder_id", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, + {"in": "query", "name": "drive_id", "schema": {"type": "string"}}, + {"in": "query", "name": "folder_id", "schema": {"type": "string"}} ], "responses": { "200": { @@ -7824,17 +7363,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/unified.file" - } + "items": {"$ref": "#/components/schemas/unified.file"} } }, "required": ["has_next_page", "items"] @@ -7846,9 +7379,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7856,9 +7387,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7884,9 +7413,7 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], @@ -7895,9 +7422,7 @@ "description": "Successful response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/unified.file" - } + "schema": {"$ref": "#/components/schemas/unified.file"} } } }, @@ -7905,9 +7430,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7915,9 +7438,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -7943,36 +7464,26 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true }, { "in": "query", "name": "format", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": {} - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -7980,9 +7491,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -8008,28 +7517,20 @@ { "in": "path", "name": "id", - "schema": { - "type": "string" - }, + "schema": {"type": "string"}, "required": true } ], "responses": { "200": { "description": "Successful response", - "content": { - "application/json": { - "schema": {} - } - } + "content": {"application/json": {"schema": {}}} }, "400": { "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -8037,9 +7538,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -8065,32 +7564,15 @@ { "in": "query", "name": "sync_mode", - "schema": { - "type": "string", - "enum": ["full", "incremental"] - } + "schema": {"type": "string", "enum": ["full", "incremental"]} }, { "in": "query", "name": "cursor", - "schema": { - "type": ["string", "null"] - } - }, - { - "in": "query", - "name": "page_size", - "schema": { - "type": "number" - } + "schema": {"type": ["string", "null"]} }, - { - "in": "query", - "name": "drive_id", - "schema": { - "type": "string" - } - } + {"in": "query", "name": "page_size", "schema": {"type": "number"}}, + {"in": "query", "name": "drive_id", "schema": {"type": "string"}} ], "responses": { "200": { @@ -8100,17 +7582,11 @@ "schema": { "type": "object", "properties": { - "next_cursor": { - "type": ["string", "null"] - }, - "has_next_page": { - "type": "boolean" - }, + "next_cursor": {"type": ["string", "null"]}, + "has_next_page": {"type": "boolean"}, "items": { "type": "array", - "items": { - "$ref": "#/components/schemas/unified.folder" - } + "items": {"$ref": "#/components/schemas/unified.folder"} } }, "required": ["has_next_page", "items"] @@ -8122,9 +7598,7 @@ "description": "Invalid input data", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.BAD_REQUEST" - } + "schema": {"$ref": "#/components/schemas/error.BAD_REQUEST"} } } }, @@ -8132,9 +7606,7 @@ "description": "Not found", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/error.NOT_FOUND" - } + "schema": {"$ref": "#/components/schemas/error.NOT_FOUND"} } } }, @@ -8158,9 +7630,7 @@ "requestBody": { "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/webhooks.sync.completed" - } + "schema": {"$ref": "#/components/schemas/webhooks.sync.completed"} } } }, @@ -8172,9 +7642,7 @@ "requestBody": { "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/webhooks.pageview" - } + "schema": {"$ref": "#/components/schemas/webhooks.pageview"} } } }, @@ -8184,21 +7652,13 @@ }, "components": { "securitySchemes": { - "apikey": { - "type": "apiKey", - "name": "x-apikey", - "in": "header" - }, + "apikey": {"type": "apiKey", "name": "x-apikey", "in": "header"}, "connectionId": { "type": "apiKey", "name": "x-connection-id", "in": "header" }, - "token": { - "type": "apiKey", - "name": "authorization", - "in": "header" - } + "token": {"type": "apiKey", "name": "authorization", "in": "header"} }, "schemas": { "webhooks.sync.completed": { @@ -8222,13 +7682,8 @@ }, "required": ["pipeline_id", "source_id", "destination_id"] }, - "name": { - "type": "string", - "enum": ["sync.completed"] - }, - "id": { - "type": "string" - } + "name": {"type": "string", "enum": ["sync.completed"]}, + "id": {"type": "string"} }, "required": ["data", "name"] }, @@ -8238,22 +7693,13 @@ "data": { "type": "object", "properties": { - "current_url": { - "type": "string" - }, - "path": { - "type": "string" - } + "current_url": {"type": "string"}, + "path": {"type": "string"} }, "required": ["current_url", "path"] }, - "name": { - "type": "string", - "enum": ["pageview"] - }, - "id": { - "type": "string" - } + "name": {"type": "string", "enum": ["pageview"]}, + "id": {"type": "string"} }, "required": ["data", "name"] }, @@ -8274,11 +7720,7 @@ "type": "array", "items": { "type": "object", - "properties": { - "message": { - "type": "string" - } - }, + "properties": {"message": {"type": "string"}}, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -8311,11 +7753,7 @@ "type": "array", "items": { "type": "object", - "properties": { - "message": { - "type": "string" - } - }, + "properties": {"message": {"type": "string"}}, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -8325,11 +7763,7 @@ "required": ["message", "code"], "title": "Error", "description": "The error information", - "example": { - "code": "NOT_FOUND", - "message": "Not found", - "issues": [] - } + "example": {"code": "NOT_FOUND", "message": "Not found", "issues": []} }, "error.INTERNAL_SERVER_ERROR": { "type": "object", @@ -8348,11 +7782,7 @@ "type": "array", "items": { "type": "object", - "properties": { - "message": { - "type": "string" - } - }, + "properties": {"message": {"type": "string"}}, "required": ["message"] }, "description": "An array of issues that were responsible for the error", @@ -8366,32 +7796,20 @@ "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "issues": [] - } - }, - "Connection": { - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Must start with 'conn_'" - }, + } + }, + "Connection": { + "type": "object", + "properties": { + "createdAt": {"type": "string"}, + "updatedAt": {"type": "string"}, + "id": {"type": "string", "description": "Must start with 'conn_'"}, "connectorName": { "type": "string", "description": "Unique name of the connector" }, - "displayName": { - "type": ["string", "null"] - }, - "customerId": { - "type": ["string", "null"], - "minLength": 1 - }, + "displayName": {"type": ["string", "null"]}, + "customerId": {"type": ["string", "null"], "minLength": 1}, "connectorConfigId": { "type": "string", "description": "Must start with 'ccfg_'" @@ -8400,34 +7818,20 @@ "type": ["string", "null"], "description": "Must start with 'int_'" }, - "settings": { - "type": ["object", "null"], - "additionalProperties": {} - }, + "settings": {"type": ["object", "null"], "additionalProperties": {}}, "standard": { "type": ["object", "null"], "properties": { - "displayName": { - "type": ["string", "null"] - }, + "displayName": {"type": ["string", "null"]}, "status": { "type": ["string", "null"], "enum": ["healthy", "disconnected", "error", "manual"] }, - "statusMessage": { - "type": ["string", "null"] - }, - "labels": { - "type": "array", - "items": { - "type": "string" - } - } + "statusMessage": {"type": ["string", "null"]}, + "labels": {"type": "array", "items": {"type": "string"}} } }, - "disabled": { - "type": "boolean" - }, + "disabled": {"type": "boolean"}, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -8443,30 +7847,13 @@ "ConnectorConfig": { "type": "object", "properties": { - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Must start with 'ccfg_'" - }, - "connectorName": { - "type": "string" - }, - "config": { - "type": ["object", "null"], - "additionalProperties": {} - }, - "orgId": { - "type": "string", - "description": "Must start with 'org_'" - }, - "displayName": { - "type": ["string", "null"] - }, + "createdAt": {"type": "string"}, + "updatedAt": {"type": "string"}, + "id": {"type": "string", "description": "Must start with 'ccfg_'"}, + "connectorName": {"type": "string"}, + "config": {"type": ["object", "null"], "additionalProperties": {}}, + "orgId": {"type": "string", "description": "Must start with 'org_'"}, + "displayName": {"type": ["string", "null"]}, "disabled": { "type": "boolean", "title": "Disabled", @@ -8477,15 +7864,11 @@ "properties": { "streams": { "type": ["object", "null"], - "additionalProperties": { - "type": "boolean" - } + "additionalProperties": {"type": "boolean"} }, "links": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/Link" - }, + "items": {"$ref": "#/components/schemas/Link"}, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "destination_id": { @@ -8500,9 +7883,7 @@ "properties": { "links": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/Link" - }, + "items": {"$ref": "#/components/schemas/Link"}, "description": "Array of transformations that the data gets piped through on the way out. Typically used for things like unification / normalization." }, "source_id": { @@ -8513,9 +7894,7 @@ "required": ["source_id"], "description": "Automatically sync data from any connections associated with this config to the destination connection, which is typically a Postgres database. Think ETL" }, - "envName": { - "type": ["string", "null"] - }, + "envName": {"type": ["string", "null"]}, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -8536,26 +7915,15 @@ "core.integration": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "name": { - "type": "string" - }, - "logo_url": { - "type": ["string", "null"] - }, - "login_url": { - "type": ["string", "null"] - }, + "raw_data": {"type": "object", "additionalProperties": {}}, + "name": {"type": "string"}, + "logo_url": {"type": ["string", "null"]}, + "login_url": {"type": ["string", "null"]}, "verticals": { "type": ["array", "null"], "items": { @@ -8583,18 +7951,12 @@ ] } }, - "connector_name": { - "type": "string" - } + "connector_name": {"type": "string"} }, "required": ["id", "name", "connector_name"] }, "core.configured_integration": { - "allOf": [ - { - "$ref": "#/components/schemas/core.integration" - } - ], + "allOf": [{"$ref": "#/components/schemas/core.integration"}], "type": "object", "properties": { "connector_config_id": { @@ -8607,41 +7969,22 @@ "Pipeline": { "type": "object", "properties": { - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Must start with 'pipe_'" - }, + "createdAt": {"type": "string"}, + "updatedAt": {"type": "string"}, + "id": {"type": "string", "description": "Must start with 'pipe_'"}, "sourceId": { "type": "string", "description": "Must start with 'conn_'" }, - "sourceState": { - "type": "object", - "additionalProperties": {} - }, - "sourceVertical": { - "type": ["string", "null"] - }, + "sourceState": {"type": "object", "additionalProperties": {}}, + "sourceVertical": {"type": ["string", "null"]}, "streams": { "type": ["object", "null"], "additionalProperties": { "type": "object", "properties": { - "disabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - } + "disabled": {"type": "boolean"}, + "fields": {"type": "array", "items": {"type": "string"}} } } }, @@ -8649,26 +7992,12 @@ "type": "string", "description": "Must start with 'conn_'" }, - "destinationState": { - "type": "object", - "additionalProperties": {} - }, - "destinationVertical": { - "type": ["string", "null"] - }, - "linkOptions": { - "type": ["array", "null"], - "items": {} - }, - "lastSyncStartedAt": { - "type": ["string", "null"] - }, - "lastSyncCompletedAt": { - "type": ["string", "null"] - }, - "disabled": { - "type": "boolean" - }, + "destinationState": {"type": "object", "additionalProperties": {}}, + "destinationVertical": {"type": ["string", "null"]}, + "linkOptions": {"type": ["array", "null"], "items": {}}, + "lastSyncStartedAt": {"type": ["string", "null"]}, + "lastSyncCompletedAt": {"type": ["string", "null"]}, + "disabled": {"type": "boolean"}, "metadata": { "description": "\n JSON object can can be used to associate arbitrary metadata to\n avoid needing a separate 1-1 table just for simple key values in your application.\n During updates this object will be shallowly merged\n" } @@ -8678,32 +8007,16 @@ "Event": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "Must start with 'evt_'" - }, - "name": { - "type": "string" - }, - "data": { - "type": ["object", "null"], - "additionalProperties": {} - }, - "timestamp": { - "type": "string" - }, - "user": { - "type": ["object", "null"], - "additionalProperties": {} - }, + "id": {"type": "string", "description": "Must start with 'evt_'"}, + "name": {"type": "string"}, + "data": {"type": ["object", "null"], "additionalProperties": {}}, + "timestamp": {"type": "string"}, + "user": {"type": ["object", "null"], "additionalProperties": {}}, "org_id": { "type": ["string", "null"], "description": "Must start with 'org_'" }, - "customer_id": { - "type": ["string", "null"], - "minLength": 1 - }, + "customer_id": {"type": ["string", "null"], "minLength": 1}, "user_id": { "type": ["string", "null"], "description": "Must start with 'user_'" @@ -8715,25 +8028,14 @@ "oneOf": [ { "type": "object", - "properties": { - "role": { - "type": "string", - "enum": ["anon"] - } - }, + "properties": {"role": {"type": "string", "enum": ["anon"]}}, "required": ["role"] }, { "type": "object", "properties": { - "role": { - "type": "string", - "enum": ["customer"] - }, - "customerId": { - "type": "string", - "minLength": 1 - }, + "role": {"type": "string", "enum": ["customer"]}, + "customerId": {"type": "string", "minLength": 1}, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -8744,10 +8046,7 @@ { "type": "object", "properties": { - "role": { - "type": "string", - "enum": ["user"] - }, + "role": {"type": "string", "enum": ["user"]}, "userId": { "type": "string", "description": "Must start with 'user_'" @@ -8767,10 +8066,7 @@ { "type": "object", "properties": { - "role": { - "type": "string", - "enum": ["org"] - }, + "role": {"type": "string", "enum": ["org"]}, "orgId": { "type": "string", "description": "Must start with 'org_'" @@ -8785,12 +8081,7 @@ }, { "type": "object", - "properties": { - "role": { - "type": "string", - "enum": ["system"] - } - }, + "properties": {"role": {"type": "string", "enum": ["system"]}}, "required": ["role"] } ] @@ -8798,27 +8089,13 @@ "sales-engagement.contact": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "first_name": { - "type": "string" - }, - "last_name": { - "type": "string" - }, - "owner_id": { - "type": "string" - }, - "account_id": { - "type": "string" - }, - "job_title": { - "type": "string" - }, - "address": { - "$ref": "#/components/schemas/sales-engagement.address" - }, + "id": {"type": "string"}, + "first_name": {"type": "string"}, + "last_name": {"type": "string"}, + "owner_id": {"type": "string"}, + "account_id": {"type": "string"}, + "job_title": {"type": "string"}, + "address": {"$ref": "#/components/schemas/sales-engagement.address"}, "email_addresses": { "type": "array", "items": { @@ -8831,30 +8108,14 @@ "$ref": "#/components/schemas/sales-engagement.phone_number" } }, - "open_count": { - "type": "number" - }, - "click_count": { - "type": "number" - }, - "reply_count": { - "type": "number" - }, - "bounced_count": { - "type": "number" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, + "open_count": {"type": "number"}, + "click_count": {"type": "number"}, + "reply_count": {"type": "number"}, + "bounced_count": {"type": "number"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, "raw_data": { "type": "object", "properties": {}, @@ -8883,24 +8144,12 @@ "sales-engagement.address": { "type": "object", "properties": { - "city": { - "type": "string" - }, - "country": { - "type": "string" - }, - "postal_code": { - "type": "string" - }, - "state": { - "type": "string" - }, - "street_1": { - "type": "string" - }, - "street_2": { - "type": "string" - } + "city": {"type": "string"}, + "country": {"type": "string"}, + "postal_code": {"type": "string"}, + "state": {"type": "string"}, + "street_1": {"type": "string"}, + "street_2": {"type": "string"} }, "required": [ "city", @@ -8914,9 +8163,7 @@ "sales-engagement.email_address": { "type": "object", "properties": { - "email_address": { - "type": "string" - }, + "email_address": {"type": "string"}, "email_address_type": { "type": "string", "enum": ["primary", "personal", "work", "other"] @@ -8927,9 +8174,7 @@ "sales-engagement.phone_number": { "type": "object", "properties": { - "phone_number": { - "type": "string" - }, + "phone_number": {"type": "string"}, "phone_number_type": { "type": "string", "enum": ["primary", "work", "home", "mobile", "other"] @@ -8940,44 +8185,21 @@ "sales-engagement.sequence": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, - "owner_id": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "num_steps": { - "type": "number" - }, + "id": {"type": "string"}, + "name": {"type": "string"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, + "owner_id": {"type": "string"}, + "tags": {"type": "array", "items": {"type": "string"}}, + "num_steps": {"type": "number"}, "metrics": { "type": "object", "properties": {}, "additionalProperties": {} }, - "is_enabled": { - "type": "boolean" - }, + "is_enabled": {"type": "boolean"}, "raw_data": { "type": "object", "properties": {}, @@ -8999,36 +8221,16 @@ "sales-engagement.sequenceState": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, - "sequence_id": { - "type": "string" - }, - "contact_id": { - "type": "string" - }, - "mailbox_id": { - "type": "string" - }, - "user_id": { - "type": "string" - }, + "id": {"type": "string"}, + "state": {"type": "string"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, + "sequence_id": {"type": "string"}, + "contact_id": {"type": "string"}, + "mailbox_id": {"type": "string"}, + "user_id": {"type": "string"}, "raw_data": { "type": "object", "properties": {}, @@ -9051,30 +8253,14 @@ "sales-engagement.user": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "first_name": { - "type": "string" - }, - "last_name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, + "id": {"type": "string"}, + "first_name": {"type": "string"}, + "last_name": {"type": "string"}, + "email": {"type": "string"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, "raw_data": { "type": "object", "properties": {}, @@ -9095,30 +8281,14 @@ "sales-engagement.account": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "owner_id": { - "type": "string" - }, + "id": {"type": "string"}, + "name": {"type": "string"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, + "domain": {"type": "string"}, + "owner_id": {"type": "string"}, "raw_data": { "type": "object", "properties": {}, @@ -9139,27 +8309,13 @@ "sales-engagement.mailbox": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "email": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "is_deleted": { - "type": "boolean" - }, - "last_modified_at": { - "type": "string" - }, - "user_id": { - "type": "string" - }, + "id": {"type": "string"}, + "email": {"type": "string"}, + "created_at": {"type": "string"}, + "updated_at": {"type": "string"}, + "is_deleted": {"type": "boolean"}, + "last_modified_at": {"type": "string"}, + "user_id": {"type": "string"}, "raw_data": { "type": "object", "properties": {}, @@ -9179,38 +8335,19 @@ "crm.account": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "name": { - "type": ["string", "null"] - }, - "is_deleted": { - "type": ["boolean", "null"] - }, - "website": { - "type": ["string", "null"] - }, - "industry": { - "type": ["string", "null"] - }, - "number_of_employees": { - "type": ["number", "null"] - }, - "owner_id": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, + "raw_data": {"type": "object", "additionalProperties": {}}, + "name": {"type": ["string", "null"]}, + "is_deleted": {"type": ["boolean", "null"]}, + "website": {"type": ["string", "null"]}, + "industry": {"type": ["string", "null"]}, + "number_of_employees": {"type": ["number", "null"]}, + "owner_id": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, "description": { "type": ["string", "null"], "example": "Integration API" @@ -9221,18 +8358,14 @@ }, "addresses": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/crm.address" - } + "items": {"$ref": "#/components/schemas/crm.address"} }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": { - "type": ["string", "null"] - }, + "phone_number": {"type": ["string", "null"]}, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -9242,44 +8375,24 @@ }, "lifecycle_stage": { "oneOf": [ - { - "$ref": "#/components/schemas/crm.lifecycle_stage" - }, - { - "type": "null" - } + {"$ref": "#/components/schemas/crm.lifecycle_stage"}, + {"type": "null"} ] }, - "last_modified_at": { - "type": ["string", "null"] - } + "last_modified_at": {"type": ["string", "null"]} }, "required": ["id", "updated_at"] }, "crm.address": { "type": "object", "properties": { - "address_type": { - "$ref": "#/components/schemas/crm.address_type" - }, - "city": { - "type": ["string", "null"] - }, - "country": { - "type": ["string", "null"] - }, - "postal_code": { - "type": ["string", "null"] - }, - "state": { - "type": ["string", "null"] - }, - "street_1": { - "type": ["string", "null"] - }, - "street_2": { - "type": ["string", "null"] - } + "address_type": {"$ref": "#/components/schemas/crm.address_type"}, + "city": {"type": ["string", "null"]}, + "country": {"type": ["string", "null"]}, + "postal_code": {"type": ["string", "null"]}, + "state": {"type": ["string", "null"]}, + "street_1": {"type": ["string", "null"]}, + "street_2": {"type": ["string", "null"]} }, "required": [ "address_type", @@ -9319,32 +8432,20 @@ "type": ["string", "null"], "example": "Integration API" }, - "industry": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "number_of_employees": { - "type": ["number", "null"] - }, - "website": { - "type": ["string", "null"] - }, + "industry": {"type": ["string", "null"]}, + "name": {"type": ["string", "null"]}, + "number_of_employees": {"type": ["number", "null"]}, + "website": {"type": ["string", "null"]}, "addresses": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/crm.address" - } + "items": {"$ref": "#/components/schemas/crm.address"} }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": { - "type": ["string", "null"] - }, + "phone_number": {"type": ["string", "null"]}, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -9352,17 +8453,11 @@ "required": ["phone_number", "phone_number_type"] } }, - "owner_id": { - "type": ["string", "null"] - }, + "owner_id": {"type": ["string", "null"]}, "lifecycle_stage": { "oneOf": [ - { - "$ref": "#/components/schemas/crm.lifecycle_stage" - }, - { - "type": "null" - } + {"$ref": "#/components/schemas/crm.lifecycle_stage"}, + {"type": "null"} ] }, "passthrough_fields": { @@ -9374,23 +8469,14 @@ "crm.contact": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "first_name": { - "type": ["string", "null"] - }, - "last_name": { - "type": ["string", "null"] - }, + "raw_data": {"type": "object", "additionalProperties": {}}, + "first_name": {"type": ["string", "null"]}, + "last_name": {"type": ["string", "null"]}, "email": { "type": ["string", "null"], "description": "Primary email address" @@ -9405,12 +8491,8 @@ "crm.contact_input": { "type": "object", "properties": { - "first_name": { - "type": ["string", "null"] - }, - "last_name": { - "type": ["string", "null"] - }, + "first_name": {"type": ["string", "null"]}, + "last_name": {"type": ["string", "null"]}, "email": { "type": ["string", "null"], "description": "Primary email address" @@ -9426,69 +8508,38 @@ } }, "crm.lead": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "updated_at": { - "type": "string", - "description": "ISO8601 date string" - }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "name": { - "type": ["string", "null"] - }, - "first_name": { - "type": ["string", "null"] - }, - "last_name": { - "type": ["string", "null"] - }, - "owner_id": { - "type": ["string", "null"] - }, - "title": { - "type": ["string", "null"] - }, - "company": { - "type": ["string", "null"] - }, - "converted_date": { - "type": ["string", "null"] - }, - "lead_source": { - "type": ["string", "null"] - }, - "converted_account_id": { - "type": ["string", "null"] - }, - "converted_contact_id": { - "type": ["string", "null"] + "type": "object", + "properties": { + "id": {"type": "string"}, + "updated_at": { + "type": "string", + "description": "ISO8601 date string" }, + "raw_data": {"type": "object", "additionalProperties": {}}, + "name": {"type": ["string", "null"]}, + "first_name": {"type": ["string", "null"]}, + "last_name": {"type": ["string", "null"]}, + "owner_id": {"type": ["string", "null"]}, + "title": {"type": ["string", "null"]}, + "company": {"type": ["string", "null"]}, + "converted_date": {"type": ["string", "null"]}, + "lead_source": {"type": ["string", "null"]}, + "converted_account_id": {"type": ["string", "null"]}, + "converted_contact_id": {"type": ["string", "null"]}, "addresses": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/crm.address" - } + "items": {"$ref": "#/components/schemas/crm.address"} }, "email_addresses": { "type": ["array", "null"], - "items": { - "$ref": "#/components/schemas/crm.email_address" - } + "items": {"$ref": "#/components/schemas/crm.email_address"} }, "phone_numbers": { "type": ["array", "null"], "items": { "type": "object", "properties": { - "phone_number": { - "type": ["string", "null"] - }, + "phone_number": {"type": ["string", "null"]}, "phone_number_type": { "$ref": "#/components/schemas/crm.phone_number_type" } @@ -9496,24 +8547,16 @@ "required": ["phone_number", "phone_number_type"] } }, - "created_at": { - "type": ["string", "null"] - }, - "is_deleted": { - "type": ["boolean", "null"] - }, - "last_modified_at": { - "type": ["string", "null"] - } + "created_at": {"type": ["string", "null"]}, + "is_deleted": {"type": ["boolean", "null"]}, + "last_modified_at": {"type": ["string", "null"]} }, "required": ["id", "updated_at"] }, "crm.email_address": { "type": "object", "properties": { - "email_address": { - "type": "string" - }, + "email_address": {"type": "string"}, "email_address_type": { "$ref": "#/components/schemas/crm.email_address_type" } @@ -9527,63 +8570,30 @@ "crm.opportunity": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "name": { - "type": ["string", "null"] - }, - "description": { - "type": ["string", "null"] - }, - "owner_id": { - "type": ["string", "null"] - }, + "raw_data": {"type": "object", "additionalProperties": {}}, + "name": {"type": ["string", "null"]}, + "description": {"type": ["string", "null"]}, + "owner_id": {"type": ["string", "null"]}, "status": { "oneOf": [ - { - "$ref": "#/components/schemas/crm.opportunity_status" - }, - { - "type": "null" - } + {"$ref": "#/components/schemas/crm.opportunity_status"}, + {"type": "null"} ] }, - "stage": { - "type": ["string", "null"] - }, - "close_date": { - "type": ["string", "null"] - }, - "account_id": { - "type": ["string", "null"] - }, - "pipeline": { - "type": ["string", "null"] - }, - "amount": { - "type": ["number", "null"] - }, - "last_activity_at": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, - "is_deleted": { - "type": ["boolean", "null"] - }, - "last_modified_at": { - "type": ["string", "null"] - } + "stage": {"type": ["string", "null"]}, + "close_date": {"type": ["string", "null"]}, + "account_id": {"type": ["string", "null"]}, + "pipeline": {"type": ["string", "null"]}, + "amount": {"type": ["number", "null"]}, + "last_activity_at": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, + "is_deleted": {"type": ["boolean", "null"]}, + "last_modified_at": {"type": ["string", "null"]} }, "required": ["id", "updated_at"] }, @@ -9594,29 +8604,20 @@ "crm.note": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "content": { - "type": ["string", "null"] - } + "raw_data": {"type": "object", "additionalProperties": {}}, + "content": {"type": ["string", "null"]} }, "required": ["id", "updated_at"] }, "crm.note_input": { "type": "object", "properties": { - "content": { - "type": ["string", "null"] - }, + "content": {"type": ["string", "null"]}, "passthrough_fields": { "type": ["object", "null"], "additionalProperties": {} @@ -9630,62 +8631,32 @@ "crm.user": { "type": "object", "properties": { - "id": { - "type": "string" - }, + "id": {"type": "string"}, "updated_at": { "type": "string", "description": "ISO8601 date string" }, - "raw_data": { - "type": "object", - "additionalProperties": {} - }, - "name": { - "type": ["string", "null"] - }, - "email": { - "type": ["string", "null"] - }, - "is_active": { - "type": ["boolean", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, - "is_deleted": { - "type": ["boolean", "null"] - }, - "last_modified_at": { - "type": ["string", "null"] - } + "raw_data": {"type": "object", "additionalProperties": {}}, + "name": {"type": ["string", "null"]}, + "email": {"type": ["string", "null"]}, + "is_active": {"type": ["boolean", "null"]}, + "created_at": {"type": ["string", "null"]}, + "is_deleted": {"type": ["boolean", "null"]}, + "last_modified_at": {"type": ["string", "null"]} }, "required": ["id", "updated_at"] }, "warning": { "type": "object", "properties": { - "title": { - "type": "string" - }, - "problem_type": { - "type": "string" - }, - "detail": { - "type": "string" - } + "title": {"type": "string"}, + "problem_type": {"type": "string"}, + "detail": {"type": "string"} } }, "crm.meta.object": { "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, + "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"] }, "crm.meta.custom_object_field": { @@ -9709,15 +8680,9 @@ }, "default_value": { "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } + {"type": "string"}, + {"type": "number"}, + {"type": "boolean"} ], "description": "The default value for the property. Only supported for Salesforce." }, @@ -9726,9 +8691,7 @@ "description": "Only applicable for Hubspot. If specified, OpenInt will attempt to attach the field to this group if it exists, or create it if it doesn't.", "example": "my group" }, - "type": { - "$ref": "#/components/schemas/crm.meta.property_type" - }, + "type": {"$ref": "#/components/schemas/crm.meta.property_type"}, "precision": { "type": "number", "description": "Only applicable in Salesforce. If not given, will default to 18." @@ -9739,9 +8702,7 @@ }, "options": { "type": "array", - "items": { - "$ref": "#/components/schemas/crm.meta.pick_list_option" - }, + "items": {"$ref": "#/components/schemas/crm.meta.pick_list_option"}, "description": "The list of options for a picklist/multipicklist field." }, "raw_details": { @@ -9771,21 +8732,10 @@ "crm.meta.pick_list_option": { "type": "object", "properties": { - "label": { - "type": "string", - "example": "Option 1" - }, - "value": { - "type": "string", - "example": "option_1" - }, - "description": { - "type": "string" - }, - "hidden": { - "type": "boolean", - "description": "Defaults to false." - } + "label": {"type": "string", "example": "Option 1"}, + "value": {"type": "string", "example": "option_1"}, + "description": {"type": "string"}, + "hidden": {"type": "boolean", "description": "Defaults to false."} }, "required": ["label", "value"] }, @@ -9819,150 +8769,76 @@ "crm.meta.association_schema": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "source_object": { - "type": "string", - "example": "contact" - }, - "target_object": { - "type": "string", - "example": "my_custom_object" - }, - "display_name": { - "type": "string" - } + "id": {"type": "string"}, + "source_object": {"type": "string", "example": "contact"}, + "target_object": {"type": "string", "example": "my_custom_object"}, + "display_name": {"type": "string"} }, "required": ["id", "source_object", "target_object", "display_name"] }, "banking.account": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "current_balance": { - "type": "number" - }, - "currency": { - "type": "string" - } + "id": {"type": "string"}, + "name": {"type": "string"}, + "current_balance": {"type": "number"}, + "currency": {"type": "string"} }, "required": ["id", "name"] }, "banking.merchant": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": ["string", "null"] - } + "id": {"type": "string"}, + "name": {"type": "string"}, + "url": {"type": ["string", "null"]} }, "required": ["id", "name"] }, "banking.category": { "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, + "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"] }, "banking.transaction": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "date": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, - "category_id": { - "type": ["string", "null"] - }, - "category_name": { - "type": ["string", "null"] - }, - "amount": { - "type": "number" - }, - "currency": { - "type": "string" - }, - "merchant_id": { - "type": ["string", "null"] - }, - "merchant_name": { - "type": ["string", "null"] - }, - "account_id": { - "type": ["string", "null"] - }, - "account_name": { - "type": ["string", "null"] - } + "id": {"type": "string"}, + "date": {"type": "string"}, + "description": {"type": ["string", "null"]}, + "category_id": {"type": ["string", "null"]}, + "category_name": {"type": ["string", "null"]}, + "amount": {"type": "number"}, + "currency": {"type": "string"}, + "merchant_id": {"type": ["string", "null"]}, + "merchant_name": {"type": ["string", "null"]}, + "account_id": {"type": ["string", "null"]}, + "account_name": {"type": ["string", "null"]} }, "required": ["id", "date", "amount", "currency"] }, "ats.job": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "modified_at": { - "type": "string" - }, - "name": { - "type": "string" - }, - "confidential": { - "type": "boolean" - }, + "id": {"type": "string"}, + "created_at": {"type": "string"}, + "modified_at": {"type": "string"}, + "name": {"type": "string"}, + "confidential": {"type": "boolean"}, "departments": { "type": "array", - "items": { - "$ref": "#/components/schemas/ats.department" - } + "items": {"$ref": "#/components/schemas/ats.department"} }, "offices": { "type": ["array", "null"], - "items": { - "type": "object", - "additionalProperties": {} - } + "items": {"type": "object", "additionalProperties": {}} }, "hiring_managers": {}, "recruiters": { "type": ["array", "null"], - "items": { - "type": "object", - "additionalProperties": {} - } + "items": {"type": "object", "additionalProperties": {}} }, - "raw_data": { - "type": "object", - "additionalProperties": {} - } + "raw_data": {"type": "object", "additionalProperties": {}} }, "required": [ "id", @@ -9977,65 +8853,33 @@ "ats.department": { "type": "object", "properties": { - "id": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, - "modified_at": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "parent_id": { - "type": ["string", "null"] - }, - "parent_department_external_id": { - "type": ["string", "null"] - }, + "id": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, + "modified_at": {"type": ["string", "null"]}, + "name": {"type": ["string", "null"]}, + "parent_id": {"type": ["string", "null"]}, + "parent_department_external_id": {"type": ["string", "null"]}, "child_ids": { "type": ["array", "null"], - "items": { - "type": ["string", "null"] - } + "items": {"type": ["string", "null"]} }, "child_department_external_ids": { "type": ["array", "null"], - "items": { - "type": ["string", "null"] - } + "items": {"type": ["string", "null"]} }, - "raw_data": { - "type": "object", - "additionalProperties": {} - } + "raw_data": {"type": "object", "additionalProperties": {}} }, "description": "A department in an organization" }, "ats.opening": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "modified_at": { - "type": "string" - }, - "status": { - "type": "string" - }, - "job_id": { - "type": "string" - }, - "raw_data": { - "type": "object", - "additionalProperties": {} - } + "id": {"type": "string"}, + "created_at": {"type": "string"}, + "modified_at": {"type": "string"}, + "status": {"type": "string"}, + "job_id": {"type": "string"}, + "raw_data": {"type": "object", "additionalProperties": {}} }, "required": ["id", "created_at", "modified_at", "status", "job_id"], "description": "An opening for a job" @@ -10043,34 +8887,15 @@ "ats.offer": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "modified_at": { - "type": "string" - }, - "application": { - "type": ["string", "null"] - }, - "closed_at": { - "type": ["string", "null"] - }, - "sent_at": { - "type": ["string", "null"] - }, - "start_date": { - "type": ["string", "null"] - }, - "status": { - "type": ["string", "null"] - }, - "raw_data": { - "type": "object", - "additionalProperties": {} - } + "id": {"type": "string"}, + "created_at": {"type": "string"}, + "modified_at": {"type": "string"}, + "application": {"type": ["string", "null"]}, + "closed_at": {"type": ["string", "null"]}, + "sent_at": {"type": ["string", "null"]}, + "start_date": {"type": ["string", "null"]}, + "status": {"type": ["string", "null"]}, + "raw_data": {"type": "object", "additionalProperties": {}} }, "required": ["id", "created_at", "modified_at"], "description": "An offer to a candidate" @@ -10078,75 +8903,30 @@ "ats.candidate": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "created_at": { - "type": ["string", "null"] - }, - "modified_at": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "first_name": { - "type": ["string", "null"] - }, - "last_name": { - "type": ["string", "null"] - }, - "company": { - "type": ["string", "null"] - }, - "title": { - "type": ["string", "null"] - }, - "last_interaction_at": { - "type": ["string", "null"] - }, - "is_private": { - "type": ["boolean", "null"] - }, - "can_email": { - "type": ["boolean", "null"] - }, - "locations": { - "type": ["array", "null"], - "items": {} - }, + "id": {"type": "string"}, + "created_at": {"type": ["string", "null"]}, + "modified_at": {"type": ["string", "null"]}, + "name": {"type": ["string", "null"]}, + "first_name": {"type": ["string", "null"]}, + "last_name": {"type": ["string", "null"]}, + "company": {"type": ["string", "null"]}, + "title": {"type": ["string", "null"]}, + "last_interaction_at": {"type": ["string", "null"]}, + "is_private": {"type": ["boolean", "null"]}, + "can_email": {"type": ["boolean", "null"]}, + "locations": {"type": ["array", "null"], "items": {}}, "phone_numbers": { "type": ["array", "null"], - "items": { - "type": "object", - "additionalProperties": {} - } + "items": {"type": "object", "additionalProperties": {}} }, "email_addresses": { "type": ["array", "null"], - "items": { - "type": "object", - "additionalProperties": {} - } - }, - "tags": { - "type": ["array", "null"], - "items": { - "type": "string" - } - }, - "applications": { - "type": ["array", "null"], - "items": {} - }, - "attachments": { - "type": ["array", "null"], - "items": {} + "items": {"type": "object", "additionalProperties": {}} }, - "raw_data": { - "type": "object", - "additionalProperties": {} - } + "tags": {"type": ["array", "null"], "items": {"type": "string"}}, + "applications": {"type": ["array", "null"], "items": {}}, + "attachments": {"type": ["array", "null"], "items": {}}, + "raw_data": {"type": "object", "additionalProperties": {}} }, "required": ["id"], "description": "A candidate for a job" @@ -10154,21 +8934,11 @@ "unified.drivegroup": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, - "updated_at": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, + "id": {"type": "string"}, + "name": {"type": "string"}, + "description": {"type": ["string", "null"]}, + "updated_at": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, "raw_data": {} }, "required": ["id", "name"], @@ -10177,21 +8947,11 @@ "unified.drive": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, - "updated_at": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, + "id": {"type": "string"}, + "name": {"type": "string"}, + "description": {"type": ["string", "null"]}, + "updated_at": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, "raw_data": {} }, "required": ["id", "name"], @@ -10200,55 +8960,26 @@ "unified.file": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": ["string", "null"] - }, - "description": { - "type": ["string", "null"] - }, - "type": { - "type": "string", - "enum": ["file", "folder", "url"] - }, - "path": { - "type": ["string", "null"] - }, - "mime_type": { - "type": ["string", "null"] - }, - "downloadable": { - "type": "boolean" - }, - "size": { - "type": ["number", "null"] - }, + "id": {"type": "string"}, + "name": {"type": ["string", "null"]}, + "description": {"type": ["string", "null"]}, + "type": {"type": "string", "enum": ["file", "folder", "url"]}, + "path": {"type": ["string", "null"]}, + "mime_type": {"type": ["string", "null"]}, + "downloadable": {"type": "boolean"}, + "size": {"type": ["number", "null"]}, "permissions": { "type": "object", - "properties": { - "download": { - "type": "boolean" - } - }, + "properties": {"download": {"type": "boolean"}}, "required": ["download"] }, - "exportable": { - "type": "boolean" - }, + "exportable": {"type": "boolean"}, "export_formats": { "type": ["array", "null"], - "items": { - "type": "string" - } - }, - "updated_at": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] + "items": {"type": "string"} }, + "updated_at": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, "raw_data": {} }, "required": ["id", "type", "downloadable", "permissions", "exportable"], @@ -10257,24 +8988,12 @@ "unified.folder": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, - "path": { - "type": "string" - }, - "updated_at": { - "type": ["string", "null"] - }, - "created_at": { - "type": ["string", "null"] - }, + "id": {"type": "string"}, + "name": {"type": "string"}, + "description": {"type": ["string", "null"]}, + "path": {"type": "string"}, + "updated_at": {"type": ["string", "null"]}, + "created_at": {"type": ["string", "null"]}, "raw_data": {} }, "required": ["id", "name", "path"], @@ -10282,10 +9001,5 @@ } } }, - "security": [ - { - "apikey": [], - "connectionId": [] - } - ] + "security": [{"apikey": [], "connectionId": []}] } diff --git a/sdks/sdk-openint/openint.oas.types.d.ts b/sdks/sdk-openint/openint.oas.types.d.ts index 6d04946..3d769b7 100644 --- a/sdks/sdk-openint/openint.oas.types.d.ts +++ b/sdks/sdk-openint/openint.oas.types.d.ts @@ -67,6 +67,23 @@ export interface paths { patch?: never trace?: never } + '/connect/file-picker': { + parameters: { + query?: never + header?: never + path?: never + cookie?: never + } + get?: never + put?: never + /** Create file picker link */ + post: operations['createFilePickerLink'] + delete?: never + options?: never + head?: never + patch?: never + trace?: never + } '/core/customer/{id}': { parameters: { query?: never @@ -2695,6 +2712,8 @@ export interface operations { connectorNames?: string | null /** @description Filter integrations by comma separated integration ids */ integrationIds?: string | null + /** @description Filter managed connections by connection id */ + connectionId?: string | null /** * @description Magic Link display theme * @enum {string|null} @@ -2740,6 +2759,87 @@ export interface operations { } } } + createFilePickerLink: { + parameters: { + query?: never + header?: never + path?: never + cookie?: never + } + requestBody: { + content: { + 'application/json': { + /** @description Anything that uniquely identifies the customer that you will be sending the magic link to */ + customerId?: string + /** + * @description How long the magic link will be valid for (in seconds) before it expires + * @default 2592000 + */ + validityInSeconds?: number + /** @enum {string|null} */ + theme?: 'light' | 'dark' | null + multiSelect?: boolean | null + folderSelect?: boolean | null + themeColors?: { + accent?: string | null + background?: string | null + border?: string | null + button?: string | null + buttonLight?: string | null + buttonForeground?: string | null + buttonHover?: string | null + buttonStroke?: string | null + buttonSecondary?: string | null + buttonSecondaryForeground?: string | null + buttonSecondaryStroke?: string | null + buttonSecondaryHover?: string | null + card?: string | null + cardForeground?: string | null + foreground?: string | null + navbar?: string | null + primary?: string | null + primaryForeground?: string | null + secondary?: string | null + secondaryForeground?: string | null + sidebar?: string | null + tab?: string | null + } | null + connectionId: string + } + } + } + responses: { + /** @description Successful response */ + 200: { + headers: { + [name: string]: unknown + } + content: { + 'application/json': { + url: string + } + } + } + /** @description Invalid input data */ + 400: { + headers: { + [name: string]: unknown + } + content: { + 'application/json': components['schemas']['error.BAD_REQUEST'] + } + } + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown + } + content: { + 'application/json': components['schemas']['error.INTERNAL_SERVER_ERROR'] + } + } + } + } upsertCustomer: { parameters: { query?: never diff --git a/sdks/sdk-openint/package.json b/sdks/sdk-openint/package.json index def3609..737981b 100644 --- a/sdks/sdk-openint/package.json +++ b/sdks/sdk-openint/package.json @@ -1,6 +1,6 @@ { "name": "@opensdks/sdk-openint", - "version": "0.1.10", + "version": "0.1.11", "type": "module", "exports": { ".": { From dc149bf7c48ad3006eb7308a0e3f63c1471b8a80 Mon Sep 17 00:00:00 2001 From: Amadeo Pellicce Date: Sun, 26 Jan 2025 12:11:29 -0800 Subject: [PATCH 3/5] fixing auth types --- packages/fetch-links/links/authLink.ts | 9 +- sdks/sdk-openint/src/index.spec.ts | 449 +++++++++++++++++++++++++ sdks/sdk-openint/src/index.ts | 10 +- 3 files changed, 459 insertions(+), 9 deletions(-) diff --git a/packages/fetch-links/links/authLink.ts b/packages/fetch-links/links/authLink.ts index b0f59ff..d8e5fd8 100644 --- a/packages/fetch-links/links/authLink.ts +++ b/packages/fetch-links/links/authLink.ts @@ -3,13 +3,13 @@ import {openIntProxyLink, OpenIntProxyLinkOptions} from './openIntProxyLink.js' import {mergeHeaders, modifyRequest} from '../modifyRequestResponse.js' import type {Link} from '../link.js' -export type ClientAuthOptions = +export type ClientAuthOptions = Partial> type Indexify = T & Record type AllUnionKeys = keyof UnionToIntersection<{[K in keyof T]: undefined}> @@ -17,12 +17,11 @@ type NonDiscriminatedUnion = { [K in AllUnionKeys & string]: Indexify[K] } -export function authLink(_auth: ClientAuthOptions, baseUrl: string): Link { - if (!_auth) { +export function authLink(auth: ClientAuthOptions, baseUrl: string): Link { + if (!auth) { // No Op return (req, next) => next(req) } - const auth = _auth as NonDiscriminatedUnion if (auth.openInt) { return openIntProxyLink(auth.openInt, baseUrl) diff --git a/sdks/sdk-openint/src/index.spec.ts b/sdks/sdk-openint/src/index.spec.ts index 1010bcc..9218c8c 100644 --- a/sdks/sdk-openint/src/index.spec.ts +++ b/sdks/sdk-openint/src/index.spec.ts @@ -49,3 +49,452 @@ test('swr-openapi integration', () => { expect(MyComponent).toBeTruthy() }) + +describe('OpenInt SDK Authentication', () => { + test('client initialization with direct headers', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'test-api-key', + 'x-connection-id': 'test-connection', + authorization: 'Bearer test-token', + 'x-connection-customer-id': 'test-customer', + 'x-connection-connector-name': 'test-connector' + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key', + 'x-connection-id': 'test-connection', + authorization: 'Bearer test-token', + 'x-connection-customer-id': 'test-customer', + 'x-connection-connector-name': 'test-connector' + }) + }) + + test('initialization with empty headers should work', () => { + const client = initOpenIntSDK({ headers: {} }) + expect(client.clientOptions.headers).toEqual({}) + }) + + test('initialization with undefined headers should work', () => { + const client = initOpenIntSDK({ headers: undefined as any }) + expect(client.clientOptions.headers).toEqual({}) + }) + + test('initialization with partial headers should work', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'test-api-key', + // only providing some headers + } + }) + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key' + }) + }) + + test('client initialization with auth.openInt', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + apiKey: 'test-api-key', + connectionId: 'test-connection', + token: 'test-token', + customerId: 'test-customer', + connectorName: 'test-connector' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key', + 'x-connection-id': 'test-connection', + authorization: 'Bearer test-token', + 'x-connection-customer-id': 'test-customer', + 'x-connection-connector-name': 'test-connector' + }) + }) + + test('initialization with empty auth.openInt should work', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: {} + } + }) + expect(client.clientOptions.headers).toEqual({}) + }) + + test('initialization with partial auth.openInt should work', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + apiKey: 'test-api-key', + // only providing some auth options + } + } + }) + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key' + }) + }) + + test('client initialization with mixed headers and auth.openInt', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'direct-api-key', + 'x-connection-id': 'direct-connection' + }, + auth: { + openInt: { + token: 'auth-token', + customerId: 'auth-customer', + connectorName: 'auth-connector' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'direct-api-key', + 'x-connection-id': 'direct-connection', + authorization: 'Bearer auth-token', + 'x-connection-customer-id': 'auth-customer', + 'x-connection-connector-name': 'auth-connector' + }) + }) + + test('auth.openInt is removed after initialization', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + apiKey: 'test-api-key' + } + } + }) + + expect(client.clientOptions.auth?.openInt).toBeUndefined() + }) + + test('multiple auth methods should work together', () => { + const client = initOpenIntSDK({ + headers: { + 'x-custom-header': 'custom-value' + }, + auth: { + openInt: { + apiKey: 'test-api-key' + }, + bearer: 'bearer-token', // This should be ignored since openInt is present + basic: { + username: 'user', + password: 'pass' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key', + 'x-custom-header': 'custom-value' + }) + }) + + test('auth options should handle malformed input', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: null as any, + bearer: undefined, + basic: {} as any + } + }) + + expect(client.clientOptions.headers).toEqual({}) + }) +}) + +describe('OpenInt SDK Header Precedence', () => { + test('auth.openInt should override direct headers', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + 'x-connection-id': 'header-connection', + authorization: 'Bearer header-token', + 'x-connection-customer-id': 'header-customer', + 'x-connection-connector-name': 'header-connector' + }, + auth: { + openInt: { + apiKey: 'auth-api-key', + connectionId: 'auth-connection', + token: 'auth-token', + customerId: 'auth-customer', + connectorName: 'auth-connector' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'auth-api-key', + 'x-connection-id': 'auth-connection', + authorization: 'Bearer auth-token', + 'x-connection-customer-id': 'auth-customer', + 'x-connection-connector-name': 'auth-connector' + }) + }) + + test('partial auth.openInt should override only corresponding headers', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + 'x-connection-id': 'header-connection', + authorization: 'Bearer header-token', + 'x-connection-customer-id': 'header-customer', + 'x-connection-connector-name': 'header-connector' + }, + auth: { + openInt: { + apiKey: 'auth-api-key', + token: 'auth-token', + // Only override apiKey and token + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'auth-api-key', + 'x-connection-id': 'header-connection', + authorization: 'Bearer auth-token', + 'x-connection-customer-id': 'header-customer', + 'x-connection-connector-name': 'header-connector' + }) + }) + + test('auth.openInt empty values should not override existing headers', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + 'x-connection-id': 'header-connection' + }, + auth: { + openInt: { + apiKey: '', + connectionId: undefined, + token: null as any + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'header-api-key', + 'x-connection-id': 'header-connection' + }) + }) + + test('custom headers should be preserved when using auth.openInt', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + 'x-custom-header': 'custom-value', + 'x-another-custom': 'another-value' + }, + auth: { + openInt: { + apiKey: 'auth-api-key', + token: 'auth-token' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'auth-api-key', + authorization: 'Bearer auth-token', + 'x-custom-header': 'custom-value', + 'x-another-custom': 'another-value' + }) + }) + + test('auth.openInt should handle falsy values correctly', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + 'x-connection-id': 'header-connection' + }, + auth: { + openInt: { + apiKey: '', + connectionId: '0', // Should be set even though it's falsy + token: false as any, + customerId: 0 as any + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'header-api-key', + 'x-connection-id': '0' + }) + }) + + test('multiple auth methods with headers should prioritize openInt', () => { + const client = initOpenIntSDK({ + headers: { + 'x-apikey': 'header-api-key', + authorization: 'Bearer header-token' + }, + auth: { + openInt: { + apiKey: 'openint-api-key', + token: 'openint-token' + }, + bearer: 'bearer-token', + basic: { + username: 'user', + password: 'pass' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'openint-api-key', + authorization: 'Bearer openint-token' + }) + }) +}) + +// TODO: these tests are not working as expected, investigate +describe('Bearer and Basic Auth Precedence', () => { + // test('bearer auth should override authorization header', () => { + // const client = initOpenIntSDK({ + // headers: { + // 'x-custom-header': 'custom-value' + // }, + // auth: { + // bearer: 'bearer-token' + // } + // }) + + // expect(client.clientOptions.headers).toEqual({ + // 'authorization': 'Bearer bearer-token', + // 'x-custom-header': 'custom-value' + // }) + // }) + + // test('bearer auth should take precedence over basic auth', () => { + // const client = initOpenIntSDK({ + // headers: { + // 'x-custom-header': 'custom-value' + // }, + // auth: { + // bearer: 'bearer-token' + // } + // }) + + // expect(client.clientOptions.headers).toEqual({ + // 'authorization': 'Bearer bearer-token', + // 'x-custom-header': 'custom-value' + // }) + // }) +}) + +describe('OpenInt Individual Parameters', () => { + test('apiKey parameter should set x-apikey header', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + apiKey: 'test-api-key' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key' + }) + }) + + test('token parameter should set authorization header', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + token: 'test-token' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'authorization': 'Bearer test-token' + }) + }) + + test('connectionId parameter should set x-connection-id header', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + connectionId: 'test-connection' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-connection-id': 'test-connection' + }) + }) + + test('customerId parameter should set x-connection-customer-id header', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + customerId: 'test-customer' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-connection-customer-id': 'test-customer' + }) + }) + + test('connectorName parameter should set x-connection-connector-name header', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + connectorName: 'test-connector' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-connection-connector-name': 'test-connector' + }) + }) + + test('all parameters should set corresponding headers', () => { + const client = initOpenIntSDK({ + headers: {}, + auth: { + openInt: { + apiKey: 'test-api-key', + token: 'test-token', + connectionId: 'test-connection', + customerId: 'test-customer', + connectorName: 'test-connector' + } + } + }) + + expect(client.clientOptions.headers).toEqual({ + 'x-apikey': 'test-api-key', + 'authorization': 'Bearer test-token', + 'x-connection-id': 'test-connection', + 'x-connection-customer-id': 'test-customer', + 'x-connection-connector-name': 'test-connector' + }) + }) +}) diff --git a/sdks/sdk-openint/src/index.ts b/sdks/sdk-openint/src/index.ts index 7bbcbc2..ec283e2 100644 --- a/sdks/sdk-openint/src/index.ts +++ b/sdks/sdk-openint/src/index.ts @@ -54,10 +54,12 @@ function generateHeaders(opts: OpenIntSDKTypes['options']) { } export function initOpenIntSDK(opts: OpenIntSDKTypes['options']) { - // @ts-expect-error - const headers = {...opts.headers, ...generateHeaders({...opts, ...opts?.auth?.openInt})} - // @ts-expect-error - delete opts?.auth?.openInt; + const headers = {...opts.headers, ...generateHeaders({...opts, ...opts.auth?.openInt})} + + if(opts.auth?.openInt) { + delete opts?.auth?.openInt; + } + return initSDK(openintSdkDef, { ...opts, From 075b03ca0a27315a71ed222f6ed88a1a8b80231a Mon Sep 17 00:00:00 2001 From: Amadeo Pellicce Date: Sun, 26 Jan 2025 12:12:34 -0800 Subject: [PATCH 4/5] new file endpoints --- sdks/sdk-openint/openint.oas.json | 19 +++++++++++-------- sdks/sdk-openint/openint.oas.types.d.ts | 15 ++++++++------- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/sdks/sdk-openint/openint.oas.json b/sdks/sdk-openint/openint.oas.json index 5533306..11566ec 100644 --- a/sdks/sdk-openint/openint.oas.json +++ b/sdks/sdk-openint/openint.oas.json @@ -332,7 +332,10 @@ "tab": {"type": ["string", "null"]} } }, - "connectionId": {"type": "string"} + "connectionId": { + "type": "string", + "description": "Must start with 'conn_'" + } }, "required": ["connectionId"] } @@ -7194,7 +7197,7 @@ } } }, - "/unified/file-storage/drive-groups": { + "/unified/file-storage/drive-group": { "get": { "operationId": "fileStorage-listDriveGroups", "summary": "List drive groups", @@ -7263,7 +7266,7 @@ } } }, - "/unified/file-storage/drives": { + "/unified/file-storage/drive": { "get": { "operationId": "fileStorage-listDrives", "summary": "List drives", @@ -7335,7 +7338,7 @@ } } }, - "/unified/file-storage/files": { + "/unified/file-storage/file": { "get": { "operationId": "fileStorage-listFiles", "summary": "List files", @@ -7404,7 +7407,7 @@ } } }, - "/unified/file-storage/files/{id}": { + "/unified/file-storage/file/{id}": { "get": { "operationId": "fileStorage-getFile", "summary": "Get file", @@ -7455,7 +7458,7 @@ } } }, - "/unified/file-storage/files/{id}/export": { + "/unified/file-storage/file/{id}/export": { "get": { "operationId": "fileStorage-exportFile", "summary": "Export file", @@ -7508,7 +7511,7 @@ } } }, - "/unified/file-storage/files/{id}/download": { + "/unified/file-storage/file/{id}/download": { "get": { "operationId": "fileStorage-downloadFile", "summary": "Download file", @@ -7555,7 +7558,7 @@ } } }, - "/unified/file-storage/folders": { + "/unified/file-storage/folder": { "get": { "operationId": "fileStorage-listFolders", "summary": "List folders", diff --git a/sdks/sdk-openint/openint.oas.types.d.ts b/sdks/sdk-openint/openint.oas.types.d.ts index 3d769b7..5f977fa 100644 --- a/sdks/sdk-openint/openint.oas.types.d.ts +++ b/sdks/sdk-openint/openint.oas.types.d.ts @@ -1457,7 +1457,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/drive-groups': { + '/unified/file-storage/drive-group': { parameters: { query?: never header?: never @@ -1474,7 +1474,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/drives': { + '/unified/file-storage/drive': { parameters: { query?: never header?: never @@ -1491,7 +1491,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/files': { + '/unified/file-storage/file': { parameters: { query?: never header?: never @@ -1508,7 +1508,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/files/{id}': { + '/unified/file-storage/file/{id}': { parameters: { query?: never header?: never @@ -1525,7 +1525,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/files/{id}/export': { + '/unified/file-storage/file/{id}/export': { parameters: { query?: never header?: never @@ -1542,7 +1542,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/files/{id}/download': { + '/unified/file-storage/file/{id}/download': { parameters: { query?: never header?: never @@ -1559,7 +1559,7 @@ export interface paths { patch?: never trace?: never } - '/unified/file-storage/folders': { + '/unified/file-storage/folder': { parameters: { query?: never header?: never @@ -2804,6 +2804,7 @@ export interface operations { sidebar?: string | null tab?: string | null } | null + /** @description Must start with 'conn_' */ connectionId: string } } From 01043d566bf165177460c250f26a0eda66d579ac Mon Sep 17 00:00:00 2001 From: Amadeo Pellicce Date: Sun, 26 Jan 2025 12:14:07 -0800 Subject: [PATCH 5/5] bumping version --- sdks/sdk-openint/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdks/sdk-openint/package.json b/sdks/sdk-openint/package.json index 737981b..38713bb 100644 --- a/sdks/sdk-openint/package.json +++ b/sdks/sdk-openint/package.json @@ -1,6 +1,6 @@ { "name": "@opensdks/sdk-openint", - "version": "0.1.11", + "version": "0.1.12", "type": "module", "exports": { ".": {