SDK Installation
pip install Unified-python-sdk
SDK Example Usage
Example
import dateutil.parser
import unified_to
from unified_to.models import operations, shared
s = unified_to.UnifiedTo(
security=shared.Security(
jwt="<YOUR_API_KEY_HERE>",
),
)
req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
name='string',
raw=shared.PropertyAccountingAccountRaw(),
),
connection_id='string',
)
res = s.accounting.create_accounting_account(req)
if res.accounting_account is not None:
# handle response
pass
Available Resources and Operations
accounting
account
customer
invoice
item
organization
payment
taxrate
transaction
ats
application
applicationstatus
candidate
document
interview
job
scorecard
crm
company
contact
deal
event
lead
pipeline
enrich
person
hris
employee
group
martech
list
member
passthrough
storage
file
ticketing
note
ticket
uc
call
unified
apicall
connection
integration
auth
login
webhook
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4x-5xx | / |
Example
import dateutil.parser
import unified_to
from unified_to.models import operations, shared
s = unified_to.UnifiedTo(
security=shared.Security(
jwt="<YOUR_API_KEY_HERE>",
),
)
req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
name='string',
raw=shared.PropertyAccountingAccountRaw(),
),
connection_id='string',
)
res = None
try:
res = s.accounting.create_accounting_account(req)
except errors.SDKError as e:
print(e) # handle exception
raise(e)
if res.accounting_account is not None:
# handle response
pass
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.unified.to |
None |
1 | https://api-eu.unified.to |
None |
Example
import dateutil.parser
import unified_to
from unified_to.models import operations, shared
s = unified_to.UnifiedTo(
server_idx=1,
security=shared.Security(
jwt="<YOUR_API_KEY_HERE>",
),
)
req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
name='string',
raw=shared.PropertyAccountingAccountRaw(),
),
connection_id='string',
)
res = s.accounting.create_accounting_account(req)
if res.accounting_account is not None:
# handle response
pass
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
import dateutil.parser
import unified_to
from unified_to.models import operations, shared
s = unified_to.UnifiedTo(
server_url="https://api.unified.to",
security=shared.Security(
jwt="<YOUR_API_KEY_HERE>",
),
)
req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
name='string',
raw=shared.PropertyAccountingAccountRaw(),
),
connection_id='string',
)
res = s.accounting.create_accounting_account(req)
if res.accounting_account is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import unified_to
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = unified_to.UnifiedTo(client: http_client)
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
jwt |
apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import dateutil.parser
import unified_to
from unified_to.models import operations, shared
s = unified_to.UnifiedTo(
security=shared.Security(
jwt="<YOUR_API_KEY_HERE>",
),
)
req = operations.CreateAccountingAccountRequest(
accounting_account=shared.AccountingAccount(
name='string',
raw=shared.PropertyAccountingAccountRaw(),
),
connection_id='string',
)
res = s.accounting.create_accounting_account(req)
if res.accounting_account is not None:
# handle response
pass
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we’ll do our best to include it in a future release!