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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
47 changes: 30 additions & 17 deletions previous-versions/sync-for-commerce-version-1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pip install codat-sync-for-commerce-version-1

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


```python
import codatsynccommerce
from codatsynccommerce.models import operations, shared
Expand All @@ -29,40 +27,43 @@ s = codatsynccommerce.CodatSyncCommerce(

req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
currency='USD',
currency='GBP',
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.AccountingAccountMetadata(
is_deleted=False,
),
metadata=shared.AccountingAccountMetadata(),
modified_date='2022-10-23T00:00:00.000Z',
name='Accounts Receivable',
nominal_code='610',
source_modified_date='2022-10-23T00:00:00.000Z',
status=shared.AccountStatus.ACTIVE,
supplemental_data=shared.SupplementalData(
content={
"Gasoline": {
"Wall": 'Oriental',
},
},
),
type=shared.AccountType.ASSET,
valid_datatype_links=[
shared.AccountingAccountValidDataTypeLinks(
links=[
'unde',
'Intranet',
],
property='nulla',
),
],
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
)

res = s.accounting_accounts.create_accounting_account(req)

if res.accounting_create_account_response is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->

Expand Down Expand Up @@ -154,16 +155,16 @@ if res.accounting_create_account_response is not None:

### [company_management](docs/sdks/companymanagement/README.md)

* [create_company](docs/sdks/companymanagement/README.md#create_company) - Create Sync for Commerce company
* [create_company](docs/sdks/companymanagement/README.md#create_company) - Create sync for commerce company
* [create_connection](docs/sdks/companymanagement/README.md#create_connection) - Create connection
* [list_companies](docs/sdks/companymanagement/README.md#list_companies) - List companies
* [list_connections](docs/sdks/companymanagement/README.md#list_connections) - List data connections
* [update_connection](docs/sdks/companymanagement/README.md#update_connection) - Update data connection

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

* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company.
* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration.
* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company
* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration

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

Expand All @@ -174,7 +175,7 @@ if res.accounting_create_account_response is not None:
### [integrations](docs/sdks/integrations/README.md)

* [get_integration_branding](docs/sdks/integrations/README.md#get_integration_branding) - Get branding for an integration
* [list_integrations](docs/sdks/integrations/README.md#list_integrations) - List information on Codat's supported integrations
* [list_integrations](docs/sdks/integrations/README.md#list_integrations) - List integrations

### [push_data](docs/sdks/pushdata/README.md)

Expand All @@ -197,10 +198,22 @@ if res.accounting_create_account_response is not None:

### [sync_flow_preferences](docs/sdks/syncflowpreferences/README.md)

* [get_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on Sync Flow
* [get_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on sync flow
* [get_sync_flow_url](docs/sdks/syncflowpreferences/README.md#get_sync_flow_url) - Retrieve sync flow url
* [get_visible_accounts](docs/sdks/syncflowpreferences/README.md#get_visible_accounts) - List visible accounts
* [update_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#update_config_text_sync_flow) - Update preferences for text fields on sync flow
* [update_visible_accounts_sync_flow](docs/sdks/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on Sync Flow
* [update_visible_accounts_sync_flow](docs/sdks/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on sync flow
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->



<!-- End Dev Containers -->

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


### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
11 changes: 11 additions & 0 deletions previous-versions/sync-for-commerce-version-1/RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@


## 2023-10-17 14:13:25
### Changes
Based on:
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce-v1.yaml
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.2.0] previous-versions/sync-for-commerce-version-1
### Releases
- [PyPI v0.2.0] https://pypi.org/project/codat-sync-for-commerce-version-1/0.2.0 - previous-versions/sync-for-commerce-version-1
21 changes: 12 additions & 9 deletions previous-versions/sync-for-commerce-version-1/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,42 @@ s = codatsynccommerce.CodatSyncCommerce(

req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
currency='USD',
currency='GBP',
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.AccountingAccountMetadata(
is_deleted=False,
),
metadata=shared.AccountingAccountMetadata(),
modified_date='2022-10-23T00:00:00.000Z',
name='Accounts Receivable',
nominal_code='610',
source_modified_date='2022-10-23T00:00:00.000Z',
status=shared.AccountStatus.ACTIVE,
supplemental_data=shared.SupplementalData(
content={
"Gasoline": {
"Wall": 'Oriental',
},
},
),
type=shared.AccountType.ASSET,
valid_datatype_links=[
shared.AccountingAccountValidDataTypeLinks(
links=[
'unde',
'Intranet',
],
property='nulla',
),
],
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
)

res = s.accounting_accounts.create_accounting_account(req)

if res.accounting_create_account_response is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.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 | |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *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 @@ -6,7 +6,7 @@
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `accounting_create_account_response` | [Optional[shared.AccountingCreateAccountResponse]](../../models/shared/accountingcreateaccountresponse.md) | :heavy_minus_sign: | Success |
| `content_type` | *str* | :heavy_check_mark: | N/A |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `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 |
| `status_code` | *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 |
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `accounting_credit_note` | [Optional[shared.AccountingCreditNote]](../../models/shared/accountingcreditnote.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 | |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *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. | |
Loading