Skip to content

apideck-libraries/python-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

197 Commits
.github/workflows
.github/workflows
 
 
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
package.json
package.json
 
 
pyproject.toml
pyproject.toml
 
 

Repository files navigation

Apideck Python SDK

Table of Contents

Requirements.

Python >=3.6

Installation & Usage

pip install

pip install apideck

or you can install directly using:

pip install git+https://github.com/apideck-libraries/python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/apideck-libraries/python-sdk.git)

Then import the package:

import apideck

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import apideck

Getting started

The module supports all Apideck API endpoints. For complete information about the API, head to the docs.

Example

Retrieving a list of all contacts and updating the first record with a new address.

import apideck
from apideck.api import crm_api
from apideck.model.contacts_sort import ContactsSort
from apideck.model.sort_direction import SortDirection
from pprint import pprint

configuration = apideck.Configuration()

configuration.api_key['apiKey'] = '<insert-api-key-here>'
configuration.api_key_prefix['apiKey'] = 'Bearer'

with apideck.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = crm_api.CrmApi(api_client)
    raw = False
    consumer_id = '<insert-consumer-id-here>'
    app_id = '<insert-application-id-here>'
    service_id = '<insert-service-id-here>'
    limit = 20

    sort = ContactsSort(
        by="name",
        direction=SortDirection("asc"),
    ) 
    

    try:
        # List contacts
        api_response = api_instance.contacts_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, limit=limit, sort=sort)
        pprint(api_response)
    except apideck.ApiException as e:
        print("Exception when calling CrmApi->contacts_all: %s\n" % e)

Apideck Unified Apis

The following Apis are currently available:

AccountingApi

Read the full documentation of the AccountingApi here.

AtsApi

Read the full documentation of the AtsApi here.

ConnectorApi

Read the full documentation of the ConnectorApi here.

CrmApi

Read the full documentation of the CrmApi here.

EcommerceApi

Read the full documentation of the EcommerceApi here.

FileStorageApi

Read the full documentation of the FileStorageApi here.

HrisApi

Read the full documentation of the HrisApi here.

IssueTrackingApi

Read the full documentation of the IssueTrackingApi here.

LeadApi

Read the full documentation of the LeadApi here.

PosApi

Read the full documentation of the PosApi here.

SmsApi

Read the full documentation of the SmsApi here.

VaultApi

Read the full documentation of the VaultApi here.

WebhookApi

Read the full documentation of the WebhookApi here.

Utils

uploadFile

A utility for uploading files using the File Storage API. uploadFile will automatically use upload sessions for files larger than 4MB. Smaller files will be uploaded with a simple upload call.

Example Usage

Support

Open an issue!

License

Apache-2.0

import time
import apideck
from pprint import pprint
from apideck.api import accounting_api
from apideck.model.accounting_department import AccountingDepartment
from apideck.model.accounting_departments_filter import AccountingDepartmentsFilter
from apideck.model.accounting_location import AccountingLocation
from apideck.model.accounting_locations_filter import AccountingLocationsFilter
from apideck.model.attachment_reference_type import AttachmentReferenceType
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.balance_sheet_filter import BalanceSheetFilter
from apideck.model.bill import Bill
from apideck.model.bill_payment import BillPayment
from apideck.model.bills_filter import BillsFilter
from apideck.model.bills_sort import BillsSort
from apideck.model.create_accounting_department_response import CreateAccountingDepartmentResponse
from apideck.model.create_accounting_location_response import CreateAccountingLocationResponse
from apideck.model.create_bill_payment_response import CreateBillPaymentResponse
from apideck.model.create_bill_response import CreateBillResponse
from apideck.model.create_credit_note_response import CreateCreditNoteResponse
from apideck.model.create_customer_response import CreateCustomerResponse
from apideck.model.create_expense_response import CreateExpenseResponse
from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse
from apideck.model.create_invoice_response import CreateInvoiceResponse
from apideck.model.create_journal_entry_response import CreateJournalEntryResponse
from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse
from apideck.model.create_payment_response import CreatePaymentResponse
from apideck.model.create_purchase_order_response import CreatePurchaseOrderResponse
from apideck.model.create_subsidiary_response import CreateSubsidiaryResponse
from apideck.model.create_supplier_response import CreateSupplierResponse
from apideck.model.create_tax_rate_response import CreateTaxRateResponse
from apideck.model.create_tracking_category_response import CreateTrackingCategoryResponse
from apideck.model.credit_note import CreditNote
from apideck.model.credit_notes_filter import CreditNotesFilter
from apideck.model.credit_notes_sort import CreditNotesSort
from apideck.model.customer import Customer
from apideck.model.customers_filter import CustomersFilter
from apideck.model.customers_sort import CustomersSort
from apideck.model.delete_accounting_department_response import DeleteAccountingDepartmentResponse
from apideck.model.delete_accounting_location_response import DeleteAccountingLocationResponse
from apideck.model.delete_attachment_response import DeleteAttachmentResponse
from apideck.model.delete_bill_payment_response import DeleteBillPaymentResponse
from apideck.model.delete_bill_response import DeleteBillResponse
from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse
from apideck.model.delete_customer_response import DeleteCustomerResponse
from apideck.model.delete_expense_response import DeleteExpenseResponse
from apideck.model.delete_invoice_response import DeleteInvoiceResponse
from apideck.model.delete_journal_entry_response import DeleteJournalEntryResponse
from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse
from apideck.model.delete_payment_response import DeletePaymentResponse
from apideck.model.delete_purchase_order_response import DeletePurchaseOrderResponse
from apideck.model.delete_subsidiary_response import DeleteSubsidiaryResponse
from apideck.model.delete_supplier_response import DeleteSupplierResponse
from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse
from apideck.model.delete_tracking_category_response import DeleteTrackingCategoryResponse
from apideck.model.expense import Expense
from apideck.model.get_accounting_department_response import GetAccountingDepartmentResponse
from apideck.model.get_accounting_departments_response import GetAccountingDepartmentsResponse
from apideck.model.get_accounting_location_response import GetAccountingLocationResponse
from apideck.model.get_accounting_locations_response import GetAccountingLocationsResponse
from apideck.model.get_attachment_response import GetAttachmentResponse
from apideck.model.get_attachments_response import GetAttachmentsResponse
from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse
from apideck.model.get_bill_payment_response import GetBillPaymentResponse
from apideck.model.get_bill_payments_response import GetBillPaymentsResponse
from apideck.model.get_bill_response import GetBillResponse
from apideck.model.get_bills_response import GetBillsResponse
from apideck.model.get_company_info_response import GetCompanyInfoResponse
from apideck.model.get_credit_note_response import GetCreditNoteResponse
from apideck.model.get_credit_notes_response import GetCreditNotesResponse
from apideck.model.get_customer_response import GetCustomerResponse
from apideck.model.get_customers_response import GetCustomersResponse
from apideck.model.get_expense_response import GetExpenseResponse
from apideck.model.get_expenses_response import GetExpensesResponse
from apideck.model.get_invoice_item_response import GetInvoiceItemResponse
from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse
from apideck.model.get_invoice_response import GetInvoiceResponse
from apideck.model.get_invoices_response import GetInvoicesResponse
from apideck.model.get_journal_entries_response import GetJournalEntriesResponse
from apideck.model.get_journal_entry_response import GetJournalEntryResponse
from apideck.model.get_ledger_account_response import GetLedgerAccountResponse
from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse
from apideck.model.get_payment_response import GetPaymentResponse
from apideck.model.get_payments_response import GetPaymentsResponse
from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse
from apideck.model.get_purchase_order_response import GetPurchaseOrderResponse
from apideck.model.get_purchase_orders_response import GetPurchaseOrdersResponse
from apideck.model.get_subsidiaries_response import GetSubsidiariesResponse
from apideck.model.get_subsidiary_response import GetSubsidiaryResponse
from apideck.model.get_supplier_response import GetSupplierResponse
from apideck.model.get_suppliers_response import GetSuppliersResponse
from apideck.model.get_tax_rate_response import GetTaxRateResponse
from apideck.model.get_tax_rates_response import GetTaxRatesResponse
from apideck.model.get_tracking_categories_response import GetTrackingCategoriesResponse
from apideck.model.get_tracking_category_response import GetTrackingCategoryResponse
from apideck.model.invoice import Invoice
from apideck.model.invoice_item import InvoiceItem
from apideck.model.invoice_items_filter import InvoiceItemsFilter
from apideck.model.invoices_filter import InvoicesFilter
from apideck.model.invoices_sort import InvoicesSort
from apideck.model.journal_entries_filter import JournalEntriesFilter
from apideck.model.journal_entries_sort import JournalEntriesSort
from apideck.model.journal_entry import JournalEntry
from apideck.model.ledger_account import LedgerAccount
from apideck.model.ledger_accounts_filter import LedgerAccountsFilter
from apideck.model.ledger_accounts_sort import LedgerAccountsSort
from apideck.model.not_found_response import NotFoundResponse
from apideck.model.pass_through_query import PassThroughQuery
from apideck.model.payment import Payment
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.payments_filter import PaymentsFilter
from apideck.model.payments_sort import PaymentsSort
from apideck.model.profit_and_loss_filter import ProfitAndLossFilter
from apideck.model.purchase_order import PurchaseOrder
from apideck.model.purchase_orders_filter import PurchaseOrdersFilter
from apideck.model.purchase_orders_sort import PurchaseOrdersSort
from apideck.model.subsidiary import Subsidiary
from apideck.model.supplier import Supplier
from apideck.model.suppliers_filter import SuppliersFilter
from apideck.model.suppliers_sort import SuppliersSort
from apideck.model.tax_rate import TaxRate
from apideck.model.tax_rates_filter import TaxRatesFilter
from apideck.model.tracking_category import TrackingCategory
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.update_accounting_department_response import UpdateAccountingDepartmentResponse
from apideck.model.update_accounting_location_response import UpdateAccountingLocationResponse
from apideck.model.update_bill_payment_response import UpdateBillPaymentResponse
from apideck.model.update_bill_response import UpdateBillResponse
from apideck.model.update_credit_note_response import UpdateCreditNoteResponse
from apideck.model.update_customer_response import UpdateCustomerResponse
from apideck.model.update_expense_response import UpdateExpenseResponse
from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse
from apideck.model.update_invoice_response import UpdateInvoiceResponse
from apideck.model.update_journal_entry_response import UpdateJournalEntryResponse
from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse
from apideck.model.update_payment_response import UpdatePaymentResponse
from apideck.model.update_purchase_order_response import UpdatePurchaseOrderResponse
from apideck.model.update_subsidiary_response import UpdateSubsidiaryResponse
from apideck.model.update_supplier_response import UpdateSupplierResponse
from apideck.model.update_tax_rate_response import UpdateTaxRateResponse
from apideck.model.update_tracking_category_response import UpdateTrackingCategoryResponse
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
    host = "https://unify.apideck.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'


# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = accounting_api.AccountingApi(api_client)
    reference_type = AttachmentReferenceType("invoice") # AttachmentReferenceType | The reference type of the document.
reference_id = "123456" # str | The reference id of the object to retrieve.
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) (default to False)
x_apideck_consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
x_apideck_app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
x_apideck_service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional)
limit = 20 # int | Number of results to return. Minimum 1, Maximum 200, Default 20 (optional) (default to 20)
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)

    try:
        # List Attachments
        api_response = api_instance.attachments_all(reference_type, reference_id, raw=raw, x_apideck_consumer_id=x_apideck_consumer_id, x_apideck_app_id=x_apideck_app_id, x_apideck_service_id=x_apideck_service_id, cursor=cursor, limit=limit, fields=fields)
        pprint(api_response)
    except apideck.ApiException as e:
        print("Exception when calling AccountingApi->attachments_all: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://unify.apideck.com

Class Method HTTP request Description
AccountingApi attachments_all GET /accounting/attachments/{reference_type}/{reference_id} List Attachments

AccountingApi | attachments_delete | DELETE /accounting/attachments/{reference_type}/{reference_id}/{id} | Delete Attachment |

AccountingApi | attachments_download | GET /accounting/attachments/{reference_type}/{reference_id}/{id}/download | Download Attachment |

AccountingApi | attachments_one | GET /accounting/attachments/{reference_type}/{reference_id}/{id} | Get Attachment |

AccountingApi | balance_sheet_one | GET /accounting/balance-sheet | Get BalanceSheet |

AccountingApi | bill_payments_add | POST /accounting/bill-payments | Create Bill Payment |

AccountingApi | bill_payments_all | GET /accounting/bill-payments | List Bill Payments |

AccountingApi | bill_payments_delete | DELETE /accounting/bill-payments/{id} | Delete Bill Payment |

AccountingApi | bill_payments_one | GET /accounting/bill-payments/{id} | Get Bill Payment |

AccountingApi | bill_payments_update | PATCH /accounting/bill-payments/{id} | Update Bill Payment |

AccountingApi | bills_add | POST /accounting/bills | Create Bill |

AccountingApi | bills_all | GET /accounting/bills | List Bills |

AccountingApi | bills_delete | DELETE /accounting/bills/{id} | Delete Bill |

AccountingApi | bills_one | GET /accounting/bills/{id} | Get Bill |

AccountingApi | bills_update | PATCH /accounting/bills/{id} | Update Bill |

AccountingApi | company_info_one | GET /accounting/company-info | Get company info |

AccountingApi | credit_notes_add | POST /accounting/credit-notes | Create Credit Note |

AccountingApi | credit_notes_all | GET /accounting/credit-notes | List Credit Notes |

AccountingApi | credit_notes_delete | DELETE /accounting/credit-notes/{id} | Delete Credit Note |

AccountingApi | credit_notes_one | GET /accounting/credit-notes/{id} | Get Credit Note |

AccountingApi | credit_notes_update | PATCH /accounting/credit-notes/{id} | Update Credit Note |

AccountingApi | customers_add | POST /accounting/customers | Create Customer |

AccountingApi | customers_all | GET /accounting/customers | List Customers |

AccountingApi | customers_delete | DELETE /accounting/customers/{id} | Delete Customer |

AccountingApi | customers_one | GET /accounting/customers/{id} | Get Customer |

AccountingApi | customers_update | PATCH /accounting/customers/{id} | Update Customer |

AccountingApi | departments_add | POST /accounting/departments | Create Department |

AccountingApi | departments_all | GET /accounting/departments | List Departments |

AccountingApi | departments_delete | DELETE /accounting/departments/{id} | Delete Department |

AccountingApi | departments_one | GET /accounting/departments/{id} | Get Department |

AccountingApi | departments_update | PATCH /accounting/departments/{id} | Update Department |

AccountingApi | expenses_add | POST /accounting/expenses | Create Expense |

AccountingApi | expenses_all | GET /accounting/expenses | List Expenses |

AccountingApi | expenses_delete | DELETE /accounting/expenses/{id} | Delete Expense |

AccountingApi | expenses_one | GET /accounting/expenses/{id} | Get Expense |

AccountingApi | expenses_update | PATCH /accounting/expenses/{id} | Update Expense |

AccountingApi | invoice_items_add | POST /accounting/invoice-items | Create Invoice Item |

AccountingApi | invoice_items_all | GET /accounting/invoice-items | List Invoice Items |

AccountingApi | invoice_items_delete | DELETE /accounting/invoice-items/{id} | Delete Invoice Item |

AccountingApi | invoice_items_one | GET /accounting/invoice-items/{id} | Get Invoice Item |

AccountingApi | invoice_items_update | PATCH /accounting/invoice-items/{id} | Update Invoice Item |

AccountingApi | invoices_add | POST /accounting/invoices | Create Invoice |

AccountingApi | invoices_all | GET /accounting/invoices | List Invoices |

AccountingApi | invoices_delete | DELETE /accounting/invoices/{id} | Delete Invoice |

AccountingApi | invoices_one | GET /accounting/invoices/{id} | Get Invoice |

AccountingApi | invoices_update | PATCH /accounting/invoices/{id} | Update Invoice |

AccountingApi | journal_entries_add | POST /accounting/journal-entries | Create Journal Entry |

AccountingApi | journal_entries_all | GET /accounting/journal-entries | List Journal Entries |

AccountingApi | journal_entries_delete | DELETE /accounting/journal-entries/{id} | Delete Journal Entry |

AccountingApi | journal_entries_one | GET /accounting/journal-entries/{id} | Get Journal Entry |

AccountingApi | journal_entries_update | PATCH /accounting/journal-entries/{id} | Update Journal Entry |

AccountingApi | ledger_accounts_add | POST /accounting/ledger-accounts | Create Ledger Account |

AccountingApi | ledger_accounts_all | GET /accounting/ledger-accounts | List Ledger Accounts |

AccountingApi | ledger_accounts_delete | DELETE /accounting/ledger-accounts/{id} | Delete Ledger Account |

AccountingApi | ledger_accounts_one | GET /accounting/ledger-accounts/{id} | Get Ledger Account |

AccountingApi | ledger_accounts_update | PATCH /accounting/ledger-accounts/{id} | Update Ledger Account |

AccountingApi | locations_add | POST /accounting/locations | Create Location |

AccountingApi | locations_all | GET /accounting/locations | List Locations |

AccountingApi | locations_delete | DELETE /accounting/locations/{id} | Delete Location |

AccountingApi | locations_one | GET /accounting/locations/{id} | Get Location |

AccountingApi | locations_update | PATCH /accounting/locations/{id} | Update Location |

AccountingApi | payments_add | POST /accounting/payments | Create Payment |

AccountingApi | payments_all | GET /accounting/payments | List Payments |

AccountingApi | payments_delete | DELETE /accounting/payments/{id} | Delete Payment |

AccountingApi | payments_one | GET /accounting/payments/{id} | Get Payment |

AccountingApi | payments_update | PATCH /accounting/payments/{id} | Update Payment |

AccountingApi | profit_and_loss_one | GET /accounting/profit-and-loss | Get Profit and Loss |

AccountingApi | purchase_orders_add | POST /accounting/purchase-orders | Create Purchase Order |

AccountingApi | purchase_orders_all | GET /accounting/purchase-orders | List Purchase Orders |

AccountingApi | purchase_orders_delete | DELETE /accounting/purchase-orders/{id} | Delete Purchase Order |

AccountingApi | purchase_orders_one | GET /accounting/purchase-orders/{id} | Get Purchase Order |

AccountingApi | purchase_orders_update | PATCH /accounting/purchase-orders/{id} | Update Purchase Order |

AccountingApi | subsidiaries_add | POST /accounting/subsidiaries | Create Subsidiary |

AccountingApi | subsidiaries_all | GET /accounting/subsidiaries | List Subsidiaries |

AccountingApi | subsidiaries_delete | DELETE /accounting/subsidiaries/{id} | Delete Subsidiary |

AccountingApi | subsidiaries_one | GET /accounting/subsidiaries/{id} | Get Subsidiary |

AccountingApi | subsidiaries_update | PATCH /accounting/subsidiaries/{id} | Update Subsidiary |

AccountingApi | suppliers_add | POST /accounting/suppliers | Create Supplier |

AccountingApi | suppliers_all | GET /accounting/suppliers | List Suppliers |

AccountingApi | suppliers_delete | DELETE /accounting/suppliers/{id} | Delete Supplier |

AccountingApi | suppliers_one | GET /accounting/suppliers/{id} | Get Supplier |

AccountingApi | suppliers_update | PATCH /accounting/suppliers/{id} | Update Supplier |

AccountingApi | tax_rates_add | POST /accounting/tax-rates | Create Tax Rate |

AccountingApi | tax_rates_all | GET /accounting/tax-rates | List Tax Rates |

AccountingApi | tax_rates_delete | DELETE /accounting/tax-rates/{id} | Delete Tax Rate |

AccountingApi | tax_rates_one | GET /accounting/tax-rates/{id} | Get Tax Rate |

AccountingApi | tax_rates_update | PATCH /accounting/tax-rates/{id} | Update Tax Rate |

AccountingApi | tracking_categories_add | POST /accounting/tracking-categories | Create Tracking Category |

AccountingApi | tracking_categories_all | GET /accounting/tracking-categories | List Tracking Categories |

AccountingApi | tracking_categories_delete | DELETE /accounting/tracking-categories/{id} | Delete Tracking Category |

AccountingApi | tracking_categories_one | GET /accounting/tracking-categories/{id} | Get Tracking Category |

AccountingApi | tracking_categories_update | PATCH /accounting/tracking-categories/{id} | Update Tracking Category |

AtsApi | applicants_add | POST /ats/applicants | Create Applicant |

AtsApi | applicants_all | GET /ats/applicants | List Applicants |

AtsApi | applicants_delete | DELETE /ats/applicants/{id} | Delete Applicant |

AtsApi | applicants_one | GET /ats/applicants/{id} | Get Applicant |

AtsApi | applicants_update | PATCH /ats/applicants/{id} | Update Applicant |

AtsApi | applications_add | POST /ats/applications | Create Application |

AtsApi | applications_all | GET /ats/applications | List Applications |

AtsApi | applications_delete | DELETE /ats/applications/{id} | Delete Application |

AtsApi | applications_one | GET /ats/applications/{id} | Get Application |

AtsApi | applications_update | PATCH /ats/applications/{id} | Update Application |

AtsApi | jobs_all | GET /ats/jobs | List Jobs |

AtsApi | jobs_one | GET /ats/jobs/{id} | Get Job |

ConnectorApi | api_resource_coverage_one | GET /connector/apis/{id}/resources/{resource_id}/coverage | Get API Resource Coverage |

ConnectorApi | api_resources_one | GET /connector/apis/{id}/resources/{resource_id} | Get API Resource |

ConnectorApi | apis_all | GET /connector/apis | List APIs |

ConnectorApi | apis_one | GET /connector/apis/{id} | Get API |

ConnectorApi | connector_docs_one | GET /connector/connectors/{id}/docs/{doc_id} | Get Connector Doc content |

ConnectorApi | connector_resources_one | GET /connector/connectors/{id}/resources/{resource_id} | Get Connector Resource |

ConnectorApi | connectors_all | GET /connector/connectors | List Connectors |

ConnectorApi | connectors_one | GET /connector/connectors/{id} | Get Connector |

CrmApi | activities_add | POST /crm/activities | Create activity |

CrmApi | activities_all | GET /crm/activities | List activities |

CrmApi | activities_delete | DELETE /crm/activities/{id} | Delete activity |

CrmApi | activities_one | GET /crm/activities/{id} | Get activity |

CrmApi | activities_update | PATCH /crm/activities/{id} | Update activity |

CrmApi | companies_add | POST /crm/companies | Create company |

CrmApi | companies_all | GET /crm/companies | List companies |

CrmApi | companies_delete | DELETE /crm/companies/{id} | Delete company |

CrmApi | companies_one | GET /crm/companies/{id} | Get company |

CrmApi | companies_update | PATCH /crm/companies/{id} | Update company |

CrmApi | contacts_add | POST /crm/contacts | Create contact |

CrmApi | contacts_all | GET /crm/contacts | List contacts |

CrmApi | contacts_delete | DELETE /crm/contacts/{id} | Delete contact |

CrmApi | contacts_one | GET /crm/contacts/{id} | Get contact |

CrmApi | contacts_update | PATCH /crm/contacts/{id} | Update contact |

CrmApi | leads_add | POST /crm/leads | Create lead |

CrmApi | leads_all | GET /crm/leads | List leads |

CrmApi | leads_delete | DELETE /crm/leads/{id} | Delete lead |

CrmApi | leads_one | GET /crm/leads/{id} | Get lead |

CrmApi | leads_update | PATCH /crm/leads/{id} | Update lead |

CrmApi | notes_add | POST /crm/notes | Create note |

CrmApi | notes_all | GET /crm/notes | List notes |

CrmApi | notes_delete | DELETE /crm/notes/{id} | Delete note |

CrmApi | notes_one | GET /crm/notes/{id} | Get note |

CrmApi | notes_update | PATCH /crm/notes/{id} | Update note |

CrmApi | opportunities_add | POST /crm/opportunities | Create opportunity |

CrmApi | opportunities_all | GET /crm/opportunities | List opportunities |

CrmApi | opportunities_delete | DELETE /crm/opportunities/{id} | Delete opportunity |

CrmApi | opportunities_one | GET /crm/opportunities/{id} | Get opportunity |

CrmApi | opportunities_update | PATCH /crm/opportunities/{id} | Update opportunity |

CrmApi | pipelines_add | POST /crm/pipelines | Create pipeline |

CrmApi | pipelines_all | GET /crm/pipelines | List pipelines |

CrmApi | pipelines_delete | DELETE /crm/pipelines/{id} | Delete pipeline |

CrmApi | pipelines_one | GET /crm/pipelines/{id} | Get pipeline |

CrmApi | pipelines_update | PATCH /crm/pipelines/{id} | Update pipeline |

CrmApi | users_add | POST /crm/users | Create user |

CrmApi | users_all | GET /crm/users | List users |

CrmApi | users_delete | DELETE /crm/users/{id} | Delete user |

CrmApi | users_one | GET /crm/users/{id} | Get user |

CrmApi | users_update | PATCH /crm/users/{id} | Update user |

EcommerceApi | customers_all | GET /ecommerce/customers | List Customers |

EcommerceApi | customers_one | GET /ecommerce/customers/{id} | Get Customer |

EcommerceApi | orders_all | GET /ecommerce/orders | List Orders |

EcommerceApi | orders_one | GET /ecommerce/orders/{id} | Get Order |

EcommerceApi | products_all | GET /ecommerce/products | List Products |

EcommerceApi | products_one | GET /ecommerce/products/{id} | Get Product |

EcommerceApi | stores_one | GET /ecommerce/store | Get Store |

FileStorageApi | drive_groups_add | POST /file-storage/drive-groups | Create DriveGroup |

FileStorageApi | drive_groups_all | GET /file-storage/drive-groups | List DriveGroups |

FileStorageApi | drive_groups_delete | DELETE /file-storage/drive-groups/{id} | Delete DriveGroup |

FileStorageApi | drive_groups_one | GET /file-storage/drive-groups/{id} | Get DriveGroup |

FileStorageApi | drive_groups_update | PATCH /file-storage/drive-groups/{id} | Update DriveGroup |

FileStorageApi | drives_add | POST /file-storage/drives | Create Drive |

FileStorageApi | drives_all | GET /file-storage/drives | List Drives |

FileStorageApi | drives_delete | DELETE /file-storage/drives/{id} | Delete Drive |

FileStorageApi | drives_one | GET /file-storage/drives/{id} | Get Drive |

FileStorageApi | drives_update | PATCH /file-storage/drives/{id} | Update Drive |

FileStorageApi | files_all | GET /file-storage/files | List Files |

FileStorageApi | files_delete | DELETE /file-storage/files/{id} | Delete File |

FileStorageApi | files_download | GET /file-storage/files/{id}/download | Download File |

FileStorageApi | files_export | GET /file-storage/files/{id}/export | Export File |

FileStorageApi | files_one | GET /file-storage/files/{id} | Get File |

FileStorageApi | files_search | POST /file-storage/files/search | Search Files |

FileStorageApi | files_update | PATCH /file-storage/files/{id} | Rename or move File |

FileStorageApi | folders_add | POST /file-storage/folders | Create Folder |

FileStorageApi | folders_copy | POST /file-storage/folders/{id}/copy | Copy Folder |

FileStorageApi | folders_delete | DELETE /file-storage/folders/{id} | Delete Folder |

FileStorageApi | folders_one | GET /file-storage/folders/{id} | Get Folder |

FileStorageApi | folders_update | PATCH /file-storage/folders/{id} | Rename or move Folder |

FileStorageApi | shared_links_add | POST /file-storage/shared-links | Create Shared Link |

FileStorageApi | shared_links_all | GET /file-storage/shared-links | List SharedLinks |

FileStorageApi | shared_links_delete | DELETE /file-storage/shared-links/{id} | Delete Shared Link |

FileStorageApi | shared_links_one | GET /file-storage/shared-links/{id} | Get Shared Link |

FileStorageApi | shared_links_update | PATCH /file-storage/shared-links/{id} | Update Shared Link |

FileStorageApi | upload_sessions_add | POST /file-storage/upload-sessions | Start Upload Session |

FileStorageApi | upload_sessions_delete | DELETE /file-storage/upload-sessions/{id} | Abort Upload Session |

FileStorageApi | upload_sessions_finish | POST /file-storage/upload-sessions/{id}/finish | Finish Upload Session |

FileStorageApi | upload_sessions_one | GET /file-storage/upload-sessions/{id} | Get Upload Session |

HrisApi | companies_add | POST /hris/companies | Create Company |

HrisApi | companies_all | GET /hris/companies | List Companies |

HrisApi | companies_delete | DELETE /hris/companies/{id} | Delete Company |

HrisApi | companies_one | GET /hris/companies/{id} | Get Company |

HrisApi | companies_update | PATCH /hris/companies/{id} | Update Company |

HrisApi | departments_add | POST /hris/departments | Create Department |

HrisApi | departments_all | GET /hris/departments | List Departments |

HrisApi | departments_delete | DELETE /hris/departments/{id} | Delete Department |

HrisApi | departments_one | GET /hris/departments/{id} | Get Department |

HrisApi | departments_update | PATCH /hris/departments/{id} | Update Department |

HrisApi | employee_payrolls_all | GET /hris/payrolls/employees/{employee_id} | List Employee Payrolls |

HrisApi | employee_payrolls_one | GET /hris/payrolls/employees/{employee_id}/payrolls/{payroll_id} | Get Employee Payroll |

HrisApi | employee_schedules_all | GET /hris/schedules/employees/{employee_id} | List Employee Schedules |

HrisApi | employees_add | POST /hris/employees | Create Employee |

HrisApi | employees_all | GET /hris/employees | List Employees |

HrisApi | employees_delete | DELETE /hris/employees/{id} | Delete Employee |

HrisApi | employees_one | GET /hris/employees/{id} | Get Employee |

HrisApi | employees_update | PATCH /hris/employees/{id} | Update Employee |

HrisApi | payrolls_all | GET /hris/payrolls | List Payroll |

HrisApi | payrolls_one | GET /hris/payrolls/{payroll_id} | Get Payroll |

HrisApi | time_off_requests_add | POST /hris/time-off-requests | Create Time Off Request |

HrisApi | time_off_requests_all | GET /hris/time-off-requests | List Time Off Requests |

HrisApi | time_off_requests_delete | DELETE /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Delete Time Off Request |

HrisApi | time_off_requests_one | GET /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Get Time Off Request |

HrisApi | time_off_requests_update | PATCH /hris/time-off-requests/employees/{employee_id}/time-off-requests/{id} | Update Time Off Request |

IssueTrackingApi | collection_tags_all | GET /issue-tracking/collections/{collection_id}/tags | List Tags |

IssueTrackingApi | collection_ticket_comments_add | POST /issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments | Create Comment |

IssueTrackingApi | collection_ticket_comments_all | GET /issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments | List Comments |

IssueTrackingApi | collection_ticket_comments_delete | DELETE /issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments/{id} | Delete Comment |

IssueTrackingApi | collection_ticket_comments_one | GET /issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments/{id} | Get Comment |

IssueTrackingApi | collection_ticket_comments_update | PATCH /issue-tracking/collections/{collection_id}/tickets/{ticket_id}/comments/{id} | Update Comment |

IssueTrackingApi | collection_tickets_add | POST /issue-tracking/collections/{collection_id}/tickets | Create Ticket |

IssueTrackingApi | collection_tickets_all | GET /issue-tracking/collections/{collection_id}/tickets | List Tickets |

IssueTrackingApi | collection_tickets_delete | DELETE /issue-tracking/collections/{collection_id}/tickets/{ticket_id} | Delete Ticket |

IssueTrackingApi | collection_tickets_one | GET /issue-tracking/collections/{collection_id}/tickets/{ticket_id} | Get Ticket |

IssueTrackingApi | collection_tickets_update | PATCH /issue-tracking/collections/{collection_id}/tickets/{ticket_id} | Update Ticket |

IssueTrackingApi | collection_users_all | GET /issue-tracking/collections/{collection_id}/users | List Users |

IssueTrackingApi | collection_users_one | GET /issue-tracking/collections/{collection_id}/users/{id} | Get user |

IssueTrackingApi | collections_all | GET /issue-tracking/collections | List Collections |

IssueTrackingApi | collections_one | GET /issue-tracking/collections/{collection_id} | Get Collection |

LeadApi | leads_add | POST /lead/leads | Create lead |

LeadApi | leads_all | GET /lead/leads | List leads |

LeadApi | leads_delete | DELETE /lead/leads/{id} | Delete lead |

LeadApi | leads_one | GET /lead/leads/{id} | Get lead |

LeadApi | leads_update | PATCH /lead/leads/{id} | Update lead |

PosApi | items_add | POST /pos/items | Create Item |

PosApi | items_all | GET /pos/items | List Items |

PosApi | items_delete | DELETE /pos/items/{id} | Delete Item |

PosApi | items_one | GET /pos/items/{id} | Get Item |

PosApi | items_update | PATCH /pos/items/{id} | Update Item |

PosApi | locations_add | POST /pos/locations | Create Location |

PosApi | locations_all | GET /pos/locations | List Locations |

PosApi | locations_delete | DELETE /pos/locations/{id} | Delete Location |

PosApi | locations_one | GET /pos/locations/{id} | Get Location |

PosApi | locations_update | PATCH /pos/locations/{id} | Update Location |

PosApi | merchants_add | POST /pos/merchants | Create Merchant |

PosApi | merchants_all | GET /pos/merchants | List Merchants |

PosApi | merchants_delete | DELETE /pos/merchants/{id} | Delete Merchant |

PosApi | merchants_one | GET /pos/merchants/{id} | Get Merchant |

PosApi | merchants_update | PATCH /pos/merchants/{id} | Update Merchant |

PosApi | modifier_groups_add | POST /pos/modifier-groups | Create Modifier Group |

PosApi | modifier_groups_all | GET /pos/modifier-groups | List Modifier Groups |

PosApi | modifier_groups_delete | DELETE /pos/modifier-groups/{id} | Delete Modifier Group |

PosApi | modifier_groups_one | GET /pos/modifier-groups/{id} | Get Modifier Group |

PosApi | modifier_groups_update | PATCH /pos/modifier-groups/{id} | Update Modifier Group |

PosApi | modifiers_add | POST /pos/modifiers | Create Modifier |

PosApi | modifiers_all | GET /pos/modifiers | List Modifiers |

PosApi | modifiers_delete | DELETE /pos/modifiers/{id} | Delete Modifier |

PosApi | modifiers_one | GET /pos/modifiers/{id} | Get Modifier |

PosApi | modifiers_update | PATCH /pos/modifiers/{id} | Update Modifier |

PosApi | order_types_add | POST /pos/order-types | Create Order Type |

PosApi | order_types_all | GET /pos/order-types | List Order Types |

PosApi | order_types_delete | DELETE /pos/order-types/{id} | Delete Order Type |

PosApi | order_types_one | GET /pos/order-types/{id} | Get Order Type |

PosApi | order_types_update | PATCH /pos/order-types/{id} | Update Order Type |

PosApi | orders_add | POST /pos/orders | Create Order |

PosApi | orders_all | GET /pos/orders | List Orders |

PosApi | orders_delete | DELETE /pos/orders/{id} | Delete Order |

PosApi | orders_one | GET /pos/orders/{id} | Get Order |

PosApi | orders_pay | POST /pos/orders/{id}/pay | Pay Order |

PosApi | orders_update | PATCH /pos/orders/{id} | Update Order |

PosApi | payments_add | POST /pos/payments | Create Payment |

PosApi | payments_all | GET /pos/payments | List Payments |

PosApi | payments_delete | DELETE /pos/payments/{id} | Delete Payment |

PosApi | payments_one | GET /pos/payments/{id} | Get Payment |

PosApi | payments_update | PATCH /pos/payments/{id} | Update Payment |

PosApi | tenders_add | POST /pos/tenders | Create Tender |

PosApi | tenders_all | GET /pos/tenders | List Tenders |

PosApi | tenders_delete | DELETE /pos/tenders/{id} | Delete Tender |

PosApi | tenders_one | GET /pos/tenders/{id} | Get Tender |

PosApi | tenders_update | PATCH /pos/tenders/{id} | Update Tender |

SmsApi | messages_add | POST /sms/messages | Create Message |

SmsApi | messages_all | GET /sms/messages | List Messages |

SmsApi | messages_delete | DELETE /sms/messages/{id} | Delete Message |

SmsApi | messages_one | GET /sms/messages/{id} | Get Message |

SmsApi | messages_update | PATCH /sms/messages/{id} | Update Message |

VaultApi | connection_custom_mappings_all | GET /vault/connections/{unified_api}/{service_id}/{resource}/custom-mappings | List connection custom mappings |

VaultApi | connection_settings_all | GET /vault/connections/{unified_api}/{service_id}/{resource}/config | Get resource settings |

VaultApi | connection_settings_update | PATCH /vault/connections/{unified_api}/{service_id}/{resource}/config | Update settings |

VaultApi | connections_all | GET /vault/connections | Get all connections |

VaultApi | connections_delete | DELETE /vault/connections/{unified_api}/{service_id} | Deletes a connection |

VaultApi | connections_import | POST /vault/connections/{unified_api}/{service_id}/import | Import connection |

VaultApi | connections_one | GET /vault/connections/{unified_api}/{service_id} | Get connection |

VaultApi | connections_token | POST /vault/connections/{unified_api}/{service_id}/token | Authorize Access Token |

VaultApi | connections_update | PATCH /vault/connections/{unified_api}/{service_id} | Update connection |

VaultApi | consumer_request_counts_all | GET /vault/consumers/{consumer_id}/stats | Consumer request counts |

VaultApi | consumers_add | POST /vault/consumers | Create consumer |

VaultApi | consumers_all | GET /vault/consumers | Get all consumers |

VaultApi | consumers_delete | DELETE /vault/consumers/{consumer_id} | Delete consumer |

VaultApi | consumers_one | GET /vault/consumers/{consumer_id} | Get consumer |

VaultApi | consumers_update | PATCH /vault/consumers/{consumer_id} | Update consumer |

VaultApi | create_callback_state | POST /vault/connections/{unified_api}/{service_id}/callback-state | Create Callback State |

VaultApi | custom_fields_all | GET /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields | Get resource custom fields |

VaultApi | custom_mappings_all | GET /vault/custom-mappings/{unified_api}/{service_id} | List custom mappings |

VaultApi | logs_all | GET /vault/logs | Get all consumer request logs |

VaultApi | sessions_create | POST /vault/sessions | Create Session |

VaultApi | validate_connection_state | POST /vault/connections/{unified_api}/{service_id}/validate | Validate Connection State |

WebhookApi | event_logs_all | GET /webhook/logs | List event logs |

WebhookApi | webhooks_add | POST /webhook/webhooks | Create webhook subscription |

WebhookApi | webhooks_all | GET /webhook/webhooks | List webhook subscriptions |

WebhookApi | webhooks_delete | DELETE /webhook/webhooks/{id} | Delete webhook subscription |

WebhookApi | webhooks_one | GET /webhook/webhooks/{id} | Get webhook subscription |

WebhookApi | webhooks_update | PATCH /webhook/webhooks/{id} | Update webhook subscription |

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

applicationId

  • Type: API key
  • API key parameter name: x-apideck-app-id
  • Location: HTTP header

consumerId

  • Type: API key
  • API key parameter name: x-apideck-consumer-id
  • Location: HTTP header

Author

[email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in apideck.apis and apideck.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from apideck.api.default_api import DefaultApi
  • from apideck.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import apideck
from apideck.apis import *
from apideck.models import *

About

No description, website, or topics provided.

Resources

Readme

License

View license
Activity
Custom properties

Stars

0 stars

Watchers

5 watching

Forks

1 fork
Report repository

Releases 33

1.4.6 Latest
Oct 22, 2024
+ 32 releases

Packages

No packages published

Contributors 7

Languages