Python Client SDK for Unified.to

Navigation

Verified details  (What is this?)

These details have been verified by PyPI
Maintainers
Avatar for unified from gravatar.com unified

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Unified API Inc
  • Requires: Python >=3.8
  • Provides-Extra: dev

Project description

SDK Installation

pip install Unified-python-sdk

SDK Example Usage

Example

import unified_to
from unified_to.models import operations, shared

s = unified_to.UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
)

res = s.accounting.create_accounting_account(request=operations.CreateAccountingAccountRequest(
    connection_id='<value>',
))

if res.accounting_account is not None:
    # handle response
    pass

Available Resources and Operations

accounting

account

contact

invoice

organization

taxrate

transaction

ats

activity

application

applicationstatus

candidate

company

document

interview

job

scorecard

commerce

collection

inventory

item

location

crm

deal

event

lead

pipeline

enrich

person

genai

model

prompt

hris

employee

group

payslip

timeoff

martech

list

member

passthrough

payment

link

payout

refund

storage

file

ticketing

customer

note

ticket

uc

call

unified

apicall

connection

integration

auth

login

issue

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 4xx-5xx /

Example

import unified_to
from unified_to.models import errors, operations, shared

s = unified_to.UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
)

res = None
try:
    res = s.accounting.create_accounting_account(request=operations.CreateAccountingAccountRequest(
    connection_id='<value>',
))
except errors.SDKError as 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 unified_to
from unified_to.models import operations, shared

s = unified_to.UnifiedTo(
    server_idx=1,
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
)

res = s.accounting.create_accounting_account(request=operations.CreateAccountingAccountRequest(
    connection_id='<value>',
))

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 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>",
    ),
)

res = s.accounting.create_accounting_account(request=operations.CreateAccountingAccountRequest(
    connection_id='<value>',
))

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 unified_to
from unified_to.models import operations, shared

s = unified_to.UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
)

res = s.accounting.create_accounting_account(request=operations.CreateAccountingAccountRequest(
    connection_id='<value>',
))

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!

SDK Created by Speakeasy

Project details

Verified details  (What is this?)

These details have been verified by PyPI
Maintainers
Avatar for unified from gravatar.com unified

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Unified API Inc
  • Requires: Python >=3.8
  • Provides-Extra: dev

Release history Release notifications | RSS feed

0.24.0

0.23.24

0.23.23

0.23.22

0.23.21

0.23.20

0.23.19

0.23.18

0.23.17

0.23.16

0.23.15

0.23.14

0.23.13

0.23.12

0.23.11

0.23.10

0.23.9

0.23.8

0.23.7

0.23.6

0.23.5

0.23.4

0.23.3

0.23.2

0.23.1

0.23.0

0.22.33

0.22.32

0.22.31

0.22.30

0.22.29

0.22.28

0.22.27

0.22.26

0.22.25

0.22.24

0.22.23

0.22.22

0.22.21

0.22.20

0.22.19

0.22.18

0.22.17

0.22.16

0.22.15

0.22.14

0.22.13

0.22.12

0.22.11

0.22.10

0.22.9

0.22.8

0.22.7

0.22.6

This version

0.22.5

0.22.4

0.22.3

0.22.2

0.22.1

0.22.0

0.21.11

0.21.10

0.21.9

0.21.8

0.21.7

0.21.6

0.21.5

0.21.4

0.21.3

0.21.2

0.21.1

0.21.0

0.20.6

0.20.5

0.20.4

0.20.3

0.20.2

0.20.1

0.20.0

0.19.2

0.19.1

0.19.0

0.18.1

0.18.0

0.17.1

0.17.0

0.16.11

0.16.10

0.16.9

0.16.8

0.16.7

0.16.6

0.16.5

0.16.4

0.16.3

0.16.2

0.16.1

0.16.0

0.15.0

0.14.38

0.14.36

0.14.35

0.14.34

0.14.33

0.14.32

0.14.31

0.14.30

0.14.29

0.14.28

0.14.27

0.14.26

0.14.25

0.14.24

0.14.23

0.14.22

0.14.21

0.14.20

0.14.19

0.14.18

0.14.17

0.14.16

0.14.15

0.14.14

0.14.13

0.14.12

0.14.11

0.14.10

0.14.9

0.14.8

0.14.7

0.14.6

0.14.5

0.14.4

0.14.3

0.14.2

0.14.1

0.14.0

0.13.16

0.13.15

0.13.14

0.13.13

0.13.12

0.13.11

0.13.10

0.13.9

0.13.8

0.13.7

0.13.6

0.13.5

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Unified-python-sdk-0.22.5.tar.gz (126.2 kB view hashes)

Uploaded Source

Built Distribution

Unified_python_sdk-0.22.5-py3-none-any.whl (402.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page