You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -47,10 +47,6 @@ For more information about the API: [Apideck Developer Docs](https://developers.
47
47
<!-- Start SDK Installation [installation] -->
48
48
## SDK Installation
49
49
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
-
54
50
> [!NOTE]
55
51
> **Python version upgrade policy**
56
52
>
@@ -63,23 +59,23 @@ The SDK can be installed with either *pip* or *poetry* package managers.
63
59
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
64
60
65
61
```bash
66
-
pip install git+<UNSET>.git
62
+
pip install apideck-accounting-unify
67
63
```
68
64
69
65
### Poetry
70
66
71
67
*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.
72
68
73
69
```bash
74
-
poetry add git+<UNSET>.git
70
+
poetry add apideck-accounting-unify
75
71
```
76
72
77
73
### Shell and script usage with `uv`
78
74
79
75
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:
80
76
81
77
```shell
82
-
uvx --from apideck-unify python
78
+
uvx --from apideck-accounting-unify python
83
79
```
84
80
85
81
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
89
85
# /// script
90
86
# requires-python = ">=3.9"
91
87
# dependencies = [
92
-
# "apideck-unify",
88
+
# "apideck-accounting-unify",
93
89
# ]
94
90
# ///
95
91
96
-
fromapideck_unifyimport Apideck
92
+
fromapideck_accounting_unifyimport Apideck
97
93
98
94
sdk = Apideck(
99
95
# SDK arguments
@@ -123,7 +119,7 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
123
119
124
120
```python
125
121
# Synchronous Example
126
-
fromapideck_unifyimport Apideck
122
+
fromapideck_accounting_unifyimport Apideck
127
123
import os
128
124
129
125
@@ -146,7 +142,7 @@ with Apideck(
146
142
The same SDK client can also be used to make asychronous requests by importing asyncio.
147
143
```python
148
144
# Asynchronous Example
149
-
fromapideck_unifyimport Apideck
145
+
fromapideck_accounting_unifyimport Apideck
150
146
import asyncio
151
147
import os
152
148
@@ -182,7 +178,7 @@ This SDK supports the following security scheme globally:
182
178
183
179
To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
184
180
```python
185
-
fromapideck_unifyimport Apideck
181
+
fromapideck_accounting_unifyimport Apideck
186
182
import os
187
183
188
184
@@ -390,8 +386,8 @@ return value of `Next` is `None`, then there are no more pages to be fetched.
390
386
391
387
Here's an example of one such pagination call:
392
388
```python
393
-
importapideck_unify
394
-
fromapideck_unifyimport Apideck
389
+
importapideck_accounting_unify
390
+
fromapideck_accounting_unifyimport Apideck
395
391
import os
396
392
397
393
@@ -401,7 +397,7 @@ with Apideck(
401
397
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
402
398
) as apideck:
403
399
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")
405
401
406
402
while res isnotNone:
407
403
# Handle items
@@ -418,8 +414,8 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
418
414
419
415
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
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:
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:
540
536
```python
541
-
fromapideck_unifyimport Apideck
537
+
fromapideck_accounting_unifyimport Apideck
542
538
import os
543
539
544
540
@@ -568,7 +564,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
568
564
569
565
For example, you could specify a header for every request that this sdk makes as follows:
@@ -679,11 +675,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
679
675
680
676
You can pass your own logger class directly into your SDK.
681
677
```python
682
-
fromapideck_unifyimport Apideck
678
+
fromapideck_accounting_unifyimport Apideck
683
679
import logging
684
680
685
681
logging.basicConfig(level=logging.DEBUG)
686
-
s = Apideck(debug_logger=logging.getLogger("apideck_unify"))
682
+
s = Apideck(debug_logger=logging.getLogger("apideck_accounting_unify"))
687
683
```
688
684
689
685
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.
704
700
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.
705
701
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.
706
702
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)
0 commit comments