ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.50.1

Author: speakeasybot

bankfeeds/RELEASES.md

@@ -598,4 +598,12 @@ Based on:
 - OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml
 - Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.27.3] https://pypi.org/project/codat-bankfeeds/0.27.3 - bankfeeds
+- [PyPI v0.27.3] https://pypi.org/project/codat-bankfeeds/0.27.3 - bankfeeds
+
+## 2023-06-23 00:21:45
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml
+- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.28.0] https://pypi.org/project/codat-bankfeeds/0.28.0 - bankfeeds

bankfeeds/docs/models/operations/createcompanyresponse.md

@@ -9,4 +9,4 @@
 | `content_type`                                                                        | *str*                                                                                 | :heavy_check_mark:                                                                    | N/A                                                                                   |
 | `status_code`                                                                         | *int*                                                                                 | :heavy_check_mark:                                                                    | N/A                                                                                   |
 | `raw_response`                                                                        | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign:                                                                    | N/A                                                                                   |
-| `schema`                                                                              | [Optional[shared.Schema]](../../models/shared/schema.md)                              | :heavy_minus_sign:                                                                    | Your API request was not properly authorized.                                         |
+| `schema`                                                                              | [Optional[shared.Schema]](../../models/shared/schema.md)                              | :heavy_minus_sign:                                                                    | The request made is not valid.                                                        |

bankfeeds/docs/models/shared/company.md

@@ -1,6 +1,10 @@
 # Company
 
-A company in Codat represent a small or medium sized business, whose data you wish to share
+In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/codat-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.
+
+Typically each company is one of your customers.
+
+When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company.
 
 
 ## Fields

bankfeeds/docs/models/shared/connection.md

@@ -1,6 +1,15 @@
 # Connection
 
-A connection represents the link between a `company` and a source of data.
+A connection represents a [company's](https://docs.codat.io/codat-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
+
+A 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:
+
+- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
+- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
+- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
+Any combination of accounting, banking, and commerce data connections is allowed.
+
+Before 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).
 
 
 ## Fields

bankfeeds/docs/sdks/companies/README.md

@@ -14,7 +14,11 @@ Create and manage your Codat companies.
 
 ## create
 
-Create a new company
+Creates a new company that can be used to assign connections to. 
+
+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
 
@@ -54,8 +58,8 @@ if res.company is not None:
 
 ## delete
 
-Delete the given company from Codat.
-This operation is not reversible.
+
+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.
 
 ### Example Usage
 
@@ -94,7 +98,7 @@ if res.status_code == 200:
 
 ## get
 
-Get metadata for a single company
+Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
 
 ### Example Usage
 
@@ -133,7 +137,7 @@ if res.company is not None:
 
 ## list
 
-List all companies that you have created in Codat.
+Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/codat-api#/schemas/Connection) related to the company.
 
 ### Example Usage
 
@@ -175,7 +179,7 @@ if res.companies is not None:
 
 ## update
 
-Updates the given company with a new name and description
+Updates both the name and description of the company.
 
 ### Example Usage
 

bankfeeds/docs/sdks/connections/README.md

@@ -15,7 +15,9 @@ Manage your companies' data connections.
 
 ## create
 
-Create a data connection for a company
+Creates a connection for the company by providing a valid `platformKey`. 
+
+Use the [List Integrations](https://docs.codat.io/codat-api#/operations/list-integrations) endpoint to access valid platform keys. 
 
 ### Example Usage
 
@@ -57,8 +59,8 @@ if res.connection is not None:
 
 ## delete
 
-Revoke and remove a connection from a company.
-This operation is not reversible - the end user would need to reauthorize a new data connection if you wish to view new data for this company.
+Revoke and remove a connection from a company.
+This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
 
 ### Example Usage
 
@@ -98,7 +100,7 @@ if res.status_code == 200:
 
 ## get
 
-Get a single connection for a company
+Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
 
 ### Example Usage
 
@@ -138,7 +140,7 @@ if res.connection is not None:
 
 ## list
 
-List the connections for a company
+List the connections for a company.
 
 ### Example Usage
 
@@ -222,7 +224,7 @@ if res.proxy_response is not None:
 
 ## unlink_connection
 
-This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
+This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
 
 ### Example Usage
 

bankfeeds/gen.yaml

@@ -1,15 +1,15 @@
 configVersion: 1.0.0
 management:
-  docChecksum: 006fdd2b69e599057f4e304137075ad4
+  docChecksum: daaa4dd4717ccf14983502e1c8ed5ab6
   docVersion: 2.1.0
-  speakeasyVersion: 1.49.1
-  generationVersion: 2.41.5
+  speakeasyVersion: 1.50.1
+  generationVersion: 2.43.2
 generation:
   sdkClassName: CodatBankFeeds
   singleTagPerOp: false
   telemetryEnabled: true
 python:
-  version: 0.27.3
+  version: 0.28.0
   author: Speakeasy
   description: Python Client SDK Generated by Speakeasy
   maxMethodParams: 0

bankfeeds/setup.py

@@ -10,7 +10,7 @@
 
 setuptools.setup(
     name="codat-bankfeeds",
-    version="0.27.3",
+    version="0.28.0",
     author="Speakeasy",
     description="Python Client SDK Generated by Speakeasy",
     long_description=long_description,

bankfeeds/src/codatbankfeeds/companies.py

@@ -15,7 +15,9 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
 
     def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.RetryConfig] = None) -> operations.CreateCompanyResponse:
         r"""Create company
-        Create a new company
+        Creates a new company that can be used to assign connections to. 
+        
+        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`.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -49,7 +51,7 @@ def do_request():
             if utils.match_content_type(content_type, 'application/json'):
                 out = utils.unmarshal_json(http_res.text, Optional[shared.Company])
                 res.company = out
-        elif http_res.status_code in [401, 429]:
+        elif http_res.status_code in [400, 401, 429]:
             if utils.match_content_type(content_type, 'application/json'):
                 out = utils.unmarshal_json(http_res.text, Optional[shared.Schema])
                 res.schema = out
@@ -59,8 +61,7 @@ def do_request():
 
     def delete(self, request: operations.DeleteCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DeleteCompanyResponse:
         r"""Delete a company
-        Delete the given company from Codat.
-        This operation is not reversible.
+        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.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -99,7 +100,7 @@ def do_request():
 
     def get(self, request: operations.GetCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCompanyResponse:
         r"""Get company
-        Get metadata for a single company
+        Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -140,7 +141,7 @@ def do_request():
 
     def list(self, request: operations.ListCompaniesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCompaniesResponse:
         r"""List companies
-        List all companies that you have created in Codat.
+        Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/codat-api#/schemas/Connection) related to the company.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -182,7 +183,7 @@ def do_request():
 
     def update(self, request: operations.UpdateCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateCompanyResponse:
         r"""Update company
-        Updates the given company with a new name and description
+        Updates both the name and description of the company.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 

bankfeeds/src/codatbankfeeds/connections.py

@@ -15,7 +15,9 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
 
     def create(self, request: operations.CreateDataConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateDataConnectionResponse:
         r"""Create connection
-        Create a data connection for a company
+        Creates a connection for the company by providing a valid `platformKey`. 
+        
+        Use the [List Integrations](https://docs.codat.io/codat-api#/operations/list-integrations) endpoint to access valid platform keys.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -60,7 +62,7 @@ def do_request():
     def delete(self, request: operations.DeleteCompanyConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DeleteCompanyConnectionResponse:
         r"""Delete connection
         Revoke and remove a connection from a company.
-        This operation is not reversible - the end user would need to reauthorize a new data connection if you wish to view new data for this company.
+        This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -99,7 +101,7 @@ def do_request():
 
     def get(self, request: operations.GetCompanyConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCompanyConnectionResponse:
         r"""Get connection
-        Get a single connection for a company
+        Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
 
@@ -140,7 +142,7 @@ def do_request():
 
     def list(self, request: operations.ListCompanyConnectionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCompanyConnectionsResponse:
         r"""List connections
-        List the connections for a company
+        List the connections for a company.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())