Skip to content

Commit b635e7a

Browse files
dcoplowedcoplowe
authored
Merge pull request #322 from codatio/speakeasy-sdk-regen-1694704494
chore: speakeasy sdk regeneration - Generate Lending library
2 parents b21d475 + 8a395bd commit b635e7a

File tree

15 files changed

+385
-62
lines changed

15 files changed

+385
-62
lines changed

‎lending/README.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ if res.accounting_bank_transactions is not None:
4949

5050
* [list_transactions](docs/sdks/accountingbankdata/README.md#list_transactions) - List bank account transactions
5151

52-
### [accounts_payable](docs/sdks/accountspayable/README.md)
52+
### [accounting_bank_data_accounts](docs/sdks/accountingbankdataaccounts/README.md)
5353

54-
* [download_bill_attachment](docs/sdks/accountspayable/README.md#download_bill_attachment) - Download bill attachment
55-
* [get_bill_attachment](docs/sdks/accountspayable/README.md#get_bill_attachment) - Get bill attachment
54+
* [get](docs/sdks/accountingbankdataaccounts/README.md#get) - Get bank account
55+
* [list](docs/sdks/accountingbankdataaccounts/README.md#list) - List bank accounts
5656

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

@@ -99,12 +99,6 @@ if res.accounting_bank_transactions is not None:
9999
* [list_loan_transactions](docs/sdks/liabilities/README.md#list_loan_transactions) - List loan transactions
100100

101101

102-
### [accounting_bank_data_accounts](docs/sdks/accountingbankdataaccounts/README.md)
103-
104-
* [get](docs/sdks/accountingbankdataaccounts/README.md#get) - Get bank account
105-
* [list](docs/sdks/accountingbankdataaccounts/README.md#list) - List bank accounts
106-
107-
108102
### [accounts_payable_bill_credit_notes](docs/sdks/accountspayablebillcreditnotes/README.md)
109103

110104
* [get](docs/sdks/accountspayablebillcreditnotes/README.md#get) - Get bill credit note
@@ -117,7 +111,9 @@ if res.accounting_bank_transactions is not None:
117111

118112
### [accounts_payable_bills](docs/sdks/accountspayablebills/README.md)
119113

114+
* [download_attachment](docs/sdks/accountspayablebills/README.md#download_attachment) - Download bill attachment
120115
* [get](docs/sdks/accountspayablebills/README.md#get) - Get bill
116+
* [get_attachment](docs/sdks/accountspayablebills/README.md#get_attachment) - Get bill attachment
121117
* [list](docs/sdks/accountspayablebills/README.md#list) - List bills
122118
* [list_attachments](docs/sdks/accountspayablebills/README.md#list_attachments) - List bill attachments
123119

‎lending/RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,14 @@ Based on:
1818
### Generated
1919
- [python v2.0.0] lending
2020
### Releases
21-
- [PyPI v2.0.0] https://pypi.org/project/codat-lending/2.0.0 - lending
21+
- [PyPI v2.0.0] https://pypi.org/project/codat-lending/2.0.0 - lending
22+
23+
## 2023-09-14 15:14:50
24+
### Changes
25+
Based on:
26+
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Lending.yaml
27+
- Speakeasy CLI 1.83.2 (2.109.3) https://github.com/speakeasy-api/speakeasy
28+
### Generated
29+
- [python v3.1.0] lending
30+
### Releases
31+
- [PyPI v3.1.0] https://pypi.org/project/codat-lending/3.1.0 - lending

‎lending/docs/sdks/accountingbankdata/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,61 @@
11
# accounting_bank_data
22

3+
## Overview
4+
5+
Access bank transactions from an accounting platform.
6+
37
### Available Operations
48

9+
* [list_transactions](#list_transactions) - List bank account transactions
10+
11+
## list_transactions
12+
13+
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.
14+
15+
[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.
16+
17+
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.
18+
19+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
20+
21+
22+
### Example Usage
23+
24+
```python
25+
import codatlending
26+
from codatlending.models import operations, shared
27+
28+
s = codatlending.CodatLending(
29+
security=shared.Security(
30+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
31+
),
32+
)
33+
34+
req = operations.ListAccountingBankAccountTransactionsRequest(
35+
account_id='distinctio',
36+
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
37+
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
38+
order_by='-modifiedDate',
39+
page=1,
40+
page_size=100,
41+
query='quibusdam',
42+
)
43+
44+
res = s.accounting_bank_data.list_transactions(req)
45+
46+
if res.accounting_bank_transactions is not None:
47+
# handle response
48+
```
49+
50+
### Parameters
51+
52+
| Parameter | Type | Required | Description |
53+
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
54+
| `request` | [operations.ListAccountingBankAccountTransactionsRequest](../../models/operations/listaccountingbankaccounttransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
55+
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
56+
57+
58+
### Response
59+
60+
**[operations.ListAccountingBankAccountTransactionsResponse](../../models/operations/listaccountingbankaccounttransactionsresponse.md)**
61+

‎lending/docs/sdks/accountingbankdataaccounts/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ s = codatlending.CodatLending(
2929
)
3030

3131
req = operations.GetAccountingBankAccountRequest(
32-
account_id='molestiae',
32+
account_id='unde',
3333
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
3434
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
3535
)
@@ -80,7 +80,7 @@ req = operations.ListAccountingBankAccountsRequest(
8080
order_by='-modifiedDate',
8181
page=1,
8282
page_size=100,
83-
query='minus',
83+
query='nulla',
8484
)
8585

8686
res = s.accounting_bank_data_accounts.list(req)

‎lending/docs/sdks/accountspayablebillcreditnotes/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ s = codatlending.CodatLending(
2929
)
3030

3131
req = operations.GetAccountingBillCreditNoteRequest(
32-
bill_credit_note_id='placeat',
32+
bill_credit_note_id='molestiae',
3333
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
3434
)
3535

@@ -78,7 +78,7 @@ req = operations.ListAccountingBillCreditNotesRequest(
7878
order_by='-modifiedDate',
7979
page=1,
8080
page_size=100,
81-
query='voluptatum',
81+
query='minus',
8282
)
8383

8484
res = s.accounts_payable_bill_credit_notes.list(req)

‎lending/docs/sdks/accountspayablebillpayments/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ s = codatlending.CodatLending(
2929
)
3030

3131
req = operations.GetAccountingBillPaymentRequest(
32-
bill_payment_id='iusto',
32+
bill_payment_id='placeat',
3333
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
3434
)
3535

@@ -78,7 +78,7 @@ req = operations.ListAccountingBillPaymentsRequest(
7878
order_by='-modifiedDate',
7979
page=1,
8080
page_size=100,
81-
query='excepturi',
81+
query='voluptatum',
8282
)
8383

8484
res = s.accounts_payable_bill_payments.list(req)

‎lending/docs/sdks/accountspayablebills/README.md‎

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,59 @@
22

33
### Available Operations
44

5+
* [download_attachment](#download_attachment) - Download bill attachment
56
* [get](#get) - Get bill
7+
* [get_attachment](#get_attachment) - Get bill attachment
68
* [list](#list) - List bills
79
* [list_attachments](#list_attachments) - List bill attachments
810

11+
## download_attachment
12+
13+
The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.
14+
15+
[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
16+
17+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment.
18+
19+
20+
### Example Usage
21+
22+
```python
23+
import codatlending
24+
from codatlending.models import operations, shared
25+
26+
s = codatlending.CodatLending(
27+
security=shared.Security(
28+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
29+
),
30+
)
31+
32+
req = operations.DownloadAccountingBillAttachmentRequest(
33+
attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002',
34+
bill_id='iusto',
35+
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
36+
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
37+
)
38+
39+
res = s.accounts_payable_bills.download_attachment(req)
40+
41+
if res.data is not None:
42+
# handle response
43+
```
44+
45+
### Parameters
46+
47+
| Parameter | Type | Required | Description |
48+
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
49+
| `request` | [operations.DownloadAccountingBillAttachmentRequest](../../models/operations/downloadaccountingbillattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
50+
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
51+
52+
53+
### Response
54+
55+
**[operations.DownloadAccountingBillAttachmentResponse](../../models/operations/downloadaccountingbillattachmentresponse.md)**
56+
57+
958
## get
1059

1160
The *Get bill* endpoint returns a single bill for a given billId.
@@ -30,7 +79,7 @@ s = codatlending.CodatLending(
3079
)
3180

3281
req = operations.GetAccountingBillRequest(
33-
bill_id='nisi',
82+
bill_id='excepturi',
3483
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
3584
)
3685

@@ -53,6 +102,53 @@ if res.accounting_bill is not None:
53102
**[operations.GetAccountingBillResponse](../../models/operations/getaccountingbillresponse.md)**
54103

55104

105+
## get_attachment
106+
107+
The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.
108+
109+
[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
110+
111+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment.
112+
113+
114+
### Example Usage
115+
116+
```python
117+
import codatlending
118+
from codatlending.models import operations, shared
119+
120+
s = codatlending.CodatLending(
121+
security=shared.Security(
122+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
123+
),
124+
)
125+
126+
req = operations.GetAccountingBillAttachmentRequest(
127+
attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002',
128+
bill_id='nisi',
129+
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
130+
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
131+
)
132+
133+
res = s.accounts_payable_bills.get_attachment(req)
134+
135+
if res.accounting_attachment is not None:
136+
# handle response
137+
```
138+
139+
### Parameters
140+
141+
| Parameter | Type | Required | Description |
142+
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
143+
| `request` | [operations.GetAccountingBillAttachmentRequest](../../models/operations/getaccountingbillattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
144+
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
145+
146+
147+
### Response
148+
149+
**[operations.GetAccountingBillAttachmentResponse](../../models/operations/getaccountingbillattachmentresponse.md)**
150+
151+
56152
## list
57153

58154
The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.

0 commit comments

Comments
 (0)