Merge pull request #204 from codatio/speakeasy-sdk-regen-1687219372

dcoplowe · web-flow · commit fd2818b7314e · 2023-07-07T10:29:20.000+01:00
chore: speakeasy sdk regeneration - Generate Banking SDK
diff --git a/banking/.gitignore b/banking/.gitignore
@@ -1,3 +1,5 @@
+.python-version
+.DS_Store
 venv/
 src/*.egg-info/
 __pycache__/
diff --git a/banking/README.md b/banking/README.md
@@ -54,7 +54,7 @@ if res.account_balances is not None:
 ### [transaction_categories](docs/sdks/transactioncategories/README.md)
 
 * [get](docs/sdks/transactioncategories/README.md#get) - Get transaction category
-* [list](docs/sdks/transactioncategories/README.md#list) - List all transaction categories
+* [list](docs/sdks/transactioncategories/README.md#list) - List transaction categories
 
 ### [transactions](docs/sdks/transactions/README.md)
 
diff --git a/banking/RELEASES.md b/banking/RELEASES.md
@@ -430,4 +430,84 @@ Based on:
 - OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
 - Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.21.1] https://pypi.org/project/codat-banking/0.21.1 - banking
+- [PyPI v0.21.1] https://pypi.org/project/codat-banking/0.21.1 - banking
+
+## 2023-06-20 00:02:48
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.21.2] https://pypi.org/project/codat-banking/0.21.2 - banking
+
+## 2023-06-21 00:02:35
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.21.3] https://pypi.org/project/codat-banking/0.21.3 - banking
+
+## 2023-06-23 00:02:58
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.22.0] https://pypi.org/project/codat-banking/0.22.0 - banking
+
+## 2023-06-24 00:03:06
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.22.1] https://pypi.org/project/codat-banking/0.22.1 - banking
+
+## 2023-06-27 00:03:00
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.23.0] https://pypi.org/project/codat-banking/0.23.0 - banking
+
+## 2023-06-30 00:02:33
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.24.0] https://pypi.org/project/codat-banking/0.24.0 - banking
+
+## 2023-07-01 00:03:29
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.25.0] https://pypi.org/project/codat-banking/0.25.0 - banking
+
+## 2023-07-06 00:03:05
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.26.0] https://pypi.org/project/codat-banking/0.26.0 - banking
+
+## 2023-07-07 00:02:45
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.27.0] https://pypi.org/project/codat-banking/0.27.0 - banking
+
+## 2023-07-07 09:23:01
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Banking.yaml
+- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.27.1] https://pypi.org/project/codat-banking/0.27.1 - banking
diff --git a/banking/docs/sdks/accountbalances/README.md b/banking/docs/sdks/accountbalances/README.md
@@ -10,7 +10,12 @@ Balances for a bank account including end-of-day batch balance or running balanc
 
 ## list
 
-Gets a list of balances for a bank account including end-of-day batch balance or running balances per transaction.
+The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection.
+
+[Account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+    
 
 ### Example Usage
 
diff --git a/banking/docs/sdks/accounts/README.md b/banking/docs/sdks/accounts/README.md
@@ -11,7 +11,14 @@ Where payments are made or received, and bank transactions are recorded.
 
 ## get
 
-Gets a specified bank account for a given company
+The *Get account* endpoint returns a single account for a given accountId.
+
+[Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+
 
 ### Example Usage
 
@@ -52,7 +59,12 @@ if res.account is not None:
 
 ## list
 
-Gets a list of all bank accounts of the SMB, with rich data like balances, account numbers and institutions holdingthe accounts.
+The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection.
+
+[Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+    
 
 ### Example Usage
 
diff --git a/banking/docs/sdks/transactioncategories/README.md b/banking/docs/sdks/transactioncategories/README.md
@@ -7,11 +7,18 @@ Hierarchical categories associated with a transaction for greater contextual mea
 ### Available Operations
 
 * [get](#get) - Get transaction category
-* [list](#list) - List all transaction categories
+* [list](#list) - List transaction categories
 
 ## get
 
-Gets a specified bank transaction category for a given company
+The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
+
+[Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+
 
 ### Example Usage
 
@@ -52,7 +59,12 @@ if res.transaction_category is not None:
 
 ## list
 
-Gets a list of hierarchical categories associated with a transaction for greater contextual meaning to transactionactivity.
+The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection.
+
+[Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+    
 
 ### Example Usage
 
diff --git a/banking/docs/sdks/transactions/README.md b/banking/docs/sdks/transactions/README.md
@@ -12,7 +12,14 @@ An immutable source of up-to-date information on income and expenditure.
 
 ## get
 
-Gets a specified bank transaction for a given company
+The *Get transaction* endpoint returns a single transaction for a given transactionId.
+
+[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+
 
 ### Example Usage
 
@@ -53,7 +60,12 @@ if res.transaction is not None:
 
 ## list
 
-Gets a list of transactions incurred by a bank account.
+The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.
+
+[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+    
 
 ### Example Usage
 
@@ -97,7 +109,12 @@ if res.transactions is not None:
 
 ## ~~list_bank_transactions~~
 
-Gets a list of transactions incurred by a company across all bank accounts.
+The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.
+
+[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
+    
 
 > :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible. Use `list` instead.
 
diff --git a/banking/gen.yaml b/banking/gen.yaml
@@ -1,15 +1,15 @@
 configVersion: 1.0.0
 management:
-  docChecksum: 3f747faf879509eae1fc952d2ae48108
+  docChecksum: fc8c7e4872770024e52b188ffa277ed5
   docVersion: 2.1.0
-  speakeasyVersion: 1.48.0
-  generationVersion: 2.41.1
+  speakeasyVersion: 1.53.0
+  generationVersion: 2.58.0
 generation:
   sdkClassName: CodatBanking
   singleTagPerOp: false
   telemetryEnabled: true
 python:
-  version: 0.21.1
+  version: 0.27.1
   author: Speakeasy
   description: Python Client SDK Generated by Speakeasy
   maxMethodParams: 0
diff --git a/banking/setup.py b/banking/setup.py
@@ -10,7 +10,7 @@
 
 setuptools.setup(
     name="codat-banking",
-    version="0.21.1",
+    version="0.27.1",
     author="Speakeasy",
     description="Python Client SDK Generated by Speakeasy",
     long_description=long_description,
diff --git a/banking/src/codatbanking/account_balances.py b/banking/src/codatbanking/account_balances.py
@@ -15,7 +15,11 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     
     def list(self, request: operations.ListAccountBalancesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountBalancesResponse:
         r"""List account balances
-        Gets a list of balances for a bank account including end-of-day batch balance or running balances per transaction.
+        The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection.
+        
+        [Account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
diff --git a/banking/src/codatbanking/accounts.py b/banking/src/codatbanking/accounts.py
@@ -15,7 +15,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     
     def get(self, request: operations.GetAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountResponse:
         r"""Get account
-        Gets a specified bank account for a given company
+        The *Get account* endpoint returns a single account for a given accountId.
+        
+        [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
+        
+        Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
@@ -52,7 +58,11 @@ def do_request():
     
     def list(self, request: operations.ListAccountsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountsResponse:
         r"""List accounts
-        Gets a list of all bank accounts of the SMB, with rich data like balances, account numbers and institutions holdingthe accounts.
+        The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection.
+        
+        [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
diff --git a/banking/src/codatbanking/sdkconfiguration.py b/banking/src/codatbanking/sdkconfiguration.py
@@ -18,8 +18,8 @@ class SDKConfiguration:
     server_idx: int = 0
     language: str = 'python'
     openapi_doc_version: str = '2.1.0'
-    sdk_version: str = '0.21.1'
-    gen_version: str = '2.41.1'
+    sdk_version: str = '0.27.1'
+    gen_version: str = '2.58.0'
 
     def get_server_details(self) -> tuple[str, dict[str, str]]:
         if self.server_url:
diff --git a/banking/src/codatbanking/transaction_categories.py b/banking/src/codatbanking/transaction_categories.py
@@ -15,7 +15,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     
     def get(self, request: operations.GetTransactionCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetTransactionCategoryResponse:
         r"""Get transaction category
-        Gets a specified bank transaction category for a given company
+        The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
+        
+        [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+        
+        Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
@@ -51,8 +57,12 @@ def do_request():
 
     
     def list(self, request: operations.ListTransactionCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListTransactionCategoriesResponse:
-        r"""List all transaction categories
-        Gets a list of hierarchical categories associated with a transaction for greater contextual meaning to transactionactivity.
+        r"""List transaction categories
+        The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection.
+        
+        [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
diff --git a/banking/src/codatbanking/transactions.py b/banking/src/codatbanking/transactions.py
@@ -15,7 +15,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     
     def get(self, request: operations.GetTransactionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetTransactionResponse:
         r"""Get bank transaction
-        Gets a specified bank transaction for a given company
+        The *Get transaction* endpoint returns a single transaction for a given transactionId.
+        
+        [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+        
+        Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
@@ -52,7 +58,11 @@ def do_request():
     
     def list(self, request: operations.ListTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListTransactionsResponse:
         r"""List transactions
-        Gets a list of transactions incurred by a bank account.
+        The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.
+        
+        [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         
@@ -98,7 +108,11 @@ def do_request():
     
     def list_bank_transactions(self, request: operations.ListBankTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankTransactionsResponse:
         r"""List banking transactions
-        Gets a list of transactions incurred by a company across all bank accounts.
+        The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.
+        
+        [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+        
+        Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
         
         Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible. Use list instead
         """

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.python-version`
	`2`	`+.DS_Store`
`1`	`3`	`venv/`
`2`	`4`	`src/*.egg-info/`
`3`	`5`	`__pycache__/`