|
3 | 3 |
|
4 | 4 |
|
5 | 5 | <!-- Start SDK Installation --> |
6 | | -replace me |
| 6 | +## SDK Installation |
| 7 | + |
| 8 | +```bash |
| 9 | +pip install codat-platform |
| 10 | +``` |
7 | 11 | <!-- End SDK Installation --> |
8 | 12 |
|
9 | 13 | ## Example Usage |
10 | 14 | <!-- Start SDK Example Usage --> |
11 | | -replace me |
| 15 | + |
| 16 | + |
| 17 | +```python |
| 18 | +import codatplatform |
| 19 | +from codatplatform.models import shared |
| 20 | + |
| 21 | +s = codatplatform.CodatPlatform( |
| 22 | + security=shared.Security( |
| 23 | + auth_header="", |
| 24 | + ), |
| 25 | +) |
| 26 | + |
| 27 | +req = shared.CompanyRequestBody( |
| 28 | + description='Requested early access to the new financing scheme.', |
| 29 | + name='Bank of Dave', |
| 30 | +) |
| 31 | + |
| 32 | +res = s.companies.create(req) |
| 33 | + |
| 34 | +if res.company is not None: |
| 35 | + # handle response |
| 36 | +``` |
12 | 37 | <!-- End SDK Example Usage --> |
13 | 38 |
|
14 | 39 | <!-- Start SDK Available Operations --> |
15 | | -replace me |
| 40 | +## Available Resources and Operations |
| 41 | + |
| 42 | + |
| 43 | +### [companies](docs/sdks/companies/README.md) |
| 44 | + |
| 45 | +* [create](docs/sdks/companies/README.md#create) - Create company |
| 46 | +* [delete](docs/sdks/companies/README.md#delete) - Delete a company |
| 47 | +* [get](docs/sdks/companies/README.md#get) - Get company |
| 48 | +* [list](docs/sdks/companies/README.md#list) - List companies |
| 49 | +* [update](docs/sdks/companies/README.md#update) - Update company |
| 50 | + |
| 51 | +### [connections](docs/sdks/connections/README.md) |
| 52 | + |
| 53 | +* [create](docs/sdks/connections/README.md#create) - Create connection |
| 54 | +* [delete](docs/sdks/connections/README.md#delete) - Delete connection |
| 55 | +* [get](docs/sdks/connections/README.md#get) - Get connection |
| 56 | +* [list](docs/sdks/connections/README.md#list) - List connections |
| 57 | +* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection |
| 58 | +* [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization |
| 59 | + |
| 60 | +### [integrations](docs/sdks/integrations/README.md) |
| 61 | + |
| 62 | +* [get](docs/sdks/integrations/README.md#get) - Get integration |
| 63 | +* [get_branding](docs/sdks/integrations/README.md#get_branding) - Get branding |
| 64 | +* [list](docs/sdks/integrations/README.md#list) - List integrations |
| 65 | + |
| 66 | +### [push_data](docs/sdks/pushdata/README.md) |
| 67 | + |
| 68 | +* [get_model_options](docs/sdks/pushdata/README.md#get_model_options) - Get push options |
| 69 | +* [get_operation](docs/sdks/pushdata/README.md#get_operation) - Get push operation |
| 70 | +* [list_operations](docs/sdks/pushdata/README.md#list_operations) - List push operations |
| 71 | + |
| 72 | +### [refresh_data](docs/sdks/refreshdata/README.md) |
| 73 | + |
| 74 | +* [all](docs/sdks/refreshdata/README.md#all) - Refresh all data |
| 75 | +* [by_data_type](docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type |
| 76 | +* [get](docs/sdks/refreshdata/README.md#get) - Get data status |
| 77 | +* [get_pull_operation](docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation |
| 78 | +* [list_pull_operations](docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations |
| 79 | + |
| 80 | +### [settings](docs/sdks/settings/README.md) |
| 81 | + |
| 82 | +* [create_api_key](docs/sdks/settings/README.md#create_api_key) - Create API key |
| 83 | +* [delete_api_key](docs/sdks/settings/README.md#delete_api_key) - Delete api key |
| 84 | +* [~~get_profile~~](docs/sdks/settings/README.md#get_profile) - Get profile :warning: **Deprecated** |
| 85 | +* [get_sync_settings](docs/sdks/settings/README.md#get_sync_settings) - Get sync settings |
| 86 | +* [list_api_keys](docs/sdks/settings/README.md#list_api_keys) - List API keys |
| 87 | +* [update_profile](docs/sdks/settings/README.md#update_profile) - Update profile |
| 88 | +* [update_sync_settings](docs/sdks/settings/README.md#update_sync_settings) - Update all sync settings |
| 89 | + |
| 90 | +### [supplemental_data](docs/sdks/supplementaldata/README.md) |
| 91 | + |
| 92 | +* [configure](docs/sdks/supplementaldata/README.md#configure) - Configure |
| 93 | +* [get_configuration](docs/sdks/supplementaldata/README.md#get_configuration) - Get configuration |
| 94 | + |
| 95 | +### [webhooks](docs/sdks/webhooks/README.md) |
| 96 | + |
| 97 | +* [create](docs/sdks/webhooks/README.md#create) - Create webhook |
| 98 | +* [get](docs/sdks/webhooks/README.md#get) - Get webhook |
| 99 | +* [list](docs/sdks/webhooks/README.md#list) - List webhooks |
16 | 100 | <!-- End SDK Available Operations --> |
17 | 101 | ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments