Skip to content

Commit de71291

Browse files
ci: regenerated with OpenAPI Doc 3.0.0, Speakeasy CLI 1.179.0 (#570)
Co-authored-by: speakeasybot <[email protected]>
1 parent 288c7fc commit de71291

File tree

454 files changed

+655
-17420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

454 files changed

+655
-17420
lines changed
Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
lockVersion: 2.0.0
2+
id: 75f7ac26-bce6-4db5-85a1-c67d938c4735
3+
management:
4+
docChecksum: 681f585653736aeb9009765e989c7e73
5+
docVersion: 3.0.0
6+
speakeasyVersion: internal
7+
generationVersion: 2.257.2
8+
releaseVersion: 3.2.0
9+
configChecksum: 972e1dc61ff2bfa4ef179b5de8a4906b
10+
repoURL: https://github.com/codatio/client-sdk-python.git
11+
repoSubDirectory: sync-for-payables
12+
installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=sync-for-payables
13+
published: true
14+
features:
15+
python:
16+
constsAndDefaults: 0.1.2
17+
core: 4.4.6
18+
deprecations: 2.81.1
19+
examples: 2.81.3
20+
globalSecurity: 2.83.2
21+
globalServerURLs: 2.82.1
22+
ignores: 2.81.1
23+
nameOverrides: 2.81.1
24+
retries: 2.82.1
25+
generatedFiles:
26+
- src/codatsyncpayables/sdkconfiguration.py
27+
- src/codatsyncpayables/companies.py
28+
- src/codatsyncpayables/bills.py
29+
- src/codatsyncpayables/connections.py
30+
- src/codatsyncpayables/sdk.py
31+
- pylintrc
32+
- setup.py
33+
- src/codatsyncpayables/__init__.py
34+
- src/codatsyncpayables/utils/__init__.py
35+
- src/codatsyncpayables/utils/retries.py
36+
- src/codatsyncpayables/utils/utils.py
37+
- src/codatsyncpayables/models/errors/sdkerror.py
38+
- tests/helpers.py
39+
- src/codatsyncpayables/models/operations/create_company.py
40+
- src/codatsyncpayables/models/operations/delete_company.py
41+
- src/codatsyncpayables/models/operations/get_company.py
42+
- src/codatsyncpayables/models/operations/list_companies.py
43+
- src/codatsyncpayables/models/operations/update_company.py
44+
- src/codatsyncpayables/models/operations/list_bills.py
45+
- src/codatsyncpayables/models/operations/create_connection.py
46+
- src/codatsyncpayables/models/operations/delete_connection.py
47+
- src/codatsyncpayables/models/operations/get_connection.py
48+
- src/codatsyncpayables/models/operations/list_connections.py
49+
- src/codatsyncpayables/models/operations/unlink_connection.py
50+
- src/codatsyncpayables/models/shared/company.py
51+
- src/codatsyncpayables/models/shared/connection.py
52+
- src/codatsyncpayables/models/shared/dataconnectionstatus.py
53+
- src/codatsyncpayables/models/shared/dataconnectionerror.py
54+
- src/codatsyncpayables/models/shared/errorvalidation.py
55+
- src/codatsyncpayables/models/shared/errorvalidationitem.py
56+
- src/codatsyncpayables/models/shared/companyrequestbody.py
57+
- src/codatsyncpayables/models/shared/items.py
58+
- src/codatsyncpayables/models/shared/companies.py
59+
- src/codatsyncpayables/models/shared/links.py
60+
- src/codatsyncpayables/models/shared/halref.py
61+
- src/codatsyncpayables/models/shared/bills.py
62+
- src/codatsyncpayables/models/shared/bill.py
63+
- src/codatsyncpayables/models/shared/supplierref.py
64+
- src/codatsyncpayables/models/shared/billstatus.py
65+
- src/codatsyncpayables/models/shared/billlineitem.py
66+
- src/codatsyncpayables/models/shared/connections.py
67+
- src/codatsyncpayables/models/shared/security.py
68+
- src/codatsyncpayables/models/shared/clientratelimitreachedwebhook.py
69+
- src/codatsyncpayables/models/shared/clientratelimitreachedwebhookdata.py
70+
- src/codatsyncpayables/models/shared/clientratelimitresetwebhook.py
71+
- src/codatsyncpayables/models/shared/clientratelimitresetwebhookdata.py
72+
- src/codatsyncpayables/models/shared/billeventwebhook.py
73+
- src/codatsyncpayables/models/shared/billeventpayload.py
74+
- src/codatsyncpayables/models/errors/errormessage.py
75+
- src/codatsyncpayables/models/webhooks/client_rate_limit_reached.py
76+
- src/codatsyncpayables/models/webhooks/client_rate_limit_reset.py
77+
- src/codatsyncpayables/models/webhooks/payables_bill_created.py
78+
- src/codatsyncpayables/models/webhooks/payables_bill_deleted.py
79+
- src/codatsyncpayables/models/webhooks/payables_bill_updated.py
80+
- src/codatsyncpayables/models/__init__.py
81+
- src/codatsyncpayables/models/errors/__init__.py
82+
- src/codatsyncpayables/models/operations/__init__.py
83+
- src/codatsyncpayables/models/shared/__init__.py
84+
- src/codatsyncpayables/models/webhooks/__init__.py
85+
- docs/models/operations/createcompanyresponse.md
86+
- docs/models/operations/deletecompanyrequest.md
87+
- docs/models/operations/deletecompanyresponse.md
88+
- docs/models/operations/getcompanyrequest.md
89+
- docs/models/operations/getcompanyresponse.md
90+
- docs/models/operations/listcompaniesrequest.md
91+
- docs/models/operations/listcompaniesresponse.md
92+
- docs/models/operations/updatecompanyrequest.md
93+
- docs/models/operations/updatecompanyresponse.md
94+
- docs/models/operations/listbillsrequest.md
95+
- docs/models/operations/listbillsresponse.md
96+
- docs/models/operations/createconnectionrequestbody.md
97+
- docs/models/operations/createconnectionrequest.md
98+
- docs/models/operations/createconnectionresponse.md
99+
- docs/models/operations/deleteconnectionrequest.md
100+
- docs/models/operations/deleteconnectionresponse.md
101+
- docs/models/operations/getconnectionrequest.md
102+
- docs/models/operations/getconnectionresponse.md
103+
- docs/models/operations/listconnectionsrequest.md
104+
- docs/models/operations/listconnectionsresponse.md
105+
- docs/models/operations/unlinkconnectionupdateconnection.md
106+
- docs/models/operations/unlinkconnectionrequest.md
107+
- docs/models/operations/unlinkconnectionresponse.md
108+
- docs/models/shared/groupreference.md
109+
- docs/models/shared/company.md
110+
- docs/models/shared/sourcetype.md
111+
- docs/models/shared/connection.md
112+
- docs/models/shared/dataconnectionstatus.md
113+
- docs/models/shared/dataconnectionerror.md
114+
- docs/models/shared/errorvalidation.md
115+
- docs/models/shared/errorvalidationitem.md
116+
- docs/models/shared/companyrequestbody.md
117+
- docs/models/shared/items.md
118+
- docs/models/shared/companies.md
119+
- docs/models/shared/links.md
120+
- docs/models/shared/halref.md
121+
- docs/models/shared/bills.md
122+
- docs/models/shared/bill.md
123+
- docs/models/shared/supplierref.md
124+
- docs/models/shared/billstatus.md
125+
- docs/models/shared/accountreference.md
126+
- docs/models/shared/taxratereference.md
127+
- docs/models/shared/billlineitem.md
128+
- docs/models/shared/connections.md
129+
- docs/models/shared/security.md
130+
- docs/models/shared/clientratelimitreachedwebhook.md
131+
- docs/models/shared/clientratelimitreachedwebhookdata.md
132+
- docs/models/shared/clientratelimitresetwebhook.md
133+
- docs/models/shared/clientratelimitresetwebhookdata.md
134+
- docs/models/shared/billeventwebhook.md
135+
- docs/models/shared/billeventpayload.md
136+
- docs/models/errors/errormessage.md
137+
- docs/models/webhooks/clientratelimitreachedresponse.md
138+
- docs/models/webhooks/clientratelimitresetresponse.md
139+
- docs/models/webhooks/payablesbillcreatedresponse.md
140+
- docs/models/webhooks/payablesbilldeletedresponse.md
141+
- docs/models/webhooks/payablesbillupdatedresponse.md
142+
- docs/sdks/codatsyncpayables/README.md
143+
- docs/models/utils/retryconfig.md
144+
- docs/sdks/companies/README.md
145+
- docs/sdks/bills/README.md
146+
- docs/sdks/connections/README.md
147+
- USAGE.md
148+
- .gitattributes

sync-for-payables/README.md

Lines changed: 19 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ s = codatsyncpayables.CodatSyncPayables(
2929
)
3030

3131
req = shared.CompanyRequestBody(
32-
description='Requested early access to the new financing scheme.',
3332
name='Bank of Dave',
33+
description='Requested early access to the new financing scheme.',
3434
)
3535

3636
res = s.companies.create(req)
@@ -52,107 +52,17 @@ if res.company is not None:
5252
* [list](docs/sdks/companies/README.md#list) - List companies
5353
* [update](docs/sdks/companies/README.md#update) - Update company
5454

55+
### [bills](docs/sdks/bills/README.md)
56+
57+
* [list](docs/sdks/bills/README.md#list) - List bills
58+
5559
### [connections](docs/sdks/connections/README.md)
5660

5761
* [create](docs/sdks/connections/README.md#create) - Create connection
5862
* [delete](docs/sdks/connections/README.md#delete) - Delete connection
5963
* [get](docs/sdks/connections/README.md#get) - Get connection
6064
* [list](docs/sdks/connections/README.md#list) - List connections
6165
* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection
62-
63-
### [bills](docs/sdks/bills/README.md)
64-
65-
* [create](docs/sdks/bills/README.md#create) - Create bill
66-
* [delete](docs/sdks/bills/README.md#delete) - Delete bill
67-
* [delete_attachment](docs/sdks/bills/README.md#delete_attachment) - Delete bill attachment
68-
* [download_attachment](docs/sdks/bills/README.md#download_attachment) - Download bill attachment
69-
* [get](docs/sdks/bills/README.md#get) - Get bill
70-
* [get_attachment](docs/sdks/bills/README.md#get_attachment) - Get bill attachment
71-
* [get_create_update_model](docs/sdks/bills/README.md#get_create_update_model) - Get create/update bill model
72-
* [list](docs/sdks/bills/README.md#list) - List bills
73-
* [list_attachments](docs/sdks/bills/README.md#list_attachments) - List bill attachments
74-
* [update](docs/sdks/bills/README.md#update) - Update bill
75-
* [upload_attachment](docs/sdks/bills/README.md#upload_attachment) - Upload bill attachment
76-
77-
### [bank_accounts](docs/sdks/bankaccounts/README.md)
78-
79-
* [create](docs/sdks/bankaccounts/README.md#create) - Create bank account
80-
* [get_create_model](docs/sdks/bankaccounts/README.md#get_create_model) - Get create/update bank account model
81-
82-
### [bill_credit_notes](docs/sdks/billcreditnotes/README.md)
83-
84-
* [create](docs/sdks/billcreditnotes/README.md#create) - Create bill credit note
85-
* [get](docs/sdks/billcreditnotes/README.md#get) - Get bill credit note
86-
* [get_create_update_model](docs/sdks/billcreditnotes/README.md#get_create_update_model) - Get create/update bill credit note model
87-
* [list](docs/sdks/billcreditnotes/README.md#list) - List bill credit notes
88-
* [update](docs/sdks/billcreditnotes/README.md#update) - Update bill credit note
89-
90-
### [bill_payments](docs/sdks/billpayments/README.md)
91-
92-
* [create](docs/sdks/billpayments/README.md#create) - Create bill payments
93-
* [delete](docs/sdks/billpayments/README.md#delete) - Delete bill payment
94-
* [get](docs/sdks/billpayments/README.md#get) - Get bill payment
95-
* [get_create_model](docs/sdks/billpayments/README.md#get_create_model) - Get create bill payment model
96-
* [list](docs/sdks/billpayments/README.md#list) - List bill payments
97-
98-
### [accounts](docs/sdks/accounts/README.md)
99-
100-
* [create](docs/sdks/accounts/README.md#create) - Create account
101-
* [get](docs/sdks/accounts/README.md#get) - Get account
102-
* [get_create_model](docs/sdks/accounts/README.md#get_create_model) - Get create account model
103-
* [list](docs/sdks/accounts/README.md#list) - List accounts
104-
105-
### [journal_entries](docs/sdks/journalentries/README.md)
106-
107-
* [create](docs/sdks/journalentries/README.md#create) - Create journal entry
108-
* [get_create_model](docs/sdks/journalentries/README.md#get_create_model) - Get create journal entry model
109-
110-
### [journals](docs/sdks/journals/README.md)
111-
112-
* [create](docs/sdks/journals/README.md#create) - Create journal
113-
* [get](docs/sdks/journals/README.md#get) - Get journal
114-
* [get_create_model](docs/sdks/journals/README.md#get_create_model) - Get create journal model
115-
* [list](docs/sdks/journals/README.md#list) - List journals
116-
117-
### [suppliers](docs/sdks/suppliers/README.md)
118-
119-
* [create](docs/sdks/suppliers/README.md#create) - Create supplier
120-
* [get](docs/sdks/suppliers/README.md#get) - Get supplier
121-
* [get_create_update_model](docs/sdks/suppliers/README.md#get_create_update_model) - Get create/update supplier model
122-
* [list](docs/sdks/suppliers/README.md#list) - List suppliers
123-
* [update](docs/sdks/suppliers/README.md#update) - Update supplier
124-
125-
### [manage_data](docs/sdks/managedata/README.md)
126-
127-
* [get](docs/sdks/managedata/README.md#get) - Get data status
128-
* [get_pull_operation](docs/sdks/managedata/README.md#get_pull_operation) - Get pull operation
129-
* [list_pull_operations](docs/sdks/managedata/README.md#list_pull_operations) - List pull operations
130-
* [refresh_all_data_types](docs/sdks/managedata/README.md#refresh_all_data_types) - Refresh all data
131-
* [refresh_data_type](docs/sdks/managedata/README.md#refresh_data_type) - Refresh data type
132-
133-
### [company_info](docs/sdks/companyinfo/README.md)
134-
135-
* [get_accounting_profile](docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile
136-
137-
### [payment_methods](docs/sdks/paymentmethods/README.md)
138-
139-
* [get](docs/sdks/paymentmethods/README.md#get) - Get payment method
140-
* [list](docs/sdks/paymentmethods/README.md#list) - List payment methods
141-
142-
### [tax_rates](docs/sdks/taxrates/README.md)
143-
144-
* [get](docs/sdks/taxrates/README.md#get) - Get tax rate
145-
* [list](docs/sdks/taxrates/README.md#list) - List all tax rates
146-
147-
### [tracking_categories](docs/sdks/trackingcategories/README.md)
148-
149-
* [get](docs/sdks/trackingcategories/README.md#get) - Get tracking categories
150-
* [list](docs/sdks/trackingcategories/README.md#list) - List tracking categories
151-
152-
### [push_operations](docs/sdks/pushoperations/README.md)
153-
154-
* [get](docs/sdks/pushoperations/README.md#get) - Get push operation
155-
* [list](docs/sdks/pushoperations/README.md#list) - List push operations
15666
<!-- End Available Resources and Operations [operations] -->
15767

15868

@@ -162,9 +72,9 @@ if res.company is not None:
16272
<!-- Start Retries [retries] -->
16373
## Retries
16474

165-
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
75+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
16676

167-
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
77+
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
16878
```python
16979
import codatsyncpayables
17080
from codatsyncpayables.models import shared
@@ -177,8 +87,8 @@ s = codatsyncpayables.CodatSyncPayables(
17787
)
17888

17989
req = shared.CompanyRequestBody(
180-
description='Requested early access to the new financing scheme.',
18190
name='Bank of Dave',
91+
description='Requested early access to the new financing scheme.',
18292
)
18393

18494
res = s.companies.create(req,
@@ -189,7 +99,7 @@ if res.company is not None:
18999
pass
190100
```
191101

192-
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
102+
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
193103
```python
194104
import codatsyncpayables
195105
from codatsyncpayables.models import shared
@@ -203,8 +113,8 @@ s = codatsyncpayables.CodatSyncPayables(
203113
)
204114

205115
req = shared.CompanyRequestBody(
206-
description='Requested early access to the new financing scheme.',
207116
name='Bank of Dave',
117+
description='Requested early access to the new financing scheme.',
208118
)
209119

210120
res = s.companies.create(req)
@@ -223,13 +133,13 @@ Handling errors in this SDK should largely match your expectations. All operati
223133
| Error Object | Status Code | Content Type |
224134
| --------------------------- | --------------------------- | --------------------------- |
225135
| errors.ErrorMessage | 400,401,402,403,429,500,503 | application/json |
226-
| errors.SDKError | 400-600 | */* |
136+
| errors.SDKError | 4x-5xx | */* |
227137

228138
### Example
229139

230140
```python
231141
import codatsyncpayables
232-
from codatsyncpayables.models import shared
142+
from codatsyncpayables.models import errors, shared
233143

234144
s = codatsyncpayables.CodatSyncPayables(
235145
security=shared.Security(
@@ -238,18 +148,18 @@ s = codatsyncpayables.CodatSyncPayables(
238148
)
239149

240150
req = shared.CompanyRequestBody(
241-
description='Requested early access to the new financing scheme.',
242151
name='Bank of Dave',
152+
description='Requested early access to the new financing scheme.',
243153
)
244154

245155
res = None
246156
try:
247157
res = s.companies.create(req)
248158
except errors.ErrorMessage as e:
249-
print(e) # handle exception
159+
# handle exception
250160
raise(e)
251161
except errors.SDKError as e:
252-
print(e) # handle exception
162+
# handle exception
253163
raise(e)
254164

255165
if res.company is not None:
@@ -283,8 +193,8 @@ s = codatsyncpayables.CodatSyncPayables(
283193
)
284194

285195
req = shared.CompanyRequestBody(
286-
description='Requested early access to the new financing scheme.',
287196
name='Bank of Dave',
197+
description='Requested early access to the new financing scheme.',
288198
)
289199

290200
res = s.companies.create(req)
@@ -310,8 +220,8 @@ s = codatsyncpayables.CodatSyncPayables(
310220
)
311221

312222
req = shared.CompanyRequestBody(
313-
description='Requested early access to the new financing scheme.',
314223
name='Bank of Dave',
224+
description='Requested early access to the new financing scheme.',
315225
)
316226

317227
res = s.companies.create(req)
@@ -325,7 +235,7 @@ if res.company is not None:
325235
<!-- Start Custom HTTP Client [http-client] -->
326236
## Custom HTTP Client
327237

328-
The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
238+
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
329239

330240
For example, you could specify a header for every request that this sdk makes as follows:
331241
```python
@@ -361,8 +271,8 @@ s = codatsyncpayables.CodatSyncPayables(
361271
)
362272

363273
req = shared.CompanyRequestBody(
364-
description='Requested early access to the new financing scheme.',
365274
name='Bank of Dave',
275+
description='Requested early access to the new financing scheme.',
366276
)
367277

368278
res = s.companies.create(req)

0 commit comments

Comments
 (0)