Python Client SDK for Unified.to

Navigation

Verified details

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

Summary

Unified.to API: One API to Rule Them All

Table of Contents

SDK Installation

The SDK can be installed using the pip package manager, with dependencies and metadata stored in the setup.py file.

pip install Unified-python-sdk

SDK Example Usage

Example

import unified_to
from unified_to.models import operations

s = unified_to.UnifiedTo()


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

Available methods

account

accounting

activity

apicall

application

applicationstatus

ats

auth

call

candidate

channel

collection

commerce

company

connection

contact

crm

customer

deal

document

employee

enrich

event

file

genai

group

hris

integration

interview

inventory

invoice

issue

item

job

journal

kms

lead

link

list

location

login

martech

member

message

messaging

model

note

order

organization

page

passthrough

payment

payout

payslip

person

pipeline

project

prompt

refund

scim

scorecard

space

storage

task

taxrate

ticket

ticketing

timeoff

transaction

uc

unified

user

webhook

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a errors.SDKError exception, which has the following properties:

Property Type Description
.status_code int The HTTP status code
.message str The error message
.raw_response httpx.Response The raw HTTP response
.body str The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_accounting_account method may raise the following exceptions:

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

Example

import unified_to
from unified_to.models import errors, operations

s = unified_to.UnifiedTo()

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

s = unified_to.UnifiedTo(
    server_idx=1,
)


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

s = unified_to.UnifiedTo(
    server_url="https://api.unified.to",
)


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

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

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.25.2

0.25.1

0.25.0

0.24.10

0.24.9

This version

0.24.8

0.24.7

0.24.6

0.24.5

0.24.4

0.24.3

0.24.2

0.24.1

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

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.24.8.tar.gz (161.0 kB view details)

Uploaded Source

Built Distribution

Unified_python_sdk-0.24.8-py3-none-any.whl (513.8 kB view details)

Uploaded Python 3

File details

Details for the file Unified-python-sdk-0.24.8.tar.gz.

File metadata

  • Download URL: Unified-python-sdk-0.24.8.tar.gz
  • Upload date:
  • Size: 161.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for Unified-python-sdk-0.24.8.tar.gz
Algorithm Hash digest
SHA256 679aaef51d9b3a899b8b8a3de269d350c4a788bcc0a4558f833384b0ef177ebf
MD5 e120c60cd19f3022d4e38d5446eb139a
BLAKE2b-256 62e72697d0855fb5d3e4323f09cc375021a984e01d21e2ecf81033dcf7a5e005

See more details on using hashes here.

File details

Details for the file Unified_python_sdk-0.24.8-py3-none-any.whl.

File metadata

File hashes

Hashes for Unified_python_sdk-0.24.8-py3-none-any.whl
Algorithm Hash digest
SHA256 306ffdd2762bba187bea76ed4d54a75231656d83f4f6b73165c7e85afb0aed98
MD5 fc9f6df410f6f3be1dbcc38c0dbedb3e
BLAKE2b-256 b4e79ea74aeb5b649ec5107945d9aa2943101111e3646ce684bb58cdc385b4b0

See more details on using hashes here.

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