diff --git a/static/oas/Codat-Assess.json b/static/oas/Codat-Assess.json index 975d605fc..b8df8dca6 100644 --- a/static/oas/Codat-Assess.json +++ b/static/oas/Codat-Assess.json @@ -2647,109 +2647,6 @@ ] } }, - "/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process": { - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - }, - { - "$ref": "#/components/parameters/connectionId" - } - ], - "get": { - "summary": "Generate key subscription revenue metrics", - "tags": [ - "Reports" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Report" - } - } - } - }, - "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" - } - }, - "operationId": "request-recurring-revenue-metrics", - "description": "Requests production of key subscription revenue metrics." - } - }, - "/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr": { - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - }, - { - "$ref": "#/components/parameters/connectionId" - } - ], - "get": { - "summary": "Get key subscription revenue metrics", - "tags": [ - "Reports" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Report" - } - } - } - }, - "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" - } - }, - "operationId": "get-recurring-revenue-metrics", - "x-speakeasy-name-override": "get-recurring-revenue-metrics", - "description": "Gets key metrics for subscription revenue." - } - }, "/data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing": { "parameters": [ { diff --git a/static/oas/Codat-Bank-Feeds.json b/static/oas/Codat-Bank-Feeds.json index 23a5e21d1..1e6120555 100644 --- a/static/oas/Codat-Bank-Feeds.json +++ b/static/oas/Codat-Bank-Feeds.json @@ -110,10 +110,6 @@ "name": "Connections", "description": "Create new and manage existing data connections for a company." }, - { - "name": "Configuration", - "description": "Configure bank feeds for a company." - }, { "name": "Bank accounts", "description": "Access bank accounts in an SMBs accounting software." @@ -122,10 +118,6 @@ "name": "Source accounts", "description": "Provide and manage lists of source bank accounts." }, - { - "name": "Sync", - "description": "Monitor the status of data syncs." - }, { "name": "Account mapping", "description": "Extra functionality for building an account management UI." @@ -1264,161 +1256,6 @@ } } }, - "/companies/{companyId}/sync/banking/config": { - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - } - ], - "get": { - "summary": "Get configuration", - "operationId": "get-configuration", - "x-internal": true, - "tags": [ - "Configuration" - ], - "description": "The *Get configuration* endpoint returns the current configuration for a given company ID.", - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Configuration" - }, - "examples": {} - } - } - }, - "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" - } - } - }, - "post": { - "summary": "Set configuration", - "operationId": "set-configuration", - "x-speakeasy-name-override": "set", - "x-internal": true, - "tags": [ - "Configuration" - ], - "description": "Use *Set configuration* endpoint to configure a given company ID.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Configuration" - }, - "examples": {} - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Configuration" - }, - "examples": {} - } - } - }, - "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}/sync/banking/syncs/lastSuccessful/status": { - "get": { - "tags": [ - "Sync" - ], - "description": "Use the _Get last successful sync_ endpoint to obtain the status information for the company's [most recent successful sync](https://docs.codat.io/bank-feeds-api#/schemas/CompanySyncStatus). ", - "parameters": [ - { - "$ref": "#/components/parameters/companyId" - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CompanySyncStatus" - }, - "examples": {} - } - } - }, - "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" - } - }, - "summary": "Get last successful sync", - "operationId": "get-last-successful", - "x-speakeasy-name-override": "get-last-successful-sync", - "x-internal": true - } - }, "/companies/{companyId}/connections/{connectionId}/data/bankAccounts": { "parameters": [ { @@ -5810,84 +5647,6 @@ "name" ] }, - "CompanySyncStatus": { - "title": "Company sync status", - "type": "object", - "additionalProperties": false, - "x-examples": { - "Success Data Pushed": { - "companyId": "20803807-4e9a-4cb7-b67b-9f889a3916e1", - "syncId": "aa4c9dfd-e945-4424-9628-9e724f14c267", - "syncStatusCode": 2000, - "syncStatus": "Complete", - "errorMessage": "", - "syncExceptionMessage": "", - "syncUtc": "2023-01-24T14:15:22Z", - "dataPushed": true - }, - "Success No Data Pushed": { - "companyId": "20803807-4e9a-4cb7-b67b-9f889a3916e1", - "syncId": "aa4c9dfd-e945-4424-9628-9e724f14c267", - "syncStatusCode": 2040, - "syncStatus": "Complete", - "errorMessage": "", - "syncExceptionMessage": "", - "syncUtc": "2023-01-24T14:15:22Z", - "dataPushed": false - } - }, - "properties": { - "companyId": { - "type": "string", - "description": "Unique identifier for your SMB in Codat.", - "example": "d4d73051-ed31-42b6-99f6-d288cd940992", - "nullable": true - }, - "syncId": { - "type": "string", - "description": "Unique identifier of the sync.", - "example": "a6a22aff-a43a-411d-a910-2dae73217cce", - "nullable": true - }, - "syncStatusCode": { - "type": "integer", - "format": "int32", - "description": "Status code of the sync.", - "example": 2000 - }, - "syncStatus": { - "type": "string", - "description": "Text status of the sync.", - "examples": [ - "Complete", - "PushError", - "Started", - "NotStarted", - "Pushing" - ], - "nullable": true - }, - "errorMessage": { - "type": "string", - "description": "Error message of the sync.", - "nullable": true - }, - "syncExceptionMessage": { - "type": "string", - "description": "Exception message of the sync.", - "nullable": true - }, - "syncUtc": { - "$ref": "#/components/schemas/DateTime", - "description": "Datetime of the sync.", - "nullable": true - }, - "dataPushed": { - "type": "boolean", - "description": "Boolean of whether the sync resulted in data being pushed." - } - } - }, "CompanyUpdateRequest": { "title": "Update company request", "x-internal": true, @@ -5908,187 +5667,6 @@ } } }, - "Configuration": { - "title": "Configuration", - "type": "object", - "x-internal": true, - "properties": { - "companyId": { - "$ref": "#/components/parameters/companyId/schema" - }, - "accountingSoftwareCompanyName": { - "type": "string", - "description": "The company name defined in the accounting software." - }, - "enabled": { - "type": "boolean", - "description": "Enabled or disable bank feeds." - }, - "configured": { - "type": "boolean", - "description": "True if the company has been configured." - }, - "schedule": { - "$ref": "#/components/schemas/Configuration/definitions/configurationSchedule" - }, - "configuration": { - "$ref": "#/components/schemas/Configuration/definitions/syncConfiguration" - } - }, - "definitions": { - "configurationSchedule": { - "title": "Configuration schedule", - "type": "object", - "properties": { - "selectedFrequency": { - "type": "string", - "description": "The sync frequency." - }, - "frequencyOptions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The available sync frequencies." - }, - "startDate": { - "type": "string", - "description": "The datetime in UTC you want to start syncing from." - }, - "syncHourUtc": { - "type": "integer", - "description": "The hour in which the sync is initiated." - }, - "timeZoneIanaId": { - "type": "string", - "description": "The [IANA](https://www.iana.org/time-zones) time zone ID." - } - } - }, - "syncConfiguration": { - "title": "Sync configuration", - "type": "object", - "properties": { - "syncAsBankFeeds": { - "$ref": "#/components/schemas/Configuration/definitions/syncAsBankFeeds" - }, - "syncAsExpenses": { - "$ref": "#/components/schemas/Configuration/definitions/syncAsExpenses" - } - } - }, - "syncAsBankFeeds": { - "title": "Sync as bank feed", - "type": "object", - "properties": { - "enableSync": { - "type": "boolean", - "description": "True if bank feeds sync is enabled." - }, - "selectedBankAccountId": { - "type": "string", - "description": "The bank account ID being synced." - }, - "bankAccountOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Configuration/definitions/bankAccountOption" - } - } - } - }, - "syncAsExpenses": { - "title": "Sync as expenses", - "type": "object", - "properties": { - "enableSync": { - "type": "boolean", - "description": "True if expense sync is enabled." - }, - "supplier": { - "$ref": "#/components/schemas/Configuration/definitions/configurationSupplier" - }, - "customer": { - "$ref": "#/components/schemas/Configuration/definitions/configurationCustomer" - }, - "selectedBankAccountId": { - "type": "string", - "description": "The bank account ID being synced." - }, - "bankAccountOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Configuration/definitions/bankAccountOption" - } - } - } - }, - "bankAccountOption": { - "title": "Bank account option", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the bank account." - }, - "name": { - "type": "string", - "description": "Name of bank account." - }, - "accountType": { - "type": "string", - "description": "The type of account." - } - } - }, - "configurationSupplier": { - "title": "Supplier configuration", - "type": "object", - "properties": { - "selectedSupplierId": { - "type": "string", - "description": "Unique identifier for the supplier." - }, - "supplierOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Configuration/definitions/configurationContactRef" - } - } - } - }, - "configurationCustomer": { - "title": "Customer configuration", - "type": "object", - "properties": { - "selectedCustomerId": { - "type": "string", - "description": "Unique identifier for the customer." - }, - "customerOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Configuration/definitions/configurationContactRef" - } - } - } - }, - "configurationContactRef": { - "title": "Supplier/customer reference", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the supplier/customer." - }, - "name": { - "type": "string", - "description": "The supplier/customer's name." - } - } - } - } - }, "Connection": { "title": "Connection", "description": "A connection represents a [company's](https://docs.codat.io/bank-feeds-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).",