# panora
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
## 🏗 **Welcome to your new SDK!** 🏗
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](https://www.speakeasy.com/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
<!-- Start Summary [summary] -->
## Summary
Panora API: A unified API to ship integrations
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
* [SDK Installation](#sdk-installation)
* [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Pagination](#pagination)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Debugging](#debugging)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
PIP
```bash
pip install panora-sdk
```
Poetry
```bash
poetry add panora-sdk
```
<!-- End SDK Installation [installation] -->
<!-- Start IDE Support [idesupport] -->
## IDE Support
### PyCharm
Generally, 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.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# 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
pass
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# 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())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
### [Panora SDK](docs/sdks/panora/README.md)
* [hello](docs/sdks/panora/README.md#hello)
* [health](docs/sdks/panora/README.md#health)
### [rag.query](docs/sdks/query/README.md)
* [query](docs/sdks/query/README.md#query) - Query using RAG Search
### [filestorage.files](docs/sdks/files/README.md)
* [list](docs/sdks/files/README.md#list) - List Files
* [create](docs/sdks/files/README.md#create) - Create Files
* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve Files
### [filestorage.folders](docs/sdks/folders/README.md)
* [list](docs/sdks/folders/README.md#list) - List Folders
* [create](docs/sdks/folders/README.md#create) - Create Folders
* [retrieve](docs/sdks/folders/README.md#retrieve) - Retrieve Folders
### [filestorage.groups](docs/sdks/panoragroups/README.md)
* [list](docs/sdks/panoragroups/README.md#list) - List Groups
* [retrieve](docs/sdks/panoragroups/README.md#retrieve) - Retrieve Groups
### [filestorage.users](docs/sdks/panorafilestorageusers/README.md)
* [list](docs/sdks/panorafilestorageusers/README.md#list) - List Users
* [retrieve](docs/sdks/panorafilestorageusers/README.md#retrieve) - Retrieve Users
### [auth.login](docs/sdks/login/README.md)
* [sign_in](docs/sdks/login/README.md#sign_in) - Log In
### [connections](docs/sdks/connections/README.md)
* [list](docs/sdks/connections/README.md#list) - List Connections
### [webhooks](docs/sdks/webhooks/README.md)
* [list](docs/sdks/webhooks/README.md#list) - List webhooks
* [create](docs/sdks/webhooks/README.md#create) - Create webhook
* [delete](docs/sdks/webhooks/README.md#delete) - Delete Webhook
* [update_status](docs/sdks/webhooks/README.md#update_status) - Update webhook status
* [verify_event](docs/sdks/webhooks/README.md#verify_event) - Verify payload signature of the webhook
### [ticketing.tickets](docs/sdks/tickets/README.md)
* [list](docs/sdks/tickets/README.md#list) - List Tickets
* [create](docs/sdks/tickets/README.md#create) - Create Tickets
* [retrieve](docs/sdks/tickets/README.md#retrieve) - Retrieve Tickets
### [ticketing.users](docs/sdks/users/README.md)
* [list](docs/sdks/users/README.md#list) - List Users
* [retrieve](docs/sdks/users/README.md#retrieve) - Retrieve User
### [ticketing.accounts](docs/sdks/accounts/README.md)
* [list](docs/sdks/accounts/README.md#list) - List Accounts
* [retrieve](docs/sdks/accounts/README.md#retrieve) - Retrieve Accounts
### [ticketing.contacts](docs/sdks/contacts/README.md)
* [list](docs/sdks/contacts/README.md#list) - List Contacts
* [retrieve](docs/sdks/contacts/README.md#retrieve) - Retrieve Contact
### [ticketing.collections](docs/sdks/collections/README.md)
* [list](docs/sdks/collections/README.md#list) - List Collections
* [retrieve](docs/sdks/collections/README.md#retrieve) - Retrieve Collections
### [ticketing.comments](docs/sdks/comments/README.md)
* [list](docs/sdks/comments/README.md#list) - List Comments
* [create](docs/sdks/comments/README.md#create) - Create Comments
* [retrieve](docs/sdks/comments/README.md#retrieve) - Retrieve Comment
### [ticketing.tags](docs/sdks/tags/README.md)
* [list](docs/sdks/tags/README.md#list) - List Tags
* [retrieve](docs/sdks/tags/README.md#retrieve) - Retrieve Tag
### [ticketing.teams](docs/sdks/teams/README.md)
* [list](docs/sdks/teams/README.md#list) - List Teams
* [retrieve](docs/sdks/teams/README.md#retrieve) - Retrieve Teams
### [ticketing.attachments](docs/sdks/panoraticketingattachments/README.md)
* [list](docs/sdks/panoraticketingattachments/README.md#list) - List Attachments
* [create](docs/sdks/panoraticketingattachments/README.md#create) - Create Attachments
* [retrieve](docs/sdks/panoraticketingattachments/README.md#retrieve) - Retrieve Attachments
### [sync](docs/sdks/sync/README.md)
* [status](docs/sdks/sync/README.md#status) - Retrieve sync status of a certain vertical
* [resync](docs/sdks/sync/README.md#resync) - Resync common objects across a vertical
* [update_pull_frequency](docs/sdks/sync/README.md#update_pull_frequency) - Update pull frequency for verticals
* [get_pull_frequency](docs/sdks/sync/README.md#get_pull_frequency) - Get pull frequency for verticals
### [crm.companies](docs/sdks/companies/README.md)
* [list](docs/sdks/companies/README.md#list) - List Companies
* [create](docs/sdks/companies/README.md#create) - Create Companies
* [retrieve](docs/sdks/companies/README.md#retrieve) - Retrieve Companies
### [crm.contacts](docs/sdks/panoracontacts/README.md)
* [list](docs/sdks/panoracontacts/README.md#list) - List CRM Contacts
* [create](docs/sdks/panoracontacts/README.md#create) - Create Contacts
* [retrieve](docs/sdks/panoracontacts/README.md#retrieve) - Retrieve Contacts
### [crm.deals](docs/sdks/deals/README.md)
* [list](docs/sdks/deals/README.md#list) - List Deals
* [create](docs/sdks/deals/README.md#create) - Create Deals
* [retrieve](docs/sdks/deals/README.md#retrieve) - Retrieve Deals
### [crm.engagements](docs/sdks/engagements/README.md)
* [list](docs/sdks/engagements/README.md#list) - List Engagements
* [create](docs/sdks/engagements/README.md#create) - Create Engagements
* [retrieve](docs/sdks/engagements/README.md#retrieve) - Retrieve Engagements
### [crm.notes](docs/sdks/notes/README.md)
* [list](docs/sdks/notes/README.md#list) - List Notes
* [create](docs/sdks/notes/README.md#create) - Create Notes
* [retrieve](docs/sdks/notes/README.md#retrieve) - Retrieve Notes
### [crm.stages](docs/sdks/stages/README.md)
* [list](docs/sdks/stages/README.md#list) - List Stages
* [retrieve](docs/sdks/stages/README.md#retrieve) - Retrieve Stages
### [crm.tasks](docs/sdks/tasks/README.md)
* [list](docs/sdks/tasks/README.md#list) - List Tasks
* [create](docs/sdks/tasks/README.md#create) - Create Tasks
* [retrieve](docs/sdks/tasks/README.md#retrieve) - Retrieve Tasks
### [crm.users](docs/sdks/panorausers/README.md)
* [list](docs/sdks/panorausers/README.md#list) - List Users
* [retrieve](docs/sdks/panorausers/README.md#retrieve) - Retrieve Users
### [linked_users](docs/sdks/linkedusers/README.md)
* [create](docs/sdks/linkedusers/README.md#create) - Create Linked Users
* [list](docs/sdks/linkedusers/README.md#list) - List Linked Users
* [import_batch](docs/sdks/linkedusers/README.md#import_batch) - Add Batch Linked Users
* [retrieve](docs/sdks/linkedusers/README.md#retrieve) - Retrieve Linked Users
* [remote_id](docs/sdks/linkedusers/README.md#remote_id) - Retrieve a Linked User From A Remote Id
### [projects](docs/sdks/projects/README.md)
* [get_projects](docs/sdks/projects/README.md#get_projects) - Retrieve projects
* [create](docs/sdks/projects/README.md#create) - Create a project
### [field_mappings](docs/sdks/fieldmappings/README.md)
* [get_field_mapping_values](docs/sdks/fieldmappings/README.md#get_field_mapping_values) - Retrieve field mappings values
* [get_field_mappings_entities](docs/sdks/fieldmappings/README.md#get_field_mappings_entities) - Retrieve field mapping entities
* [get_field_mappings](docs/sdks/fieldmappings/README.md#get_field_mappings) - Retrieve field mappings
* [definitions](docs/sdks/fieldmappings/README.md#definitions) - Define target Field
* [define_custom_field](docs/sdks/fieldmappings/README.md#define_custom_field) - Create Custom Field
* [map](docs/sdks/fieldmappings/README.md#map) - Map Custom Field
### [events](docs/sdks/events/README.md)
* [get_panora_core_events](docs/sdks/events/README.md#get_panora_core_events) - List Events
### [passthrough](docs/sdks/passthrough/README.md)
* [request](docs/sdks/passthrough/README.md#request) - Make a passthrough request
### [passthrough.retryid](docs/sdks/retryid/README.md)
* [get_retried_request_response](docs/sdks/retryid/README.md#get_retried_request_response) - Retrieve response of a failed passthrough request due to rate limits
### [hris.bankinfos](docs/sdks/bankinfos/README.md)
* [list](docs/sdks/bankinfos/README.md#list) - List Bank Info
* [retrieve](docs/sdks/bankinfos/README.md#retrieve) - Retrieve Bank Info
### [hris.benefits](docs/sdks/benefits/README.md)
* [list](docs/sdks/benefits/README.md#list) - List Benefits
* [retrieve](docs/sdks/benefits/README.md#retrieve) - Retrieve Benefit
### [hris.companies](docs/sdks/panoracompanies/README.md)
* [list](docs/sdks/panoracompanies/README.md#list) - List Companies
* [retrieve](docs/sdks/panoracompanies/README.md#retrieve) - Retrieve Company
### [hris.dependents](docs/sdks/dependents/README.md)
* [list](docs/sdks/dependents/README.md#list) - List Dependents
* [retrieve](docs/sdks/dependents/README.md#retrieve) - Retrieve Dependent
### [hris.employeepayrollruns](docs/sdks/employeepayrollruns/README.md)
* [list](docs/sdks/employeepayrollruns/README.md#list) - List Employee Payroll Runs
* [retrieve](docs/sdks/employeepayrollruns/README.md#retrieve) - Retrieve Employee Payroll Run
### [hris.employees](docs/sdks/employees/README.md)
* [list](docs/sdks/employees/README.md#list) - List Employees
* [create](docs/sdks/employees/README.md#create) - Create Employees
* [retrieve](docs/sdks/employees/README.md#retrieve) - Retrieve Employee
### [hris.employerbenefits](docs/sdks/employerbenefits/README.md)
* [list](docs/sdks/employerbenefits/README.md#list) - List Employer Benefits
* [retrieve](docs/sdks/employerbenefits/README.md#retrieve) - Retrieve Employer Benefit
### [hris.employments](docs/sdks/employments/README.md)
* [list](docs/sdks/employments/README.md#list) - List Employments
* [retrieve](docs/sdks/employments/README.md#retrieve) - Retrieve Employment
### [hris.groups](docs/sdks/groups/README.md)
* [list](docs/sdks/groups/README.md#list) - List Groups
* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve Group
### [hris.locations](docs/sdks/locations/README.md)
* [list](docs/sdks/locations/README.md#list) - List Locations
* [retrieve](docs/sdks/locations/README.md#retrieve) - Retrieve Location
### [hris.paygroups](docs/sdks/paygroups/README.md)
* [list](docs/sdks/paygroups/README.md#list) - List Pay Groups
* [retrieve](docs/sdks/paygroups/README.md#retrieve) - Retrieve Pay Group
### [hris.payrollruns](docs/sdks/payrollruns/README.md)
* [list](docs/sdks/payrollruns/README.md#list) - List Payroll Runs
* [retrieve](docs/sdks/payrollruns/README.md#retrieve) - Retrieve Payroll Run
### [hris.timeoffs](docs/sdks/timeoffs/README.md)
* [list](docs/sdks/timeoffs/README.md#list) - List Time Offs
* [create](docs/sdks/timeoffs/README.md#create) - Create Timeoffs
* [retrieve](docs/sdks/timeoffs/README.md#retrieve) - Retrieve Time Off
### [hris.timeoffbalances](docs/sdks/timeoffbalances/README.md)
* [list](docs/sdks/timeoffbalances/README.md#list) - List TimeoffBalances
* [retrieve](docs/sdks/timeoffbalances/README.md#retrieve) - Retrieve Time off Balances
### [hris.timesheetentries](docs/sdks/timesheetentries/README.md)
* [list](docs/sdks/timesheetentries/README.md#list) - List Timesheetentries
* [create](docs/sdks/timesheetentries/README.md#create) - Create Timesheetentrys
* [retrieve](docs/sdks/timesheetentries/README.md#retrieve) - Retrieve Timesheetentry
### [marketingautomation.actions](docs/sdks/actions/README.md)
* [list](docs/sdks/actions/README.md#list) - List Actions
* [create](docs/sdks/actions/README.md#create) - Create Action
* [retrieve](docs/sdks/actions/README.md#retrieve) - Retrieve Actions
### [marketingautomation.automations](docs/sdks/automations/README.md)
* [list](docs/sdks/automations/README.md#list) - List Automations
* [create](docs/sdks/automations/README.md#create) - Create Automation
* [retrieve](docs/sdks/automations/README.md#retrieve) - Retrieve Automation
### [marketingautomation.campaigns](docs/sdks/campaigns/README.md)
* [list](docs/sdks/campaigns/README.md#list) - List Campaigns
* [create](docs/sdks/campaigns/README.md#create) - Create Campaign
* [retrieve](docs/sdks/campaigns/README.md#retrieve) - Retrieve Campaign
### [marketingautomation.contacts](docs/sdks/panoramarketingautomationcontacts/README.md)
* [list](docs/sdks/panoramarketingautomationcontacts/README.md#list) - List Contacts
* [create](docs/sdks/panoramarketingautomationcontacts/README.md#create) - Create Contact
* [retrieve](docs/sdks/panoramarketingautomationcontacts/README.md#retrieve) - Retrieve Contacts
### [marketingautomation.emails](docs/sdks/emails/README.md)
* [list](docs/sdks/emails/README.md#list) - List Emails
* [retrieve](docs/sdks/emails/README.md#retrieve) - Retrieve Email
### [marketingautomation.events](docs/sdks/panoraevents/README.md)
* [list](docs/sdks/panoraevents/README.md#list) - List Events
* [retrieve](docs/sdks/panoraevents/README.md#retrieve) - Retrieve Event
### [marketingautomation.lists](docs/sdks/lists/README.md)
* [list](docs/sdks/lists/README.md#list) - List Lists
* [create](docs/sdks/lists/README.md#create) - Create Lists
* [retrieve](docs/sdks/lists/README.md#retrieve) - Retrieve List
### [marketingautomation.messages](docs/sdks/messages/README.md)
* [list](docs/sdks/messages/README.md#list) - List Messages
* [retrieve](docs/sdks/messages/README.md#retrieve) - Retrieve Messages
### [marketingautomation.templates](docs/sdks/templates/README.md)
* [list](docs/sdks/templates/README.md#list) - List Templates
* [create](docs/sdks/templates/README.md#create) - Create Template
* [retrieve](docs/sdks/templates/README.md#retrieve) - Retrieve Template
### [marketingautomation.users](docs/sdks/panoramarketingautomationusers/README.md)
* [list](docs/sdks/panoramarketingautomationusers/README.md#list) - List Users
* [retrieve](docs/sdks/panoramarketingautomationusers/README.md#retrieve) - Retrieve Users
### [ats.activities](docs/sdks/activities/README.md)
* [list](docs/sdks/activities/README.md#list) - List Activities
* [create](docs/sdks/activities/README.md#create) - Create Activities
* [retrieve](docs/sdks/activities/README.md#retrieve) - Retrieve Activities
### [ats.applications](docs/sdks/applications/README.md)
* [list](docs/sdks/applications/README.md#list) - List Applications
* [create](docs/sdks/applications/README.md#create) - Create Applications
* [retrieve](docs/sdks/applications/README.md#retrieve) - Retrieve Applications
### [ats.attachments](docs/sdks/attachments/README.md)
* [list](docs/sdks/attachments/README.md#list) - List Attachments
* [create](docs/sdks/attachments/README.md#create) - Create Attachments
* [retrieve](docs/sdks/attachments/README.md#retrieve) - Retrieve Attachments
### [ats.candidates](docs/sdks/candidates/README.md)
* [list](docs/sdks/candidates/README.md#list) - List Candidates
* [create](docs/sdks/candidates/README.md#create) - Create Candidates
* [retrieve](docs/sdks/candidates/README.md#retrieve) - Retrieve Candidates
### [ats.departments](docs/sdks/departments/README.md)
* [list](docs/sdks/departments/README.md#list) - List Departments
* [retrieve](docs/sdks/departments/README.md#retrieve) - Retrieve Departments
### [ats.interviews](docs/sdks/interviews/README.md)
* [list](docs/sdks/interviews/README.md#list) - List Interviews
* [create](docs/sdks/interviews/README.md#create) - Create Interviews
* [retrieve](docs/sdks/interviews/README.md#retrieve) - Retrieve Interviews
### [ats.jobinterviewstages](docs/sdks/jobinterviewstages/README.md)
* [list](docs/sdks/jobinterviewstages/README.md#list) - List JobInterviewStages
* [retrieve](docs/sdks/jobinterviewstages/README.md#retrieve) - Retrieve Job Interview Stages
### [ats.jobs](docs/sdks/jobs/README.md)
* [list](docs/sdks/jobs/README.md#list) - List Jobs
* [retrieve](docs/sdks/jobs/README.md#retrieve) - Retrieve Jobs
### [ats.offers](docs/sdks/offers/README.md)
* [list](docs/sdks/offers/README.md#list) - List Offers
* [retrieve](docs/sdks/offers/README.md#retrieve) - Retrieve Offers
### [ats.offices](docs/sdks/offices/README.md)
* [list](docs/sdks/offices/README.md#list) - List Offices
* [retrieve](docs/sdks/offices/README.md#retrieve) - Retrieve Offices
### [ats.rejectreasons](docs/sdks/rejectreasons/README.md)
* [list](docs/sdks/rejectreasons/README.md#list) - List RejectReasons
* [retrieve](docs/sdks/rejectreasons/README.md#retrieve) - Retrieve Reject Reasons
### [ats.scorecards](docs/sdks/scorecards/README.md)
* [list](docs/sdks/scorecards/README.md#list) - List ScoreCards
* [retrieve](docs/sdks/scorecards/README.md#retrieve) - Retrieve Score Cards
### [ats.tags](docs/sdks/panoratags/README.md)
* [list](docs/sdks/panoratags/README.md#list) - List Tags
* [retrieve](docs/sdks/panoratags/README.md#retrieve) - Retrieve Tags
### [ats.users](docs/sdks/panoraatsusers/README.md)
* [list](docs/sdks/panoraatsusers/README.md#list) - List Users
* [retrieve](docs/sdks/panoraatsusers/README.md#retrieve) - Retrieve Users
### [ats.eeocs](docs/sdks/eeocs/README.md)
* [list](docs/sdks/eeocs/README.md#list) - List Eeocss
* [retrieve](docs/sdks/eeocs/README.md#retrieve) - Retrieve Eeocs
### [accounting.accounts](docs/sdks/panoraaccounts/README.md)
* [list](docs/sdks/panoraaccounts/README.md#list) - List Accounts
* [create](docs/sdks/panoraaccounts/README.md#create) - Create Accounts
* [retrieve](docs/sdks/panoraaccounts/README.md#retrieve) - Retrieve Accounts
### [accounting.addresses](docs/sdks/addresses/README.md)
* [list](docs/sdks/addresses/README.md#list) - List Addresss
* [retrieve](docs/sdks/addresses/README.md#retrieve) - Retrieve Addresses
### [accounting.attachments](docs/sdks/panoraattachments/README.md)
* [list](docs/sdks/panoraattachments/README.md#list) - List Attachments
* [create](docs/sdks/panoraattachments/README.md#create) - Create Attachments
* [retrieve](docs/sdks/panoraattachments/README.md#retrieve) - Retrieve Attachments
### [accounting.balancesheets](docs/sdks/balancesheets/README.md)
* [list](docs/sdks/balancesheets/README.md#list) - List BalanceSheets
* [retrieve](docs/sdks/balancesheets/README.md#retrieve) - Retrieve BalanceSheets
### [accounting.cashflowstatements](docs/sdks/cashflowstatements/README.md)
* [list](docs/sdks/cashflowstatements/README.md#list) - List CashflowStatements
* [retrieve](docs/sdks/cashflowstatements/README.md#retrieve) - Retrieve Cashflow Statements
### [accounting.companyinfos](docs/sdks/companyinfos/README.md)
* [list](docs/sdks/companyinfos/README.md#list) - List CompanyInfos
* [retrieve](docs/sdks/companyinfos/README.md#retrieve) - Retrieve Company Infos
### [accounting.contacts](docs/sdks/panoraaccountingcontacts/README.md)
* [list](docs/sdks/panoraaccountingcontacts/README.md#list) - List Contacts
* [create](docs/sdks/panoraaccountingcontacts/README.md#create) - Create Contacts
* [retrieve](docs/sdks/panoraaccountingcontacts/README.md#retrieve) - Retrieve Contacts
### [accounting.creditnotes](docs/sdks/creditnotes/README.md)
* [list](docs/sdks/creditnotes/README.md#list) - List CreditNotes
* [retrieve](docs/sdks/creditnotes/README.md#retrieve) - Retrieve Credit Notes
### [accounting.expenses](docs/sdks/expenses/README.md)
* [list](docs/sdks/expenses/README.md#list) - List Expenses
* [create](docs/sdks/expenses/README.md#create) - Create Expenses
* [retrieve](docs/sdks/expenses/README.md#retrieve) - Retrieve Expenses
### [accounting.incomestatements](docs/sdks/incomestatements/README.md)
* [list](docs/sdks/incomestatements/README.md#list) - List IncomeStatements
* [retrieve](docs/sdks/incomestatements/README.md#retrieve) - Retrieve Income Statements
### [accounting.invoices](docs/sdks/invoices/README.md)
* [list](docs/sdks/invoices/README.md#list) - List Invoices
* [create](docs/sdks/invoices/README.md#create) - Create Invoices
* [retrieve](docs/sdks/invoices/README.md#retrieve) - Retrieve Invoices
### [accounting.items](docs/sdks/items/README.md)
* [list](docs/sdks/items/README.md#list) - List Items
* [retrieve](docs/sdks/items/README.md#retrieve) - Retrieve Items
### [accounting.journalentries](docs/sdks/journalentries/README.md)
* [list](docs/sdks/journalentries/README.md#list) - List JournalEntrys
* [create](docs/sdks/journalentries/README.md#create) - Create Journal Entries
* [retrieve](docs/sdks/journalentries/README.md#retrieve) - Retrieve Journal Entries
### [accounting.payments](docs/sdks/payments/README.md)
* [list](docs/sdks/payments/README.md#list) - List Payments
* [create](docs/sdks/payments/README.md#create) - Create Payments
* [retrieve](docs/sdks/payments/README.md#retrieve) - Retrieve Payments
### [accounting.phonenumbers](docs/sdks/phonenumbers/README.md)
* [list](docs/sdks/phonenumbers/README.md#list) - List PhoneNumbers
* [retrieve](docs/sdks/phonenumbers/README.md#retrieve) - Retrieve Phone Numbers
### [accounting.purchaseorders](docs/sdks/purchaseorders/README.md)
* [list](docs/sdks/purchaseorders/README.md#list) - List PurchaseOrders
* [create](docs/sdks/purchaseorders/README.md#create) - Create Purchase Orders
* [retrieve](docs/sdks/purchaseorders/README.md#retrieve) - Retrieve Purchase Orders
### [accounting.taxrates](docs/sdks/taxrates/README.md)
* [list](docs/sdks/taxrates/README.md#list) - List TaxRates
* [retrieve](docs/sdks/taxrates/README.md#retrieve) - Retrieve Tax Rates
### [accounting.trackingcategories](docs/sdks/trackingcategories/README.md)
* [list](docs/sdks/trackingcategories/README.md#list) - List TrackingCategorys
* [retrieve](docs/sdks/trackingcategories/README.md#retrieve) - Retrieve Tracking Categories
### [accounting.transactions](docs/sdks/transactions/README.md)
* [list](docs/sdks/transactions/README.md#list) - List Transactions
* [retrieve](docs/sdks/transactions/README.md#retrieve) - Retrieve Transactions
### [accounting.vendorcredits](docs/sdks/vendorcredits/README.md)
* [list](docs/sdks/vendorcredits/README.md#list) - List VendorCredits
* [retrieve](docs/sdks/vendorcredits/README.md#retrieve) - Retrieve Vendor Credits
### [ecommerce.products](docs/sdks/products/README.md)
* [list](docs/sdks/products/README.md#list) - List Products
* [create](docs/sdks/products/README.md#create) - Create Products
* [retrieve](docs/sdks/products/README.md#retrieve) - Retrieve Products
### [ecommerce.orders](docs/sdks/orders/README.md)
* [list](docs/sdks/orders/README.md#list) - List Orders
* [create](docs/sdks/orders/README.md#create) - Create Orders
* [retrieve](docs/sdks/orders/README.md#retrieve) - Retrieve Orders
### [ecommerce.customers](docs/sdks/customers/README.md)
* [list](docs/sdks/customers/README.md#list) - List Customers
* [retrieve](docs/sdks/customers/README.md#retrieve) - Retrieve Customers
### [ecommerce.fulfillments](docs/sdks/fulfillments/README.md)
* [list](docs/sdks/fulfillments/README.md#list) - List Fulfillments
* [retrieve](docs/sdks/fulfillments/README.md#retrieve) - Retrieve Fulfillments
<!-- End Available Resources and Operations [operations] -->
<!-- Start Retries [retries] -->
## Retries
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:
```python
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
pass
```
If 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:
```python
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
pass
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## 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 |
| --------------- | --------------- | --------------- |
| models.SDKError | 4xx-5xx | */* |
### Example
```python
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
pass
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## 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.panora.dev` | None |
| 1 | `https://api-sandbox.panora.dev` | None |
| 2 | `https://api-dev.panora.dev` | None |
#### Example
```python
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
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:
```python
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
pass
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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:
```python
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:
```python
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()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Debugging [debug] -->
## Debugging
To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
```python
from panora_sdk import Panora
import logging
logging.basicConfig(level=logging.DEBUG)
s = Panora(debug_logger=logging.getLogger("panora_sdk"))
```
<!-- End Debugging [debug] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
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:
```python
from panora_sdk import Panora
s = Panora(
api_key="<YOUR_API_KEY_HERE>",
)
res = s.hello()
if res is not None:
# handle response
pass
```
<!-- End Authentication [security] -->
<!-- Start Pagination [pagination] -->
## Pagination
Some 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:
```python
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
```
<!-- End Pagination [pagination] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## 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. 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.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": "https://github.com/panoratech/python-sdk.git",
"name": "panora-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/be/98/36025c33f6996610a3e3b580549a23e8baebd89f96f4a1bd6e11567c0045/panora_sdk-0.7.0.tar.gz",
"platform": null,
"description": "# panora\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n\n## \ud83c\udfd7 **Welcome to your new SDK!** \ud83c\udfd7\n\nIt has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:\n- [ ] \ud83d\udee0 Make your SDK feel handcrafted by [customizing it](https://www.speakeasy.com/docs/customize-sdks)\n- [ ] \u267b\ufe0f Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)\n- [ ] \ud83c\udf81 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)\n- [ ] \u2728 When ready to productionize, delete this section from the README\n\n<!-- Start Summary [summary] -->\n## Summary\n\nPanora API: A unified API to ship integrations\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n\n* [SDK Installation](#sdk-installation)\n* [IDE Support](#ide-support)\n* [SDK Example Usage](#sdk-example-usage)\n* [Available Resources and Operations](#available-resources-and-operations)\n* [Pagination](#pagination)\n* [Retries](#retries)\n* [Error Handling](#error-handling)\n* [Server Selection](#server-selection)\n* [Custom HTTP Client](#custom-http-client)\n* [Authentication](#authentication)\n* [Debugging](#debugging)\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nPIP\n```bash\npip install panora-sdk\n```\n\nPoetry\n```bash\npoetry add panora-sdk\n```\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, 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.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom panora_sdk import Panora\n\ns = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello()\n\nif res is not None:\n # handle response\n pass\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom panora_sdk import Panora\n\nasync def main():\n s = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n )\n res = await s.hello_async()\n if res is not None:\n # handle response\n pass\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n### [Panora SDK](docs/sdks/panora/README.md)\n\n* [hello](docs/sdks/panora/README.md#hello)\n* [health](docs/sdks/panora/README.md#health)\n\n\n### [rag.query](docs/sdks/query/README.md)\n\n* [query](docs/sdks/query/README.md#query) - Query using RAG Search\n\n\n### [filestorage.files](docs/sdks/files/README.md)\n\n* [list](docs/sdks/files/README.md#list) - List Files\n* [create](docs/sdks/files/README.md#create) - Create Files\n* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve Files\n\n### [filestorage.folders](docs/sdks/folders/README.md)\n\n* [list](docs/sdks/folders/README.md#list) - List Folders\n* [create](docs/sdks/folders/README.md#create) - Create Folders\n* [retrieve](docs/sdks/folders/README.md#retrieve) - Retrieve Folders\n\n### [filestorage.groups](docs/sdks/panoragroups/README.md)\n\n* [list](docs/sdks/panoragroups/README.md#list) - List Groups\n* [retrieve](docs/sdks/panoragroups/README.md#retrieve) - Retrieve Groups\n\n### [filestorage.users](docs/sdks/panorafilestorageusers/README.md)\n\n* [list](docs/sdks/panorafilestorageusers/README.md#list) - List Users\n* [retrieve](docs/sdks/panorafilestorageusers/README.md#retrieve) - Retrieve Users\n\n\n### [auth.login](docs/sdks/login/README.md)\n\n* [sign_in](docs/sdks/login/README.md#sign_in) - Log In\n\n### [connections](docs/sdks/connections/README.md)\n\n* [list](docs/sdks/connections/README.md#list) - List Connections\n\n### [webhooks](docs/sdks/webhooks/README.md)\n\n* [list](docs/sdks/webhooks/README.md#list) - List webhooks\n* [create](docs/sdks/webhooks/README.md#create) - Create webhook\n* [delete](docs/sdks/webhooks/README.md#delete) - Delete Webhook\n* [update_status](docs/sdks/webhooks/README.md#update_status) - Update webhook status\n* [verify_event](docs/sdks/webhooks/README.md#verify_event) - Verify payload signature of the webhook\n\n\n### [ticketing.tickets](docs/sdks/tickets/README.md)\n\n* [list](docs/sdks/tickets/README.md#list) - List Tickets\n* [create](docs/sdks/tickets/README.md#create) - Create Tickets\n* [retrieve](docs/sdks/tickets/README.md#retrieve) - Retrieve Tickets\n\n### [ticketing.users](docs/sdks/users/README.md)\n\n* [list](docs/sdks/users/README.md#list) - List Users\n* [retrieve](docs/sdks/users/README.md#retrieve) - Retrieve User\n\n### [ticketing.accounts](docs/sdks/accounts/README.md)\n\n* [list](docs/sdks/accounts/README.md#list) - List Accounts\n* [retrieve](docs/sdks/accounts/README.md#retrieve) - Retrieve Accounts\n\n### [ticketing.contacts](docs/sdks/contacts/README.md)\n\n* [list](docs/sdks/contacts/README.md#list) - List Contacts\n* [retrieve](docs/sdks/contacts/README.md#retrieve) - Retrieve Contact\n\n### [ticketing.collections](docs/sdks/collections/README.md)\n\n* [list](docs/sdks/collections/README.md#list) - List Collections\n* [retrieve](docs/sdks/collections/README.md#retrieve) - Retrieve Collections\n\n### [ticketing.comments](docs/sdks/comments/README.md)\n\n* [list](docs/sdks/comments/README.md#list) - List Comments\n* [create](docs/sdks/comments/README.md#create) - Create Comments\n* [retrieve](docs/sdks/comments/README.md#retrieve) - Retrieve Comment\n\n### [ticketing.tags](docs/sdks/tags/README.md)\n\n* [list](docs/sdks/tags/README.md#list) - List Tags\n* [retrieve](docs/sdks/tags/README.md#retrieve) - Retrieve Tag\n\n### [ticketing.teams](docs/sdks/teams/README.md)\n\n* [list](docs/sdks/teams/README.md#list) - List Teams\n* [retrieve](docs/sdks/teams/README.md#retrieve) - Retrieve Teams\n\n### [ticketing.attachments](docs/sdks/panoraticketingattachments/README.md)\n\n* [list](docs/sdks/panoraticketingattachments/README.md#list) - List Attachments\n* [create](docs/sdks/panoraticketingattachments/README.md#create) - Create Attachments\n* [retrieve](docs/sdks/panoraticketingattachments/README.md#retrieve) - Retrieve Attachments\n\n### [sync](docs/sdks/sync/README.md)\n\n* [status](docs/sdks/sync/README.md#status) - Retrieve sync status of a certain vertical\n* [resync](docs/sdks/sync/README.md#resync) - Resync common objects across a vertical\n* [update_pull_frequency](docs/sdks/sync/README.md#update_pull_frequency) - Update pull frequency for verticals\n* [get_pull_frequency](docs/sdks/sync/README.md#get_pull_frequency) - Get pull frequency for verticals\n\n\n### [crm.companies](docs/sdks/companies/README.md)\n\n* [list](docs/sdks/companies/README.md#list) - List Companies\n* [create](docs/sdks/companies/README.md#create) - Create Companies\n* [retrieve](docs/sdks/companies/README.md#retrieve) - Retrieve Companies\n\n### [crm.contacts](docs/sdks/panoracontacts/README.md)\n\n* [list](docs/sdks/panoracontacts/README.md#list) - List CRM Contacts\n* [create](docs/sdks/panoracontacts/README.md#create) - Create Contacts\n* [retrieve](docs/sdks/panoracontacts/README.md#retrieve) - Retrieve Contacts\n\n### [crm.deals](docs/sdks/deals/README.md)\n\n* [list](docs/sdks/deals/README.md#list) - List Deals\n* [create](docs/sdks/deals/README.md#create) - Create Deals\n* [retrieve](docs/sdks/deals/README.md#retrieve) - Retrieve Deals\n\n### [crm.engagements](docs/sdks/engagements/README.md)\n\n* [list](docs/sdks/engagements/README.md#list) - List Engagements\n* [create](docs/sdks/engagements/README.md#create) - Create Engagements\n* [retrieve](docs/sdks/engagements/README.md#retrieve) - Retrieve Engagements\n\n### [crm.notes](docs/sdks/notes/README.md)\n\n* [list](docs/sdks/notes/README.md#list) - List Notes\n* [create](docs/sdks/notes/README.md#create) - Create Notes\n* [retrieve](docs/sdks/notes/README.md#retrieve) - Retrieve Notes\n\n### [crm.stages](docs/sdks/stages/README.md)\n\n* [list](docs/sdks/stages/README.md#list) - List Stages\n* [retrieve](docs/sdks/stages/README.md#retrieve) - Retrieve Stages\n\n### [crm.tasks](docs/sdks/tasks/README.md)\n\n* [list](docs/sdks/tasks/README.md#list) - List Tasks\n* [create](docs/sdks/tasks/README.md#create) - Create Tasks\n* [retrieve](docs/sdks/tasks/README.md#retrieve) - Retrieve Tasks\n\n### [crm.users](docs/sdks/panorausers/README.md)\n\n* [list](docs/sdks/panorausers/README.md#list) - List Users\n* [retrieve](docs/sdks/panorausers/README.md#retrieve) - Retrieve Users\n\n### [linked_users](docs/sdks/linkedusers/README.md)\n\n* [create](docs/sdks/linkedusers/README.md#create) - Create Linked Users\n* [list](docs/sdks/linkedusers/README.md#list) - List Linked Users\n* [import_batch](docs/sdks/linkedusers/README.md#import_batch) - Add Batch Linked Users\n* [retrieve](docs/sdks/linkedusers/README.md#retrieve) - Retrieve Linked Users\n* [remote_id](docs/sdks/linkedusers/README.md#remote_id) - Retrieve a Linked User From A Remote Id\n\n### [projects](docs/sdks/projects/README.md)\n\n* [get_projects](docs/sdks/projects/README.md#get_projects) - Retrieve projects\n* [create](docs/sdks/projects/README.md#create) - Create a project\n\n### [field_mappings](docs/sdks/fieldmappings/README.md)\n\n* [get_field_mapping_values](docs/sdks/fieldmappings/README.md#get_field_mapping_values) - Retrieve field mappings values\n* [get_field_mappings_entities](docs/sdks/fieldmappings/README.md#get_field_mappings_entities) - Retrieve field mapping entities\n* [get_field_mappings](docs/sdks/fieldmappings/README.md#get_field_mappings) - Retrieve field mappings\n* [definitions](docs/sdks/fieldmappings/README.md#definitions) - Define target Field\n* [define_custom_field](docs/sdks/fieldmappings/README.md#define_custom_field) - Create Custom Field\n* [map](docs/sdks/fieldmappings/README.md#map) - Map Custom Field\n\n### [events](docs/sdks/events/README.md)\n\n* [get_panora_core_events](docs/sdks/events/README.md#get_panora_core_events) - List Events\n\n### [passthrough](docs/sdks/passthrough/README.md)\n\n* [request](docs/sdks/passthrough/README.md#request) - Make a passthrough request\n\n### [passthrough.retryid](docs/sdks/retryid/README.md)\n\n* [get_retried_request_response](docs/sdks/retryid/README.md#get_retried_request_response) - Retrieve response of a failed passthrough request due to rate limits\n\n\n### [hris.bankinfos](docs/sdks/bankinfos/README.md)\n\n* [list](docs/sdks/bankinfos/README.md#list) - List Bank Info\n* [retrieve](docs/sdks/bankinfos/README.md#retrieve) - Retrieve Bank Info\n\n### [hris.benefits](docs/sdks/benefits/README.md)\n\n* [list](docs/sdks/benefits/README.md#list) - List Benefits\n* [retrieve](docs/sdks/benefits/README.md#retrieve) - Retrieve Benefit\n\n### [hris.companies](docs/sdks/panoracompanies/README.md)\n\n* [list](docs/sdks/panoracompanies/README.md#list) - List Companies\n* [retrieve](docs/sdks/panoracompanies/README.md#retrieve) - Retrieve Company\n\n### [hris.dependents](docs/sdks/dependents/README.md)\n\n* [list](docs/sdks/dependents/README.md#list) - List Dependents\n* [retrieve](docs/sdks/dependents/README.md#retrieve) - Retrieve Dependent\n\n### [hris.employeepayrollruns](docs/sdks/employeepayrollruns/README.md)\n\n* [list](docs/sdks/employeepayrollruns/README.md#list) - List Employee Payroll Runs\n* [retrieve](docs/sdks/employeepayrollruns/README.md#retrieve) - Retrieve Employee Payroll Run\n\n### [hris.employees](docs/sdks/employees/README.md)\n\n* [list](docs/sdks/employees/README.md#list) - List Employees\n* [create](docs/sdks/employees/README.md#create) - Create Employees\n* [retrieve](docs/sdks/employees/README.md#retrieve) - Retrieve Employee\n\n### [hris.employerbenefits](docs/sdks/employerbenefits/README.md)\n\n* [list](docs/sdks/employerbenefits/README.md#list) - List Employer Benefits\n* [retrieve](docs/sdks/employerbenefits/README.md#retrieve) - Retrieve Employer Benefit\n\n### [hris.employments](docs/sdks/employments/README.md)\n\n* [list](docs/sdks/employments/README.md#list) - List Employments\n* [retrieve](docs/sdks/employments/README.md#retrieve) - Retrieve Employment\n\n### [hris.groups](docs/sdks/groups/README.md)\n\n* [list](docs/sdks/groups/README.md#list) - List Groups\n* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve Group\n\n### [hris.locations](docs/sdks/locations/README.md)\n\n* [list](docs/sdks/locations/README.md#list) - List Locations\n* [retrieve](docs/sdks/locations/README.md#retrieve) - Retrieve Location\n\n### [hris.paygroups](docs/sdks/paygroups/README.md)\n\n* [list](docs/sdks/paygroups/README.md#list) - List Pay Groups\n* [retrieve](docs/sdks/paygroups/README.md#retrieve) - Retrieve Pay Group\n\n### [hris.payrollruns](docs/sdks/payrollruns/README.md)\n\n* [list](docs/sdks/payrollruns/README.md#list) - List Payroll Runs\n* [retrieve](docs/sdks/payrollruns/README.md#retrieve) - Retrieve Payroll Run\n\n### [hris.timeoffs](docs/sdks/timeoffs/README.md)\n\n* [list](docs/sdks/timeoffs/README.md#list) - List Time Offs\n* [create](docs/sdks/timeoffs/README.md#create) - Create Timeoffs\n* [retrieve](docs/sdks/timeoffs/README.md#retrieve) - Retrieve Time Off\n\n### [hris.timeoffbalances](docs/sdks/timeoffbalances/README.md)\n\n* [list](docs/sdks/timeoffbalances/README.md#list) - List TimeoffBalances\n* [retrieve](docs/sdks/timeoffbalances/README.md#retrieve) - Retrieve Time off Balances\n\n### [hris.timesheetentries](docs/sdks/timesheetentries/README.md)\n\n* [list](docs/sdks/timesheetentries/README.md#list) - List Timesheetentries\n* [create](docs/sdks/timesheetentries/README.md#create) - Create Timesheetentrys\n* [retrieve](docs/sdks/timesheetentries/README.md#retrieve) - Retrieve Timesheetentry\n\n\n### [marketingautomation.actions](docs/sdks/actions/README.md)\n\n* [list](docs/sdks/actions/README.md#list) - List Actions\n* [create](docs/sdks/actions/README.md#create) - Create Action\n* [retrieve](docs/sdks/actions/README.md#retrieve) - Retrieve Actions\n\n### [marketingautomation.automations](docs/sdks/automations/README.md)\n\n* [list](docs/sdks/automations/README.md#list) - List Automations\n* [create](docs/sdks/automations/README.md#create) - Create Automation\n* [retrieve](docs/sdks/automations/README.md#retrieve) - Retrieve Automation\n\n### [marketingautomation.campaigns](docs/sdks/campaigns/README.md)\n\n* [list](docs/sdks/campaigns/README.md#list) - List Campaigns\n* [create](docs/sdks/campaigns/README.md#create) - Create Campaign\n* [retrieve](docs/sdks/campaigns/README.md#retrieve) - Retrieve Campaign\n\n### [marketingautomation.contacts](docs/sdks/panoramarketingautomationcontacts/README.md)\n\n* [list](docs/sdks/panoramarketingautomationcontacts/README.md#list) - List Contacts\n* [create](docs/sdks/panoramarketingautomationcontacts/README.md#create) - Create Contact\n* [retrieve](docs/sdks/panoramarketingautomationcontacts/README.md#retrieve) - Retrieve Contacts\n\n### [marketingautomation.emails](docs/sdks/emails/README.md)\n\n* [list](docs/sdks/emails/README.md#list) - List Emails\n* [retrieve](docs/sdks/emails/README.md#retrieve) - Retrieve Email\n\n### [marketingautomation.events](docs/sdks/panoraevents/README.md)\n\n* [list](docs/sdks/panoraevents/README.md#list) - List Events\n* [retrieve](docs/sdks/panoraevents/README.md#retrieve) - Retrieve Event\n\n### [marketingautomation.lists](docs/sdks/lists/README.md)\n\n* [list](docs/sdks/lists/README.md#list) - List Lists\n* [create](docs/sdks/lists/README.md#create) - Create Lists\n* [retrieve](docs/sdks/lists/README.md#retrieve) - Retrieve List\n\n### [marketingautomation.messages](docs/sdks/messages/README.md)\n\n* [list](docs/sdks/messages/README.md#list) - List Messages\n* [retrieve](docs/sdks/messages/README.md#retrieve) - Retrieve Messages\n\n### [marketingautomation.templates](docs/sdks/templates/README.md)\n\n* [list](docs/sdks/templates/README.md#list) - List Templates\n* [create](docs/sdks/templates/README.md#create) - Create Template\n* [retrieve](docs/sdks/templates/README.md#retrieve) - Retrieve Template\n\n### [marketingautomation.users](docs/sdks/panoramarketingautomationusers/README.md)\n\n* [list](docs/sdks/panoramarketingautomationusers/README.md#list) - List Users\n* [retrieve](docs/sdks/panoramarketingautomationusers/README.md#retrieve) - Retrieve Users\n\n\n### [ats.activities](docs/sdks/activities/README.md)\n\n* [list](docs/sdks/activities/README.md#list) - List Activities\n* [create](docs/sdks/activities/README.md#create) - Create Activities\n* [retrieve](docs/sdks/activities/README.md#retrieve) - Retrieve Activities\n\n### [ats.applications](docs/sdks/applications/README.md)\n\n* [list](docs/sdks/applications/README.md#list) - List Applications\n* [create](docs/sdks/applications/README.md#create) - Create Applications\n* [retrieve](docs/sdks/applications/README.md#retrieve) - Retrieve Applications\n\n### [ats.attachments](docs/sdks/attachments/README.md)\n\n* [list](docs/sdks/attachments/README.md#list) - List Attachments\n* [create](docs/sdks/attachments/README.md#create) - Create Attachments\n* [retrieve](docs/sdks/attachments/README.md#retrieve) - Retrieve Attachments\n\n### [ats.candidates](docs/sdks/candidates/README.md)\n\n* [list](docs/sdks/candidates/README.md#list) - List Candidates\n* [create](docs/sdks/candidates/README.md#create) - Create Candidates\n* [retrieve](docs/sdks/candidates/README.md#retrieve) - Retrieve Candidates\n\n### [ats.departments](docs/sdks/departments/README.md)\n\n* [list](docs/sdks/departments/README.md#list) - List Departments\n* [retrieve](docs/sdks/departments/README.md#retrieve) - Retrieve Departments\n\n### [ats.interviews](docs/sdks/interviews/README.md)\n\n* [list](docs/sdks/interviews/README.md#list) - List Interviews\n* [create](docs/sdks/interviews/README.md#create) - Create Interviews\n* [retrieve](docs/sdks/interviews/README.md#retrieve) - Retrieve Interviews\n\n### [ats.jobinterviewstages](docs/sdks/jobinterviewstages/README.md)\n\n* [list](docs/sdks/jobinterviewstages/README.md#list) - List JobInterviewStages\n* [retrieve](docs/sdks/jobinterviewstages/README.md#retrieve) - Retrieve Job Interview Stages\n\n### [ats.jobs](docs/sdks/jobs/README.md)\n\n* [list](docs/sdks/jobs/README.md#list) - List Jobs\n* [retrieve](docs/sdks/jobs/README.md#retrieve) - Retrieve Jobs\n\n### [ats.offers](docs/sdks/offers/README.md)\n\n* [list](docs/sdks/offers/README.md#list) - List Offers\n* [retrieve](docs/sdks/offers/README.md#retrieve) - Retrieve Offers\n\n### [ats.offices](docs/sdks/offices/README.md)\n\n* [list](docs/sdks/offices/README.md#list) - List Offices\n* [retrieve](docs/sdks/offices/README.md#retrieve) - Retrieve Offices\n\n### [ats.rejectreasons](docs/sdks/rejectreasons/README.md)\n\n* [list](docs/sdks/rejectreasons/README.md#list) - List RejectReasons\n* [retrieve](docs/sdks/rejectreasons/README.md#retrieve) - Retrieve Reject Reasons\n\n### [ats.scorecards](docs/sdks/scorecards/README.md)\n\n* [list](docs/sdks/scorecards/README.md#list) - List ScoreCards\n* [retrieve](docs/sdks/scorecards/README.md#retrieve) - Retrieve Score Cards\n\n### [ats.tags](docs/sdks/panoratags/README.md)\n\n* [list](docs/sdks/panoratags/README.md#list) - List Tags\n* [retrieve](docs/sdks/panoratags/README.md#retrieve) - Retrieve Tags\n\n### [ats.users](docs/sdks/panoraatsusers/README.md)\n\n* [list](docs/sdks/panoraatsusers/README.md#list) - List Users\n* [retrieve](docs/sdks/panoraatsusers/README.md#retrieve) - Retrieve Users\n\n### [ats.eeocs](docs/sdks/eeocs/README.md)\n\n* [list](docs/sdks/eeocs/README.md#list) - List Eeocss\n* [retrieve](docs/sdks/eeocs/README.md#retrieve) - Retrieve Eeocs\n\n\n### [accounting.accounts](docs/sdks/panoraaccounts/README.md)\n\n* [list](docs/sdks/panoraaccounts/README.md#list) - List Accounts\n* [create](docs/sdks/panoraaccounts/README.md#create) - Create Accounts\n* [retrieve](docs/sdks/panoraaccounts/README.md#retrieve) - Retrieve Accounts\n\n### [accounting.addresses](docs/sdks/addresses/README.md)\n\n* [list](docs/sdks/addresses/README.md#list) - List Addresss\n* [retrieve](docs/sdks/addresses/README.md#retrieve) - Retrieve Addresses\n\n### [accounting.attachments](docs/sdks/panoraattachments/README.md)\n\n* [list](docs/sdks/panoraattachments/README.md#list) - List Attachments\n* [create](docs/sdks/panoraattachments/README.md#create) - Create Attachments\n* [retrieve](docs/sdks/panoraattachments/README.md#retrieve) - Retrieve Attachments\n\n### [accounting.balancesheets](docs/sdks/balancesheets/README.md)\n\n* [list](docs/sdks/balancesheets/README.md#list) - List BalanceSheets\n* [retrieve](docs/sdks/balancesheets/README.md#retrieve) - Retrieve BalanceSheets\n\n### [accounting.cashflowstatements](docs/sdks/cashflowstatements/README.md)\n\n* [list](docs/sdks/cashflowstatements/README.md#list) - List CashflowStatements\n* [retrieve](docs/sdks/cashflowstatements/README.md#retrieve) - Retrieve Cashflow Statements\n\n### [accounting.companyinfos](docs/sdks/companyinfos/README.md)\n\n* [list](docs/sdks/companyinfos/README.md#list) - List CompanyInfos\n* [retrieve](docs/sdks/companyinfos/README.md#retrieve) - Retrieve Company Infos\n\n### [accounting.contacts](docs/sdks/panoraaccountingcontacts/README.md)\n\n* [list](docs/sdks/panoraaccountingcontacts/README.md#list) - List Contacts\n* [create](docs/sdks/panoraaccountingcontacts/README.md#create) - Create Contacts\n* [retrieve](docs/sdks/panoraaccountingcontacts/README.md#retrieve) - Retrieve Contacts\n\n### [accounting.creditnotes](docs/sdks/creditnotes/README.md)\n\n* [list](docs/sdks/creditnotes/README.md#list) - List CreditNotes\n* [retrieve](docs/sdks/creditnotes/README.md#retrieve) - Retrieve Credit Notes\n\n### [accounting.expenses](docs/sdks/expenses/README.md)\n\n* [list](docs/sdks/expenses/README.md#list) - List Expenses\n* [create](docs/sdks/expenses/README.md#create) - Create Expenses\n* [retrieve](docs/sdks/expenses/README.md#retrieve) - Retrieve Expenses\n\n### [accounting.incomestatements](docs/sdks/incomestatements/README.md)\n\n* [list](docs/sdks/incomestatements/README.md#list) - List IncomeStatements\n* [retrieve](docs/sdks/incomestatements/README.md#retrieve) - Retrieve Income Statements\n\n### [accounting.invoices](docs/sdks/invoices/README.md)\n\n* [list](docs/sdks/invoices/README.md#list) - List Invoices\n* [create](docs/sdks/invoices/README.md#create) - Create Invoices\n* [retrieve](docs/sdks/invoices/README.md#retrieve) - Retrieve Invoices\n\n### [accounting.items](docs/sdks/items/README.md)\n\n* [list](docs/sdks/items/README.md#list) - List Items\n* [retrieve](docs/sdks/items/README.md#retrieve) - Retrieve Items\n\n### [accounting.journalentries](docs/sdks/journalentries/README.md)\n\n* [list](docs/sdks/journalentries/README.md#list) - List JournalEntrys\n* [create](docs/sdks/journalentries/README.md#create) - Create Journal Entries\n* [retrieve](docs/sdks/journalentries/README.md#retrieve) - Retrieve Journal Entries\n\n### [accounting.payments](docs/sdks/payments/README.md)\n\n* [list](docs/sdks/payments/README.md#list) - List Payments\n* [create](docs/sdks/payments/README.md#create) - Create Payments\n* [retrieve](docs/sdks/payments/README.md#retrieve) - Retrieve Payments\n\n### [accounting.phonenumbers](docs/sdks/phonenumbers/README.md)\n\n* [list](docs/sdks/phonenumbers/README.md#list) - List PhoneNumbers\n* [retrieve](docs/sdks/phonenumbers/README.md#retrieve) - Retrieve Phone Numbers\n\n### [accounting.purchaseorders](docs/sdks/purchaseorders/README.md)\n\n* [list](docs/sdks/purchaseorders/README.md#list) - List PurchaseOrders\n* [create](docs/sdks/purchaseorders/README.md#create) - Create Purchase Orders\n* [retrieve](docs/sdks/purchaseorders/README.md#retrieve) - Retrieve Purchase Orders\n\n### [accounting.taxrates](docs/sdks/taxrates/README.md)\n\n* [list](docs/sdks/taxrates/README.md#list) - List TaxRates\n* [retrieve](docs/sdks/taxrates/README.md#retrieve) - Retrieve Tax Rates\n\n### [accounting.trackingcategories](docs/sdks/trackingcategories/README.md)\n\n* [list](docs/sdks/trackingcategories/README.md#list) - List TrackingCategorys\n* [retrieve](docs/sdks/trackingcategories/README.md#retrieve) - Retrieve Tracking Categories\n\n### [accounting.transactions](docs/sdks/transactions/README.md)\n\n* [list](docs/sdks/transactions/README.md#list) - List Transactions\n* [retrieve](docs/sdks/transactions/README.md#retrieve) - Retrieve Transactions\n\n### [accounting.vendorcredits](docs/sdks/vendorcredits/README.md)\n\n* [list](docs/sdks/vendorcredits/README.md#list) - List VendorCredits\n* [retrieve](docs/sdks/vendorcredits/README.md#retrieve) - Retrieve Vendor Credits\n\n\n### [ecommerce.products](docs/sdks/products/README.md)\n\n* [list](docs/sdks/products/README.md#list) - List Products\n* [create](docs/sdks/products/README.md#create) - Create Products\n* [retrieve](docs/sdks/products/README.md#retrieve) - Retrieve Products\n\n### [ecommerce.orders](docs/sdks/orders/README.md)\n\n* [list](docs/sdks/orders/README.md#list) - List Orders\n* [create](docs/sdks/orders/README.md#create) - Create Orders\n* [retrieve](docs/sdks/orders/README.md#retrieve) - Retrieve Orders\n\n### [ecommerce.customers](docs/sdks/customers/README.md)\n\n* [list](docs/sdks/customers/README.md#list) - List Customers\n* [retrieve](docs/sdks/customers/README.md#retrieve) - Retrieve Customers\n\n### [ecommerce.fulfillments](docs/sdks/fulfillments/README.md)\n\n* [list](docs/sdks/fulfillments/README.md#list) - List Fulfillments\n* [retrieve](docs/sdks/fulfillments/README.md#retrieve) - Retrieve Fulfillments\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome 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.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom panora.utils import BackoffStrategy, RetryConfig\nfrom panora_sdk import Panora\n\ns = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello(,\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\nif res is not None:\n # handle response\n pass\n\n```\n\nIf 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:\n```python\nfrom panora.utils import BackoffStrategy, RetryConfig\nfrom panora_sdk import Panora\n\ns = Panora(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello()\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling 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.\n\n| Error Object | Status Code | Content Type |\n| --------------- | --------------- | --------------- |\n| models.SDKError | 4xx-5xx | */* |\n\n### Example\n\n```python\nfrom panora_sdk import Panora, models\n\ns = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\nres = None\ntry:\n res = s.hello()\n\nexcept models.SDKError as e:\n # handle exception\n raise(e)\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou 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:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.panora.dev` | None |\n| 1 | `https://api-sandbox.panora.dev` | None |\n| 2 | `https://api-dev.panora.dev` | None |\n\n#### Example\n\n```python\nfrom panora_sdk import Panora\n\ns = Panora(\n server_idx=2,\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello()\n\nif res is not None:\n # handle response\n pass\n\n```\n\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom panora_sdk import Panora\n\ns = Panora(\n server_url=\"https://api.panora.dev\",\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello()\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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.\nDepending 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.\nThis 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.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom panora_sdk import Panora\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Panora(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom panora_sdk import Panora\nfrom panora_sdk.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = Panora(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nTo emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.\n\n```python\nfrom panora_sdk import Panora\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Panora(debug_logger=logging.getLogger(\"panora_sdk\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| --------- | --------- | --------- |\n| `api_key` | apiKey | API key |\n\nTo authenticate with the API the `null` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom panora_sdk import Panora\n\ns = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.hello()\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Pagination [pagination] -->\n## Pagination\n\nSome of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the\nreturned response object will have a `Next` method that can be called to pull down the next group of results. If the\nreturn value of `Next` is `None`, then there are no more pages to be fetched.\n\nHere's an example of one such pagination call:\n```python\nfrom panora_sdk import Panora\n\ns = Panora(\n api_key=\"<YOUR_API_KEY_HERE>\",\n)\n\n\nres = s.filestorage.files.list(x_connection_token=\"<value>\", remote_data=True, limit=10, cursor=\"1b8b05bb-5273-4012-b520-8657b0b90874\")\n\nif res is not None:\n while True:\n # handle items\n\n res = res.Next()\n if res is None:\n break\n\n\n```\n<!-- End Pagination [pagination] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile 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. \nWe 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. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/panoratech/python-sdk.git",
"Repository": "https://github.com/panoratech/python-sdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f3a3d9340e3debb946ad978be04fc9566ccfb8fbec933417cd0a379f1ed65fe",
"md5": "63300c3ded4e9496be7e0ef5905430d4",
"sha256": "fe592ce22c72117d0f613d738d07bd4fd357daa7be2cd4d32bd70dcd5175d978"
},
"downloads": -1,
"filename": "panora_sdk-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63300c3ded4e9496be7e0ef5905430d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 577609,
"upload_time": "2024-09-17T19:36:31",
"upload_time_iso_8601": "2024-09-17T19:36:31.389557Z",
"url": "https://files.pythonhosted.org/packages/3f/3a/3d9340e3debb946ad978be04fc9566ccfb8fbec933417cd0a379f1ed65fe/panora_sdk-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be9836025c33f6996610a3e3b580549a23e8baebd89f96f4a1bd6e11567c0045",
"md5": "fafbbf5659f322806c2bfbbac7128d13",
"sha256": "fd59e9b1fc745fd665944e52b70bb93bad88baf60a3177acbfc371d39f16915d"
},
"downloads": -1,
"filename": "panora_sdk-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "fafbbf5659f322806c2bfbbac7128d13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 144031,
"upload_time": "2024-09-17T19:36:32",
"upload_time_iso_8601": "2024-09-17T19:36:32.934086Z",
"url": "https://files.pythonhosted.org/packages/be/98/36025c33f6996610a3e3b580549a23e8baebd89f96f4a1bd6e11567c0045/panora_sdk-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 19:36:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "panoratech",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "panora-sdk"
}
JSON
