Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 46 additions & 20 deletions sync-for-expenses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ pip install codat-sync-for-expenses

## Example Usage
<!-- Start SDK Example Usage -->


```python
import codatsyncexpenses
from codatsyncexpenses.models import operations, shared
Expand All @@ -31,7 +29,7 @@ req = operations.CreateAccountRequest(
current_balance=Decimal('0'),
description='Invoices the business has issued but has not yet collected payment on.',
fully_qualified_category='Asset.Current',
fully_qualified_name='Fixed Asset',
fully_qualified_name='Cash On Hand',
id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e',
is_bank_account=False,
metadata=shared.AccountMetadata(
Expand All @@ -46,15 +44,16 @@ req = operations.CreateAccountRequest(
valid_datatype_links=[
shared.AccountValidDataTypeLinks(
links=[
'unde',
'Money',
],
property='nulla',
property='Cambridgeshire grey technology',
),
],
),
allow_sync_on_push_complete=False,
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
timeout_in_minutes=86,
)

res = s.accounts.create(req)
Expand All @@ -68,77 +67,104 @@ if res.create_account_response is not None:
## Available Resources and Operations


### [Accounts](docs/sdks/accounts/README.md)
### [accounts](docs/sdks/accounts/README.md)

* [create](docs/sdks/accounts/README.md#create) - Create account
* [get_create_model](docs/sdks/accounts/README.md#get_create_model) - Get create account model

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

* [create](docs/sdks/companies/README.md#create) - Create company
* [delete](docs/sdks/companies/README.md#delete) - Delete a company
* [get](docs/sdks/companies/README.md#get) - Get company
* [list](docs/sdks/companies/README.md#list) - List companies
* [update](docs/sdks/companies/README.md#update) - Update company

### [Configuration](docs/sdks/configuration/README.md)
### [configuration](docs/sdks/configuration/README.md)

* [get](docs/sdks/configuration/README.md#get) - Get company configuration
* [get_mapping_options](docs/sdks/configuration/README.md#get_mapping_options) - Mapping options
* [set](docs/sdks/configuration/README.md#set) - Set company configuration

### [Connections](docs/sdks/connections/README.md)
### [connections](docs/sdks/connections/README.md)

* [create](docs/sdks/connections/README.md#create) - Create connection
* [create_partner_expense_connection](docs/sdks/connections/README.md#create_partner_expense_connection) - Create Partner Expense connection
* [create_partner_expense_connection](docs/sdks/connections/README.md#create_partner_expense_connection) - Create partner expense connection
* [delete](docs/sdks/connections/README.md#delete) - Delete connection
* [get](docs/sdks/connections/README.md#get) - Get connection
* [list](docs/sdks/connections/README.md#list) - List connections
* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection

### [Customers](docs/sdks/customers/README.md)
### [customers](docs/sdks/customers/README.md)

* [create](docs/sdks/customers/README.md#create) - Create customer
* [get](docs/sdks/customers/README.md#get) - Get customer
* [list](docs/sdks/customers/README.md#list) - List customers
* [update](docs/sdks/customers/README.md#update) - Update customer

### [Expenses](docs/sdks/expenses/README.md)
### [expenses](docs/sdks/expenses/README.md)

* [create](docs/sdks/expenses/README.md#create) - Create expense transaction
* [update](docs/sdks/expenses/README.md#update) - Update expense-transactions
* [upload_attachment](docs/sdks/expenses/README.md#upload_attachment) - Upload attachment

### [ManageData](docs/sdks/managedata/README.md)
### [manage_data](docs/sdks/managedata/README.md)

* [get](docs/sdks/managedata/README.md#get) - Get data status
* [get_pull_operation](docs/sdks/managedata/README.md#get_pull_operation) - Get pull operation
* [list_pull_operations](docs/sdks/managedata/README.md#list_pull_operations) - List pull operations
* [refresh_all_data_types](docs/sdks/managedata/README.md#refresh_all_data_types) - Refresh all data
* [refresh_data_type](docs/sdks/managedata/README.md#refresh_data_type) - Refresh data type

### [PushOperations](docs/sdks/pushoperations/README.md)
### [push_operations](docs/sdks/pushoperations/README.md)

* [get](docs/sdks/pushoperations/README.md#get) - Get push operation
* [list](docs/sdks/pushoperations/README.md#list) - List push operations

### [Suppliers](docs/sdks/suppliers/README.md)
### [suppliers](docs/sdks/suppliers/README.md)

* [create](docs/sdks/suppliers/README.md#create) - Create supplier
* [get](docs/sdks/suppliers/README.md#get) - Get supplier
* [list](docs/sdks/suppliers/README.md#list) - List suppliers
* [update](docs/sdks/suppliers/README.md#update) - Update supplier

### [Sync](docs/sdks/sync/README.md)
### [sync](docs/sdks/sync/README.md)

* [get](docs/sdks/sync/README.md#get) - Get Sync status
* [get](docs/sdks/sync/README.md#get) - Get sync status
* [get_last_successful_sync](docs/sdks/sync/README.md#get_last_successful_sync) - Last successful sync
* [get_latest_sync](docs/sdks/sync/README.md#get_latest_sync) - Latest sync status
* [initiate_sync](docs/sdks/sync/README.md#initiate_sync) - Initiate sync
* [list](docs/sdks/sync/README.md#list) - List sync statuses

### [TransactionStatus](docs/sdks/transactionstatus/README.md)
### [transaction_status](docs/sdks/transactionstatus/README.md)

* [get](docs/sdks/transactionstatus/README.md#get) - Get Sync Transaction
* [get](docs/sdks/transactionstatus/README.md#get) - Get sync transaction
* [list](docs/sdks/transactionstatus/README.md#list) - List sync transactions
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->



<!-- End Dev Containers -->



<!-- Start Pagination -->
# Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:


<!-- End Pagination -->

<!-- Placeholder for Future Speakeasy SDK Sections -->


### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
12 changes: 11 additions & 1 deletion sync-for-expenses/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,4 +656,14 @@ Based on:
### Generated
- [python v2.1.0] sync-for-expenses
### Releases
- [PyPI v2.1.0] https://pypi.org/project/codat-sync-for-expenses/2.1.0 - sync-for-expenses
- [PyPI v2.1.0] https://pypi.org/project/codat-sync-for-expenses/2.1.0 - sync-for-expenses

## 2023-10-04 14:48:14
### Changes
Based on:
- OpenAPI Doc prealpha https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Expenses.yaml
- Speakeasy CLI 1.93.3 (2.146.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v3.1.0] sync-for-expenses
### Releases
- [PyPI v3.1.0] https://pypi.org/project/codat-sync-for-expenses/3.1.0 - sync-for-expenses
9 changes: 5 additions & 4 deletions sync-for-expenses/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ req = operations.CreateAccountRequest(
current_balance=Decimal('0'),
description='Invoices the business has issued but has not yet collected payment on.',
fully_qualified_category='Asset.Current',
fully_qualified_name='Fixed Asset',
fully_qualified_name='Cash On Hand',
id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e',
is_bank_account=False,
metadata=shared.AccountMetadata(
Expand All @@ -33,15 +33,16 @@ req = operations.CreateAccountRequest(
valid_datatype_links=[
shared.AccountValidDataTypeLinks(
links=[
'unde',
'Money',
],
property='nulla',
property='Cambridgeshire grey technology',
),
],
),
allow_sync_on_push_complete=False,
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
timeout_in_minutes=86,
)

res = s.accounts.create(req)
Expand Down
13 changes: 7 additions & 6 deletions sync-for-expenses/docs/models/operations/createaccountrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

## Fields

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `account` | [Optional[shared.Account]](../../models/shared/account.md) | :heavy_minus_sign: | N/A | |
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `account` | [Optional[shared.Account]](undefined/models/shared/account.md) | :heavy_minus_sign: | N/A | |
| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | |
| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | |
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | N/A |
| `create_account_response` | [Optional[shared.CreateAccountResponse]](../../models/shared/createaccountresponse.md) | :heavy_minus_sign: | Success |
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `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 |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation |
| `create_account_response` | [Optional[shared.CreateAccountResponse]](undefined/models/shared/createaccountresponse.md) | :heavy_minus_sign: | Success |
| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
Loading