Skip to content

Latest commit

 

History

History
166 lines (106 loc) · 6.74 KB

README.md

File metadata and controls

166 lines (106 loc) · 6.74 KB
Raw

Sync

(sync)

Available Operations

status

Retrieve sync status of a certain vertical

Example Usage

import panora_sdk
from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


s.sync.status(vertical=panora_sdk.PathParamVertical.TICKETING)

# Use the SDK ...

Parameters

Parameter Type Required Description Example
vertical models.PathParamVertical ✔️ N/A ticketing
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

resync

Resync common objects across a vertical

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.sync.resync()

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ResyncStatusDto

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

update_pull_frequency

Update pull frequency for verticals

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.sync.update_pull_frequency(request={
    "crm": 1800,
    "ats": 3600,
    "hris": 7200,
    "accounting": 14400,
    "filestorage": 28800,
    "ecommerce": 43200,
    "ticketing": 86400,
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request models.UpdatePullFrequencyDto ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdatePullFrequencyResponseBody

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

get_pull_frequency

Get pull frequency for verticals

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.sync.get_pull_frequency()

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdatePullFrequencyDto

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /