Skip to content

Commit 2e17c27

Browse files
committed
ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.51.3
1 parent aae761b commit 2e17c27

12 files changed

Lines changed: 94 additions & 43 deletions

File tree

bankfeeds/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ if res.account_mapping_result is not None:
5050

5151
### [bank_account_transactions](docs/sdks/bankaccounttransactions/README.md)
5252

53-
* [create](docs/sdks/bankaccounttransactions/README.md#create) - Create bank transactions
54-
* [get](docs/sdks/bankaccounttransactions/README.md#get) - List push options for bank account bank transactions
55-
* [list](docs/sdks/bankaccounttransactions/README.md#list) - List bank transactions for bank account
53+
* [create](docs/sdks/bankaccounttransactions/README.md#create) - Create bank account transactions
54+
* [get](docs/sdks/bankaccounttransactions/README.md#get) - Get create bank account transactions model
55+
* [list](docs/sdks/bankaccounttransactions/README.md#list) - List bank account transactions
5656

5757
### [bank_feed_accounts](docs/sdks/bankfeedaccounts/README.md)
5858

bankfeeds/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,4 +630,12 @@ Based on:
630630
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml
631631
- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy
632632
### Releases
633-
- [PyPI v0.29.1] https://pypi.org/project/codat-bankfeeds/0.29.1 - bankfeeds
633+
- [PyPI v0.29.1] https://pypi.org/project/codat-bankfeeds/0.29.1 - bankfeeds
634+
635+
## 2023-06-29 00:20:47
636+
### Changes
637+
Based on:
638+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml
639+
- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy
640+
### Releases
641+
- [PyPI v0.30.0] https://pypi.org/project/codat-bankfeeds/0.30.0 - bankfeeds

bankfeeds/docs/models/operations/getcreatebankaccountmodelrequest.md renamed to bankfeeds/docs/models/operations/getcreatebanktransactionsmodelrequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GetCreateBankAccountModelRequest
1+
# GetCreateBankTransactionsModelRequest
22

33

44
## Fields

bankfeeds/docs/models/operations/getcreatebankaccountmodelresponse.md renamed to bankfeeds/docs/models/operations/getcreatebanktransactionsmodelresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GetCreateBankAccountModelResponse
1+
# GetCreateBankTransactionsModelResponse
22

33

44
## Fields

bankfeeds/docs/sdks/bankaccounttransactions/README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,22 @@ Bank feed bank accounts
66

77
### Available Operations
88

9-
* [create](#create) - Create bank transactions
10-
* [get](#get) - List push options for bank account bank transactions
11-
* [list](#list) - List bank transactions for bank account
9+
* [create](#create) - Create bank account transactions
10+
* [get](#get) - Get create bank account transactions model
11+
* [list](#list) - List bank account transactions
1212

1313
## create
1414

15-
Posts bank transactions to the accounting package for a given company.
15+
The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
16+
17+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
18+
19+
**Integration-specific behaviour**
20+
21+
Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).
22+
23+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.
1624

17-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) to see which integrations support this endpoint.
1825

1926
### Example Usage
2027

@@ -86,7 +93,16 @@ if res.create_bank_transactions_response is not None:
8693

8794
## get
8895

89-
Gets the options of pushing bank account transactions.
96+
The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration.
97+
98+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
99+
100+
**Integration-specific behaviour**
101+
102+
See the *response examples* for integration-specific indicative models.
103+
104+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.
105+
90106

91107
### Example Usage
92108

@@ -100,7 +116,7 @@ s = codatbankfeeds.CodatBankFeeds(
100116
),
101117
)
102118

103-
req = operations.GetCreateBankAccountModelRequest(
119+
req = operations.GetCreateBankTransactionsModelRequest(
104120
account_id='7110701885',
105121
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
106122
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
@@ -114,20 +130,27 @@ if res.push_option is not None:
114130

115131
### Parameters
116132

117-
| Parameter | Type | Required | Description |
118-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
119-
| `request` | [operations.GetCreateBankAccountModelRequest](../../models/operations/getcreatebankaccountmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
120-
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
133+
| Parameter | Type | Required | Description |
134+
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
135+
| `request` | [operations.GetCreateBankTransactionsModelRequest](../../models/operations/getcreatebanktransactionsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
136+
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
121137

122138

123139
### Response
124140

125-
**[operations.GetCreateBankAccountModelResponse](../../models/operations/getcreatebankaccountmodelresponse.md)**
141+
**[operations.GetCreateBankTransactionsModelResponse](../../models/operations/getcreatebanktransactionsmodelresponse.md)**
126142

127143

128144
## list
129145

130-
Gets bank transactions for a given bank account ID
146+
The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
147+
148+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
149+
150+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.
151+
152+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
153+
131154

132155
### Example Usage
133156

bankfeeds/files.gen

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ src/codatbankfeeds/utils/utils.py
1515
src/codatbankfeeds/models/operations/create_bank_account_mapping.py
1616
src/codatbankfeeds/models/operations/get_bank_account_mapping.py
1717
src/codatbankfeeds/models/operations/create_bank_transactions.py
18-
src/codatbankfeeds/models/operations/get_create_bank_account_model.py
18+
src/codatbankfeeds/models/operations/get_create_bank_transactions_model.py
1919
src/codatbankfeeds/models/operations/list_bank_account_transactions.py
2020
src/codatbankfeeds/models/operations/create_bank_feed.py
2121
src/codatbankfeeds/models/operations/get_bank_feeds.py
@@ -82,8 +82,8 @@ docs/models/operations/getbankaccountmappingrequest.md
8282
docs/models/operations/getbankaccountmappingresponse.md
8383
docs/models/operations/createbanktransactionsrequest.md
8484
docs/models/operations/createbanktransactionsresponse.md
85-
docs/models/operations/getcreatebankaccountmodelrequest.md
86-
docs/models/operations/getcreatebankaccountmodelresponse.md
85+
docs/models/operations/getcreatebanktransactionsmodelrequest.md
86+
docs/models/operations/getcreatebanktransactionsmodelresponse.md
8787
docs/models/operations/listbankaccounttransactionsrequest.md
8888
docs/models/operations/listbankaccounttransactions409applicationjson.md
8989
docs/models/operations/listbankaccounttransactionsresponse.md

bankfeeds/gen.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
configVersion: 1.0.0
22
management:
3-
docChecksum: 46b59fb15bd24c934e0d092c4c6ac6bb
3+
docChecksum: 35e46bf7d4f4cabd4f8827c7abf17048
44
docVersion: 2.1.0
5-
speakeasyVersion: 1.51.1
6-
generationVersion: 2.50.2
5+
speakeasyVersion: 1.51.3
6+
generationVersion: 2.52.2
77
generation:
88
sdkClassName: CodatBankFeeds
99
singleTagPerOp: false
1010
telemetryEnabled: true
1111
python:
12-
version: 0.29.1
12+
version: 0.30.0
1313
author: Speakeasy
1414
description: Python Client SDK Generated by Speakeasy
1515
maxMethodParams: 0

bankfeeds/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setuptools.setup(
1212
name="codat-bankfeeds",
13-
version="0.29.1",
13+
version="0.30.0",
1414
author="Speakeasy",
1515
description="Python Client SDK Generated by Speakeasy",
1616
long_description=long_description,

bankfeeds/src/codatbankfeeds/bank_account_transactions.py

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
1414

1515

1616
def create(self, request: operations.CreateBankTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateBankTransactionsResponse:
17-
r"""Create bank transactions
18-
Posts bank transactions to the accounting package for a given company.
17+
r"""Create bank account transactions
18+
The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
1919
20-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) to see which integrations support this endpoint.
20+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
21+
22+
**Integration-specific behaviour**
23+
24+
Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).
25+
26+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.
2127
"""
2228
base_url = utils.template_url(*self.sdk_configuration.get_server_details())
2329

@@ -60,13 +66,21 @@ def do_request():
6066
return res
6167

6268

63-
def get(self, request: operations.GetCreateBankAccountModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateBankAccountModelResponse:
64-
r"""List push options for bank account bank transactions
65-
Gets the options of pushing bank account transactions.
69+
def get(self, request: operations.GetCreateBankTransactionsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateBankTransactionsModelResponse:
70+
r"""Get create bank account transactions model
71+
The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration.
72+
73+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
74+
75+
**Integration-specific behaviour**
76+
77+
See the *response examples* for integration-specific indicative models.
78+
79+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.
6680
"""
6781
base_url = utils.template_url(*self.sdk_configuration.get_server_details())
6882

69-
url = utils.generate_url(operations.GetCreateBankAccountModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions', request)
83+
url = utils.generate_url(operations.GetCreateBankTransactionsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions', request)
7084
headers = {}
7185
headers['Accept'] = 'application/json;q=1, application/json;q=0'
7286
headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}'
@@ -87,7 +101,7 @@ def do_request():
87101
]))
88102
content_type = http_res.headers.get('Content-Type')
89103

90-
res = operations.GetCreateBankAccountModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res)
104+
res = operations.GetCreateBankTransactionsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res)
91105

92106
if http_res.status_code == 200:
93107
if utils.match_content_type(content_type, 'application/json'):
@@ -102,8 +116,14 @@ def do_request():
102116

103117

104118
def list(self, request: operations.ListBankAccountTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankAccountTransactionsResponse:
105-
r"""List bank transactions for bank account
106-
Gets bank transactions for a given bank account ID
119+
r"""List bank account transactions
120+
The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
121+
122+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
123+
124+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.
125+
126+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
107127
"""
108128
base_url = utils.template_url(*self.sdk_configuration.get_server_details())
109129

bankfeeds/src/codatbankfeeds/models/operations/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from .get_bank_feeds import *
1212
from .get_company import *
1313
from .get_company_connection import *
14-
from .get_create_bank_account_model import *
14+
from .get_create_bank_transactions_model import *
1515
from .list_bank_account_transactions import *
1616
from .list_companies import *
1717
from .list_company_connections import *
@@ -20,4 +20,4 @@
2020
from .update_bank_feed import *
2121
from .update_company import *
2222

23-
__all__ = ["CreateBankAccountMappingRequest","CreateBankAccountMappingResponse","CreateBankFeedRequest","CreateBankFeedResponse","CreateBankTransactionsRequest","CreateBankTransactionsResponse","CreateCompanyResponse","CreateDataConnectionRequest","CreateDataConnectionRequestBody","CreateDataConnectionResponse","DeleteCompanyConnectionRequest","DeleteCompanyConnectionResponse","DeleteCompanyRequest","DeleteCompanyResponse","GetBankAccountMappingRequest","GetBankAccountMappingResponse","GetBankFeedsRequest","GetBankFeedsResponse","GetCompanyConnectionRequest","GetCompanyConnectionResponse","GetCompanyRequest","GetCompanyResponse","GetCreateBankAccountModelRequest","GetCreateBankAccountModelResponse","ListBankAccountTransactions409ApplicationJSON","ListBankAccountTransactionsRequest","ListBankAccountTransactionsResponse","ListCompaniesRequest","ListCompaniesResponse","ListCompanyConnectionsRequest","ListCompanyConnectionsResponse","ProxyRequest","ProxyResponse","UnlinkConnectionRequest","UnlinkConnectionRequestBody","UnlinkConnectionResponse","UpdateBankFeedRequest","UpdateBankFeedResponse","UpdateCompanyRequest","UpdateCompanyResponse"]
23+
__all__ = ["CreateBankAccountMappingRequest","CreateBankAccountMappingResponse","CreateBankFeedRequest","CreateBankFeedResponse","CreateBankTransactionsRequest","CreateBankTransactionsResponse","CreateCompanyResponse","CreateDataConnectionRequest","CreateDataConnectionRequestBody","CreateDataConnectionResponse","DeleteCompanyConnectionRequest","DeleteCompanyConnectionResponse","DeleteCompanyRequest","DeleteCompanyResponse","GetBankAccountMappingRequest","GetBankAccountMappingResponse","GetBankFeedsRequest","GetBankFeedsResponse","GetCompanyConnectionRequest","GetCompanyConnectionResponse","GetCompanyRequest","GetCompanyResponse","GetCreateBankTransactionsModelRequest","GetCreateBankTransactionsModelResponse","ListBankAccountTransactions409ApplicationJSON","ListBankAccountTransactionsRequest","ListBankAccountTransactionsResponse","ListCompaniesRequest","ListCompaniesResponse","ListCompanyConnectionsRequest","ListCompanyConnectionsResponse","ProxyRequest","ProxyResponse","UnlinkConnectionRequest","UnlinkConnectionRequestBody","UnlinkConnectionResponse","UpdateBankFeedRequest","UpdateBankFeedResponse","UpdateCompanyRequest","UpdateCompanyResponse"]

0 commit comments

Comments
 (0)