@codat/bank-feeds
Advanced tools
@codat/bank-feeds - npm Package Compare versions
Comparing version 3.1.0 to 4.0.0
@@ -16,7 +16,8 @@ import * as utils from "../internal/utils"; | ||
| * @remarks | ||
| * Creates a new company that can be used to assign connections to. | ||
| * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. | ||
| * | ||
| * | ||
| */ | ||
@@ -28,4 +29,7 @@ create(req: shared.CompanyRequestBody, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.CreateCompanyResponse>; | ||
| * @remarks | ||
| * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible. | ||
| * | ||
| * Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| */ | ||
@@ -37,3 +41,7 @@ delete(req: operations.DeleteCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.DeleteCompanyResponse>; | ||
| * @remarks | ||
| * Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. | ||
| * The *Get company* endpoint returns a single company for a given `companyId`. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| */ | ||
@@ -45,3 +53,6 @@ get(req: operations.GetCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetCompanyResponse>; | ||
| * @remarks | ||
| * Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) related to the company. | ||
| * The *List companies* endpoint returns a list of [companies] associated to your instances. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| */ | ||
@@ -53,5 +64,9 @@ list(req: operations.ListCompaniesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListCompaniesResponse>; | ||
| * @remarks | ||
| * Updates both the name and description of the company. | ||
| * Use the *Update company* endpoint to update both the name and description of the company. | ||
| * If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| */ | ||
| update(req: operations.UpdateCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.UpdateCompanyResponse>; | ||
| } |
@@ -108,7 +108,8 @@ "use strict"; | ||
| * @remarks | ||
| * Creates a new company that can be used to assign connections to. | ||
| * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. | ||
| * | ||
| * | ||
| */ | ||
@@ -204,4 +205,7 @@ Companies.prototype.create = function (req, retries, config) { | ||
| * @remarks | ||
| * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible. | ||
| * | ||
| * Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| */ | ||
@@ -281,3 +285,7 @@ Companies.prototype.delete = function (req, retries, config) { | ||
| * @remarks | ||
| * Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. | ||
| * The *Get company* endpoint returns a single company for a given `companyId`. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| * | ||
| */ | ||
@@ -363,3 +371,6 @@ Companies.prototype.get = function (req, retries, config) { | ||
| * @remarks | ||
| * Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) related to the company. | ||
| * The *List companies* endpoint returns a list of [companies] associated to your instances. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| */ | ||
@@ -446,3 +457,7 @@ Companies.prototype.list = function (req, retries, config) { | ||
| * @remarks | ||
| * Updates both the name and description of the company. | ||
| * Use the *Update company* endpoint to update both the name and description of the company. | ||
| * If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. | ||
| * | ||
| * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| */ | ||
@@ -449,0 +464,0 @@ Companies.prototype.update = function (req, retries, config) { |
@@ -24,6 +24,2 @@ import { SpeakeasyBase } from "../../../internal/utils"; | ||
| /** | ||
| * Success | ||
| */ | ||
| sourceAccount?: shared.SourceAccount; | ||
| /** | ||
| * HTTP response status code for this operation | ||
@@ -36,2 +32,6 @@ */ | ||
| rawResponse: AxiosResponse; | ||
| /** | ||
| * Success | ||
| */ | ||
| sourceAccounts?: shared.SourceAccount[]; | ||
| } |
@@ -87,6 +87,2 @@ "use strict"; | ||
| (0, utils_1.SpeakeasyMetadata)(), | ||
| __metadata("design:type", shared.SourceAccount) | ||
| ], ListSourceAccountsResponse.prototype, "sourceAccount", void 0); | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)(), | ||
| __metadata("design:type", Number) | ||
@@ -98,4 +94,8 @@ ], ListSourceAccountsResponse.prototype, "statusCode", void 0); | ||
| ], ListSourceAccountsResponse.prototype, "rawResponse", void 0); | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)({ elemType: shared.SourceAccount }), | ||
| __metadata("design:type", Array) | ||
| ], ListSourceAccountsResponse.prototype, "sourceAccounts", void 0); | ||
| return ListSourceAccountsResponse; | ||
| }(utils_1.SpeakeasyBase)); | ||
| exports.ListSourceAccountsResponse = ListSourceAccountsResponse; |
| import { SpeakeasyBase } from "../../../internal/utils"; | ||
| import { Connection } from "./connection"; | ||
| export declare class GroupReference extends SpeakeasyBase { | ||
| /** | ||
| * Unique identifier for the group. | ||
| */ | ||
| id?: string; | ||
| } | ||
| /** | ||
@@ -47,2 +53,6 @@ * In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. | ||
| /** | ||
| * An array of groups the company has been assigned to. | ||
| */ | ||
| groups?: GroupReference[]; | ||
| /** | ||
| * Unique identifier for your SMB in Codat. | ||
@@ -49,0 +59,0 @@ */ |
@@ -30,6 +30,19 @@ "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| exports.Company = void 0; | ||
| exports.Company = exports.GroupReference = void 0; | ||
| var utils_1 = require("../../../internal/utils"); | ||
| var connection_1 = require("./connection"); | ||
| var class_transformer_1 = require("class-transformer"); | ||
| var GroupReference = /** @class */ (function (_super) { | ||
| __extends(GroupReference, _super); | ||
| function GroupReference() { | ||
| return _super !== null && _super.apply(this, arguments) || this; | ||
| } | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)(), | ||
| (0, class_transformer_1.Expose)({ name: "id" }), | ||
| __metadata("design:type", String) | ||
| ], GroupReference.prototype, "id", void 0); | ||
| return GroupReference; | ||
| }(utils_1.SpeakeasyBase)); | ||
| exports.GroupReference = GroupReference; | ||
| /** | ||
@@ -71,2 +84,8 @@ * In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)({ elemType: GroupReference }), | ||
| (0, class_transformer_1.Expose)({ name: "groups" }), | ||
| (0, class_transformer_1.Type)(function () { return GroupReference; }), | ||
| __metadata("design:type", Array) | ||
| ], Company.prototype, "groups", void 0); | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)(), | ||
@@ -73,0 +92,0 @@ (0, class_transformer_1.Expose)({ name: "id" }), |
| import { SpeakeasyBase } from "../../../internal/utils"; | ||
| import { Items } from "./items"; | ||
| export declare class CompanyRequestBody extends SpeakeasyBase { | ||
@@ -8,2 +9,6 @@ /** | ||
| /** | ||
| * Reference to the groups that the company is assigned to. | ||
| */ | ||
| groups?: Items[]; | ||
| /** | ||
| * Name of company being connected. | ||
@@ -10,0 +15,0 @@ */ |
@@ -32,2 +32,3 @@ "use strict"; | ||
| var utils_1 = require("../../../internal/utils"); | ||
| var items_1 = require("./items"); | ||
| var class_transformer_1 = require("class-transformer"); | ||
@@ -45,2 +46,8 @@ var CompanyRequestBody = /** @class */ (function (_super) { | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)({ elemType: items_1.Items }), | ||
| (0, class_transformer_1.Expose)({ name: "groups" }), | ||
| (0, class_transformer_1.Type)(function () { return items_1.Items; }), | ||
| __metadata("design:type", Array) | ||
| ], CompanyRequestBody.prototype, "groups", void 0); | ||
| __decorate([ | ||
| (0, utils_1.SpeakeasyMetadata)(), | ||
@@ -47,0 +54,0 @@ (0, class_transformer_1.Expose)({ name: "name" }), |
@@ -10,3 +10,5 @@ import { SpeakeasyBase } from "../../../internal/utils"; | ||
| Banking = "Banking", | ||
| BankFeed = "BankFeed", | ||
| Commerce = "Commerce", | ||
| Expense = "Expense", | ||
| Other = "Other", | ||
@@ -13,0 +15,0 @@ Unknown = "Unknown" |
@@ -42,3 +42,5 @@ "use strict"; | ||
| SourceType["Banking"] = "Banking"; | ||
| SourceType["BankFeed"] = "BankFeed"; | ||
| SourceType["Commerce"] = "Commerce"; | ||
| SourceType["Expense"] = "Expense"; | ||
| SourceType["Other"] = "Other"; | ||
@@ -45,0 +47,0 @@ SourceType["Unknown"] = "Unknown"; |
@@ -21,2 +21,3 @@ export * from "./bankaccountcredentials"; | ||
| export * from "./halref"; | ||
| export * from "./items"; | ||
| export * from "./links"; | ||
@@ -23,0 +24,0 @@ export * from "./pushchangetype"; |
@@ -40,2 +40,3 @@ "use strict"; | ||
| __exportStar(require("./halref"), exports); | ||
| __exportStar(require("./items"), exports); | ||
| __exportStar(require("./links"), exports); | ||
@@ -42,0 +43,0 @@ __exportStar(require("./pushchangetype"), exports); |
@@ -29,5 +29,5 @@ "use strict"; | ||
| this.openapiDocVersion = "3.0.0"; | ||
| this.sdkVersion = "3.1.0"; | ||
| this.genVersion = "2.214.3"; | ||
| this.userAgent = "speakeasy-sdk/typescript 3.1.0 2.214.3 3.0.0 @codat/bank-feeds"; | ||
| this.sdkVersion = "4.0.0"; | ||
| this.genVersion = "2.228.3"; | ||
| this.userAgent = "speakeasy-sdk/typescript 4.0.0 2.228.3 3.0.0 @codat/bank-feeds"; | ||
| Object.assign(this, init); | ||
@@ -34,0 +34,0 @@ } |
@@ -479,3 +479,3 @@ "use strict"; | ||
| return __awaiter(this, void 0, void 0, function () { | ||
| var baseURL, operationUrl, client, globalSecurity, properties, headers, globalRetryConfig, retryConfig, httpRes, responseContentType, res, decodedRes; | ||
| var baseURL, operationUrl, client, globalSecurity, properties, headers, globalRetryConfig, retryConfig, httpRes, responseContentType, res, decodedRes, resFieldDepth; | ||
| return __generator(this, function (_c) { | ||
@@ -532,3 +532,5 @@ switch (_c.label) { | ||
| if (utils.matchContentType(responseContentType, "application/json")) { | ||
| res.sourceAccount = utils.objectToClass(JSON.parse(decodedRes), shared.SourceAccount); | ||
| res.sourceAccounts = []; | ||
| resFieldDepth = utils.getResFieldDepth(res); | ||
| res.sourceAccounts = utils.objectToClass(JSON.parse(decodedRes), shared.SourceAccount, resFieldDepth); | ||
| } | ||
@@ -535,0 +537,0 @@ else { |
@@ -6,8 +6,8 @@ # ListSourceAccountsResponse | ||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | ||
| | `sourceAccount` | [shared.SourceAccount](../../../sdk/models/shared/sourceaccount.md) | :heavy_minus_sign: | Success | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | ||
| | Field | Type | Required | Description | | ||
| | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `errorMessage` | [shared.ErrorMessage](../../../sdk/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | ||
| | `sourceAccounts` | [shared.SourceAccount](../../../sdk/models/shared/sourceaccount.md)[] | :heavy_minus_sign: | Success | |
@@ -18,2 +18,3 @@ # Company | ||
| | `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | ||
| | `groups` | [shared.GroupReference](../../../sdk/models/shared/groupreference.md)[] | :heavy_minus_sign: | An array of groups the company has been assigned to. | | | ||
| | `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | ||
@@ -20,0 +21,0 @@ | `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | |
@@ -9,2 +9,3 @@ # CompanyRequestBody | ||
| | `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | ||
| | `groups` | [shared.Items](../../../sdk/models/shared/items.md)[] | :heavy_minus_sign: | Reference to the groups that the company is assigned to. | | | ||
| | `name` | *string* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | |
@@ -12,4 +12,6 @@ # SourceType | ||
| | `Banking` | Banking | | ||
| | `BankFeed` | BankFeed | | ||
| | `Commerce` | Commerce | | ||
| | `Expense` | Expense | | ||
| | `Other` | Other | | ||
| | `Unknown` | Unknown | |
@@ -67,3 +67,3 @@ # AccountMapping | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -119,2 +119,2 @@ ## get | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | |
@@ -18,8 +18,9 @@ # Companies | ||
| Creates a new company that can be used to assign connections to. | ||
| Use the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat. | ||
| A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. | ||
| ### Example Usage | ||
@@ -39,2 +40,7 @@ | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -67,9 +73,12 @@ }); | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
| ## delete | ||
| | ||
| Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. | ||
| The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible. | ||
| A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| ### Example Usage | ||
@@ -115,8 +124,12 @@ | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
| ## get | ||
| Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. | ||
| The *Get company* endpoint returns a single company for a given `companyId`. | ||
| A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| ### Example Usage | ||
@@ -162,8 +175,11 @@ | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
| ## list | ||
| Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) related to the company. | ||
| The *List companies* endpoint returns a list of [companies] associated to your instances. | ||
| A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| ### Example Usage | ||
@@ -211,8 +227,12 @@ | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
| ## update | ||
| Updates both the name and description of the company. | ||
| Use the *Update company* endpoint to update both the name and description of the company. | ||
| If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. | ||
| A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. | ||
| Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. | ||
| ### Example Usage | ||
@@ -233,2 +253,7 @@ | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -263,2 +288,2 @@ }, | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | |
@@ -65,3 +65,3 @@ # Connections | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -114,3 +114,3 @@ ## delete | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -162,3 +162,3 @@ ## get | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -212,3 +212,3 @@ ## list | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -262,2 +262,2 @@ ## unlink | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | |
@@ -89,3 +89,3 @@ # SourceAccounts | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -141,3 +141,3 @@ ## delete | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -191,3 +191,3 @@ ## deleteCredentials | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -243,3 +243,3 @@ ## generateCredentials | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -294,3 +294,3 @@ ## list | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -350,2 +350,2 @@ ## update | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | |
@@ -85,3 +85,3 @@ # Transactions | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -133,3 +133,3 @@ ## getCreateOperation | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -183,2 +183,2 @@ ## listCreateOperations | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | |
| { | ||
| "name": "@codat/bank-feeds", | ||
| "version": "3.1.0", | ||
| "version": "4.0.0", | ||
| "author": "Codat", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -41,2 +41,7 @@ # Bank Feeds | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -118,2 +123,7 @@ }); | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -165,2 +175,7 @@ }, | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -188,3 +203,3 @@ }); | ||
| | --------------- | --------------- | --------------- | | ||
| | errors.SDKError | 400-600 | */* | | ||
| | errors.SDKError | 4xx-5xx | */* | | ||
@@ -207,2 +222,7 @@ Example | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -255,2 +275,7 @@ }); | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -285,2 +310,7 @@ }); | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -346,2 +376,7 @@ }); | ||
| description: "Requested early access to the new financing scheme.", | ||
| groups: [ | ||
| { | ||
| id: "60d2fa12-8a04-11ee-b9d1-0242ac120002", | ||
| }, | ||
| ], | ||
| name: "Bank of Dave", | ||
@@ -348,0 +383,0 @@ }); |
Improved metrics
- Total package byte prevSize
- increased by1.56%
1215268
- Number of package files
- increased by1.61%
253
- Lines of code
- increased by1.19%
11316
- Number of lines in readme file
- increased by9.62%
399