From 2af18e69f291df7e165fa534fff6a215c897d4c2 Mon Sep 17 00:00:00 2001 From: Codat Pipeline Bot Date: Mon, 16 Sep 2024 16:01:08 +0000 Subject: [PATCH] Latest Open API Specification --- static/oas/Codat-Bank-Feeds.json | 7 ++ static/oas/Codat-Lending.json | 7 ++ static/oas/Codat-Platform.json | 104 ++++++++++++++++++++++++- static/oas/Codat-Sync-Commerce-v1.json | 7 ++ static/oas/Codat-Sync-Commerce.json | 7 ++ static/oas/Codat-Sync-Expenses-v1.json | 7 ++ static/oas/Codat-Sync-Expenses.json | 7 ++ static/oas/Codat-Sync-Payables-v1.json | 7 ++ static/oas/Codat-Sync-Payables.json | 7 ++ static/oas/Codat-Sync-Payroll.json | 7 ++ static/oas/Webhooks.json | 7 ++ 11 files changed, 173 insertions(+), 1 deletion(-) diff --git a/static/oas/Codat-Bank-Feeds.json b/static/oas/Codat-Bank-Feeds.json index d5912215c..aa5945301 100644 --- a/static/oas/Codat-Bank-Feeds.json +++ b/static/oas/Codat-Bank-Feeds.json @@ -4962,6 +4962,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Lending.json b/static/oas/Codat-Lending.json index 3316dcd3e..6cb24443d 100644 --- a/static/oas/Codat-Lending.json +++ b/static/oas/Codat-Lending.json @@ -117481,6 +117481,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Platform.json b/static/oas/Codat-Platform.json index 6e2e644fd..96a5101f8 100644 --- a/static/oas/Codat-Platform.json +++ b/static/oas/Codat-Platform.json @@ -628,6 +628,86 @@ } } }, + "/companies/{companyId}/products/{productIdentifier}": { + "parameters": [ + { + "$ref": "#/components/parameters/companyId" + }, + { + "$ref": "#/components/parameters/productIdentifier" + } + ], + "put": { + "summary": "Add product", + "operationId": "add-product", + "x-speakeasy-name-override": "add-product", + "description": "Use the *Add product* endpoint to enable a product for the company specified by `companyId`.\n\n> Note: This feature is currently in alpha and available only to participants in the development program.", + "tags": [ + "Companies" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "402": { + "$ref": "#/components/responses/Payment-Required" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/Not-Found" + }, + "429": { + "$ref": "#/components/responses/Too-Many-Requests" + }, + "500": { + "$ref": "#/components/responses/Internal-Server-Error" + }, + "503": { + "$ref": "#/components/responses/Service-Unavailable" + } + } + }, + "delete": { + "summary": "Remove product", + "operationId": "remove-product", + "x-speakeasy-name-override": "remove-product", + "description": "Use the *Remove product* endpoint to disable a product for the company specified by `companyId`.\n\n> Note: This feature is currently in alpha and available only to participants in the development program.", + "tags": [ + "Companies" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "402": { + "$ref": "#/components/responses/Payment-Required" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/Not-Found" + }, + "429": { + "$ref": "#/components/responses/Too-Many-Requests" + }, + "500": { + "$ref": "#/components/responses/Internal-Server-Error" + }, + "503": { + "$ref": "#/components/responses/Service-Unavailable" + } + } + } + }, "/companies/{companyId}/connections": { "get": { "summary": "List connections", @@ -4748,6 +4828,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, @@ -7865,6 +7952,21 @@ }, "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)." }, + "productIdentifier": { + "name": "productIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "examples": [ + "bank-feeds", + "lending", + "payables", + "expenses" + ] + }, + "description": "Human-readable product identifier for a product." + }, "query": { "name": "query", "in": "query", @@ -7887,7 +7989,7 @@ }, "dataType": { "name": "dataType", - "description": "The key of a Codat data type", + "description": "The key of a Codat data type.", "in": "path", "required": true, "schema": { diff --git a/static/oas/Codat-Sync-Commerce-v1.json b/static/oas/Codat-Sync-Commerce-v1.json index 7194b4302..660d2b163 100644 --- a/static/oas/Codat-Sync-Commerce-v1.json +++ b/static/oas/Codat-Sync-Commerce-v1.json @@ -17376,6 +17376,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Commerce.json b/static/oas/Codat-Sync-Commerce.json index cc65b29dd..281e62d3b 100644 --- a/static/oas/Codat-Sync-Commerce.json +++ b/static/oas/Codat-Sync-Commerce.json @@ -1697,6 +1697,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Expenses-v1.json b/static/oas/Codat-Sync-Expenses-v1.json index a43a7e10b..9faaef8ec 100644 --- a/static/oas/Codat-Sync-Expenses-v1.json +++ b/static/oas/Codat-Sync-Expenses-v1.json @@ -2122,6 +2122,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Expenses.json b/static/oas/Codat-Sync-Expenses.json index 4e960fd26..4050e89b5 100644 --- a/static/oas/Codat-Sync-Expenses.json +++ b/static/oas/Codat-Sync-Expenses.json @@ -15151,6 +15151,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Payables-v1.json b/static/oas/Codat-Sync-Payables-v1.json index 98c6f7f76..89bb2b46e 100644 --- a/static/oas/Codat-Sync-Payables-v1.json +++ b/static/oas/Codat-Sync-Payables-v1.json @@ -46048,6 +46048,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Payables.json b/static/oas/Codat-Sync-Payables.json index ce0aa7314..c9b53d3e9 100644 --- a/static/oas/Codat-Sync-Payables.json +++ b/static/oas/Codat-Sync-Payables.json @@ -3272,6 +3272,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Codat-Sync-Payroll.json b/static/oas/Codat-Sync-Payroll.json index 368d9a471..2a5aa4b75 100644 --- a/static/oas/Codat-Sync-Payroll.json +++ b/static/oas/Codat-Sync-Payroll.json @@ -14891,6 +14891,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10, diff --git a/static/oas/Webhooks.json b/static/oas/Webhooks.json index 3d55cfef8..7bafdac75 100644 --- a/static/oas/Webhooks.json +++ b/static/oas/Webhooks.json @@ -1592,6 +1592,13 @@ "description": "Name of user that created the company in Codat.", "nullable": true }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of products that are currently enabled for the company." + }, "tags": { "type": "object", "maxProperties": 10,