Skip to content

Commit a103e2b

Browse files
committed
update readme
1 parent 4182e52 commit a103e2b

File tree

342 files changed

+1125
-1084
lines changed

Some content is hidden

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

342 files changed

+1125
-1084
lines changed

.speakeasy/workflow.lock

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ speakeasyVersion: 1.523.2
22
sources:
33
accounting:
44
sourceNamespace: apideck-accounting-only-oas
5-
sourceRevisionDigest: sha256:90d075b4de4323fc8e1c8b2b2404ac8b48a366b7457fe2adff7a52199afd4c25
5+
sourceRevisionDigest: sha256:da2fb1c25f6e49afaac1e59d0e15ba472fb9ed71cdb1fa415f62888b514325b4
66
sourceBlobDigest: sha256:6d730e4fc04f1f82cc3401f99edab1f888d699a469e32a9ad951a53be8913b0e
77
tags:
88
- latest
@@ -18,10 +18,10 @@ targets:
1818
accounting-py:
1919
source: accounting
2020
sourceNamespace: apideck-accounting-only-oas
21-
sourceRevisionDigest: sha256:90d075b4de4323fc8e1c8b2b2404ac8b48a366b7457fe2adff7a52199afd4c25
21+
sourceRevisionDigest: sha256:da2fb1c25f6e49afaac1e59d0e15ba472fb9ed71cdb1fa415f62888b514325b4
2222
sourceBlobDigest: sha256:6d730e4fc04f1f82cc3401f99edab1f888d699a469e32a9ad951a53be8913b0e
2323
codeSamplesNamespace: apideck-accounting-only-oas-python-code-samples
24-
codeSamplesRevisionDigest: sha256:f2ed0e1606ed28e17ae9a673a68b7b8b190caefab1784c501b0fe80b9d9bc31e
24+
codeSamplesRevisionDigest: sha256:fce1be86a0a48ada39015f31219a0e617a341ec02e321503d1a7c351dd7c7f4f
2525
accounting-ts:
2626
source: accounting
2727
sourceNamespace: accounting
@@ -51,6 +51,9 @@ workflow:
5151
target: python
5252
source: accounting
5353
output: ./accounting
54+
publish:
55+
pypi:
56+
token: $pypi_token
5457
codeSamples:
5558
registry:
5659
location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck-accounting-only-oas-python-code-samples

accounting/.speakeasy/gen.lock

Lines changed: 307 additions & 306 deletions
Large diffs are not rendered by default.

accounting/.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ generation:
1818
oAuth2ClientCredentialsEnabled: true
1919
oAuth2PasswordEnabled: true
2020
python:
21-
version: 0.9.0
21+
version: 0.9.2
2222
additionalDependencies:
2323
dev: {}
2424
main: {}

accounting/README.md

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# openapi
1+
# apideck-accounting-unify
22

3-
Developer-friendly & type-safe Python SDK specifically catered to leverage *openapi* API.
3+
Developer-friendly & type-safe Python SDK specifically catered to leverage *apideck-accounting-unify* API.
44

55
<div align="left">
6-
<a href="https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
6+
<a href="https://www.speakeasy.com/?utm_source=apideck-accounting-unify&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
77
<a href="https://opensource.org/licenses/MIT">
88
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
99
</a>
@@ -25,7 +25,7 @@ For more information about the API: [Apideck Developer Docs](https://developers.
2525
<!-- Start Table of Contents [toc] -->
2626
## Table of Contents
2727
<!-- $toc-max-depth=2 -->
28-
* [openapi](#openapi)
28+
* [apideck-accounting-unify](#apideck-accounting-unify)
2929
* [SDK Installation](#sdk-installation)
3030
* [IDE Support](#ide-support)
3131
* [SDK Example Usage](#sdk-example-usage)
@@ -47,10 +47,6 @@ For more information about the API: [Apideck Developer Docs](https://developers.
4747
<!-- Start SDK Installation [installation] -->
4848
## SDK Installation
4949

50-
> [!TIP]
51-
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
52-
53-
5450
> [!NOTE]
5551
> **Python version upgrade policy**
5652
>
@@ -63,23 +59,23 @@ The SDK can be installed with either *pip* or *poetry* package managers.
6359
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
6460

6561
```bash
66-
pip install git+<UNSET>.git
62+
pip install apideck-accounting-unify
6763
```
6864

6965
### Poetry
7066

7167
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
7268

7369
```bash
74-
poetry add git+<UNSET>.git
70+
poetry add apideck-accounting-unify
7571
```
7672

7773
### Shell and script usage with `uv`
7874

7975
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
8076

8177
```shell
82-
uvx --from apideck-unify python
78+
uvx --from apideck-accounting-unify python
8379
```
8480

8581
It's also possible to write a standalone Python script without needing to set up a whole project like so:
@@ -89,11 +85,11 @@ It's also possible to write a standalone Python script without needing to set up
8985
# /// script
9086
# requires-python = ">=3.9"
9187
# dependencies = [
92-
# "apideck-unify",
88+
# "apideck-accounting-unify",
9389
# ]
9490
# ///
9591

96-
from apideck_unify import Apideck
92+
from apideck_accounting_unify import Apideck
9793

9894
sdk = Apideck(
9995
# SDK arguments
@@ -123,7 +119,7 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
123119

124120
```python
125121
# Synchronous Example
126-
from apideck_unify import Apideck
122+
from apideck_accounting_unify import Apideck
127123
import os
128124

129125

@@ -146,7 +142,7 @@ with Apideck(
146142
The same SDK client can also be used to make asychronous requests by importing asyncio.
147143
```python
148144
# Asynchronous Example
149-
from apideck_unify import Apideck
145+
from apideck_accounting_unify import Apideck
150146
import asyncio
151147
import os
152148

@@ -182,7 +178,7 @@ This SDK supports the following security scheme globally:
182178

183179
To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
184180
```python
185-
from apideck_unify import Apideck
181+
from apideck_accounting_unify import Apideck
186182
import os
187183

188184

@@ -390,8 +386,8 @@ return value of `Next` is `None`, then there are no more pages to be fetched.
390386

391387
Here's an example of one such pagination call:
392388
```python
393-
import apideck_unify
394-
from apideck_unify import Apideck
389+
import apideck_accounting_unify
390+
from apideck_accounting_unify import Apideck
395391
import os
396392

397393

@@ -401,7 +397,7 @@ with Apideck(
401397
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
402398
) as apideck:
403399

404-
res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
400+
res = apideck.accounting.attachments.list(reference_type=apideck_accounting_unify.AttachmentReferenceType.INVOICE, reference_id="123456", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
405401

406402
while res is not None:
407403
# Handle items
@@ -418,8 +414,8 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
418414

419415
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
420416
```python
421-
from apideck_unify import Apideck
422-
from apideck_unify.utils import BackoffStrategy, RetryConfig
417+
from apideck_accounting_unify import Apideck
418+
from apideck_accounting_unify.utils import BackoffStrategy, RetryConfig
423419
import os
424420

425421

@@ -441,8 +437,8 @@ with Apideck(
441437

442438
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:
443439
```python
444-
from apideck_unify import Apideck
445-
from apideck_unify.utils import BackoffStrategy, RetryConfig
440+
from apideck_accounting_unify import Apideck
441+
from apideck_accounting_unify.utils import BackoffStrategy, RetryConfig
446442
import os
447443

448444

@@ -491,7 +487,7 @@ When custom error responses are specified for an operation, the SDK may also rai
491487
### Example
492488

493489
```python
494-
from apideck_unify import Apideck, models
490+
from apideck_accounting_unify import Apideck, models
495491
import os
496492

497493

@@ -538,7 +534,7 @@ with Apideck(
538534

539535
The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
540536
```python
541-
from apideck_unify import Apideck
537+
from apideck_accounting_unify import Apideck
542538
import os
543539

544540

@@ -568,7 +564,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
568564

569565
For example, you could specify a header for every request that this sdk makes as follows:
570566
```python
571-
from apideck_unify import Apideck
567+
from apideck_accounting_unify import Apideck
572568
import httpx
573569

574570
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
@@ -577,8 +573,8 @@ s = Apideck(client=http_client)
577573

578574
or you could wrap the client with your own custom logic:
579575
```python
580-
from apideck_unify import Apideck
581-
from apideck_unify.httpclient import AsyncHttpClient
576+
from apideck_accounting_unify import Apideck
577+
from apideck_accounting_unify.httpclient import AsyncHttpClient
582578
import httpx
583579

584580
class CustomClient(AsyncHttpClient):
@@ -648,7 +644,7 @@ The `Apideck` class implements the context manager protocol and registers a fina
648644
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
649645

650646
```python
651-
from apideck_unify import Apideck
647+
from apideck_accounting_unify import Apideck
652648
import os
653649
def main():
654650

@@ -679,11 +675,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
679675

680676
You can pass your own logger class directly into your SDK.
681677
```python
682-
from apideck_unify import Apideck
678+
from apideck_accounting_unify import Apideck
683679
import logging
684680

685681
logging.basicConfig(level=logging.DEBUG)
686-
s = Apideck(debug_logger=logging.getLogger("apideck_unify"))
682+
s = Apideck(debug_logger=logging.getLogger("apideck_accounting_unify"))
687683
```
688684

689685
You can also enable a default debug logger by setting an environment variable `APIDECK_DEBUG` to true.
@@ -704,4 +700,4 @@ looking for the latest version.
704700
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
705701
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
706702

707-
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python)
703+
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=apideck-accounting-unify&utm_campaign=python)

accounting/USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Start SDK Example Usage [usage] -->
22
```python
33
# Synchronous Example
4-
from apideck_unify import Apideck
4+
from apideck_accounting_unify import Apideck
55
import os
66

77

@@ -24,7 +24,7 @@ with Apideck(
2424
The same SDK client can also be used to make asychronous requests by importing asyncio.
2525
```python
2626
# Asynchronous Example
27-
from apideck_unify import Apideck
27+
from apideck_accounting_unify import Apideck
2828
import asyncio
2929
import os
3030

accounting/docs/sdks/ageddebtorssdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Get Aged Debtors
1414
### Example Usage
1515

1616
```python
17-
from apideck_unify import Apideck
17+
from apideck_accounting_unify import Apideck
1818
import os
1919

2020

accounting/docs/sdks/attachments/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ List Attachments
1717
### Example Usage
1818

1919
```python
20-
import apideck_unify
21-
from apideck_unify import Apideck
20+
import apideck_accounting_unify
21+
from apideck_accounting_unify import Apideck
2222
import os
2323

2424

@@ -28,7 +28,7 @@ with Apideck(
2828
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
2929
) as apideck:
3030

31-
res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
31+
res = apideck.accounting.attachments.list(reference_type=apideck_accounting_unify.AttachmentReferenceType.INVOICE, reference_id="123456", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
3232

3333
while res is not None:
3434
# Handle items
@@ -74,8 +74,8 @@ Get Attachment
7474
### Example Usage
7575

7676
```python
77-
import apideck_unify
78-
from apideck_unify import Apideck
77+
import apideck_accounting_unify
78+
from apideck_accounting_unify import Apideck
7979
import os
8080

8181

@@ -85,7 +85,7 @@ with Apideck(
8585
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
8686
) as apideck:
8787

88-
res = apideck.accounting.attachments.get(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
88+
res = apideck.accounting.attachments.get(reference_type=apideck_accounting_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
8989

9090
assert res.get_attachment_response is not None
9191

@@ -130,8 +130,8 @@ Delete Attachment
130130
### Example Usage
131131

132132
```python
133-
import apideck_unify
134-
from apideck_unify import Apideck
133+
import apideck_accounting_unify
134+
from apideck_accounting_unify import Apideck
135135
import os
136136

137137

@@ -141,7 +141,7 @@ with Apideck(
141141
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
142142
) as apideck:
143143

144-
res = apideck.accounting.attachments.delete(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce")
144+
res = apideck.accounting.attachments.delete(reference_type=apideck_accounting_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce")
145145

146146
assert res.delete_attachment_response is not None
147147

@@ -185,8 +185,8 @@ Download Attachment
185185
### Example Usage
186186

187187
```python
188-
import apideck_unify
189-
from apideck_unify import Apideck
188+
import apideck_accounting_unify
189+
from apideck_accounting_unify import Apideck
190190
import os
191191

192192

@@ -196,7 +196,7 @@ with Apideck(
196196
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
197197
) as apideck:
198198

199-
res = apideck.accounting.attachments.download(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
199+
res = apideck.accounting.attachments.download(reference_type=apideck_accounting_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at")
200200

201201
assert res.get_attachment_download_response is not None
202202

accounting/docs/sdks/balancesheetsdk/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Get BalanceSheet
1414
### Example Usage
1515

1616
```python
17-
import apideck_unify
18-
from apideck_unify import Apideck
17+
import apideck_accounting_unify
18+
from apideck_accounting_unify import Apideck
1919
import os
2020

2121

@@ -31,7 +31,7 @@ with Apideck(
3131
"start_date": "2021-01-01",
3232
"end_date": "2021-12-31",
3333
"period_count": 3,
34-
"period_type": apideck_unify.PeriodType.MONTH,
34+
"period_type": apideck_accounting_unify.PeriodType.MONTH,
3535
})
3636

3737
assert res.get_balance_sheet_response is not None

0 commit comments

Comments
 (0)