It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- 🛠 Make your SDK feel handcrafted by customizing it
- ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
- 🎁 Publish your SDK to package managers by configuring automatic publishing
- ✨ When ready to productionize, delete this section from the README
Panora API: A unified API to ship integrations
- SDK Installation
- IDE Support
- SDK Example Usage
- Available Resources and Operations
- Pagination
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
PIP
pip install panora-sdkPoetry
poetry add panora-sdkGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from panora_sdk import Panora
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
passThe same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from panora_sdk import Panora
async def main():
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = await s.hello_async()
if res is not None:
# handle response
pass
asyncio.run(main())- query - Query using RAG Search
- sign_in - Log In
- list - List Connections
- list - List webhooks
- create - Create webhook
- delete - Delete Webhook
- update_status - Update webhook status
- verify_event - Verify payload signature of the webhook
- status - Retrieve sync status of a certain vertical
- resync - Resync common objects across a vertical
- update_pull_frequency - Update pull frequency for verticals
- get_pull_frequency - Get pull frequency for verticals
- create - Create Linked Users
- list - List Linked Users
- import_batch - Add Batch Linked Users
- retrieve - Retrieve Linked Users
- remote_id - Retrieve a Linked User From A Remote Id
- get_projects - Retrieve projects
- create - Create a project
- get_field_mapping_values - Retrieve field mappings values
- get_field_mappings_entities - Retrieve field mapping entities
- get_field_mappings - Retrieve field mappings
- definitions - Define target Field
- define_custom_field - Create Custom Field
- map - Map Custom Field
- get_panora_core_events - List Events
- request - Make a passthrough request
- get_retried_request_response - Retrieve response of a failed passthrough request due to rate limits
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from panora.utils import BackoffStrategy, RetryConfig
from panora_sdk import Panora
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res is not None:
# handle response
passIf 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:
from panora.utils import BackoffStrategy, RetryConfig
from panora_sdk import Panora
s = Panora(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
passHandling 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 |
|---|---|---|
| models.SDKError | 4xx-5xx | / |
from panora_sdk import Panora, models
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = None
try:
res = s.hello()
except models.SDKError as e:
# handle exception
raise(e)
if res is not None:
# handle response
passYou 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.panora.dev |
None |
| 1 | https://api-sandbox.panora.dev |
None |
| 2 | https://api-dev.panora.dev |
None |
from panora_sdk import Panora
s = Panora(
server_idx=2,
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
passThe 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:
from panora_sdk import Panora
s = Panora(
server_url="https://api.panora.dev",
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
passThe Python SDK makes API calls using the httpx 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 your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from panora_sdk import Panora
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Panora(client=http_client)or you could wrap the client with your own custom logic:
from panora_sdk import Panora
from panora_sdk.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Panora(async_client=CustomClient(httpx.AsyncClient()))To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
from panora_sdk import Panora
import logging
logging.basicConfig(level=logging.DEBUG)
s = Panora(debug_logger=logging.getLogger("panora_sdk"))This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
api_key |
apiKey | API key |
To authenticate with the API the null parameter must be set when initializing the SDK client instance. For example:
from panora_sdk import Panora
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
passSome of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next method that can be called to pull down the next group of results. If the
return value of Next is None, then there are no more pages to be fetched.
Here's an example of one such pagination call:
from panora_sdk import Panora
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = s.filestorage.files.list(x_connection_token="<value>", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874")
if res is not None:
while True:
# handle items
res = res.Next()
if res is None:
break
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.
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. 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.