diff --git a/.gitignore b/.gitignore index ff7eaf959..3c735a047 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ redis_data .pnpm-store/ .npmrc .vscode +docs/objects \ No newline at end of file diff --git a/docs/_snippets/snippet-example.mdx b/docs/_snippets/snippet-example.mdx deleted file mode 100644 index 089334c54..000000000 --- a/docs/_snippets/snippet-example.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## My Snippet - -This is an example of a reusable snippet diff --git a/docs/accounting/accountingbalancesheets/retrieve-a-balancesheet.mdx b/docs/accounting/accountingbalancesheets/retrieve-a-balancesheet.mdx new file mode 100644 index 000000000..2c0ad0815 --- /dev/null +++ b/docs/accounting/accountingbalancesheets/retrieve-a-balancesheet.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/balancesheet/{id} +--- \ No newline at end of file diff --git a/docs/accounting/accounts/create-a-account.mdx b/docs/accounting/accounts/create-a-account.mdx new file mode 100644 index 000000000..8e54c9e5f --- /dev/null +++ b/docs/accounting/accounts/create-a-account.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/account +--- \ No newline at end of file diff --git a/docs/accounting/accounts/list-accounts.mdx b/docs/accounting/accounts/list-accounts.mdx new file mode 100644 index 000000000..d54c2391c --- /dev/null +++ b/docs/accounting/accounts/list-accounts.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/account +--- \ No newline at end of file diff --git a/docs/accounting/accounts/retrieve-a-account.mdx b/docs/accounting/accounts/retrieve-a-account.mdx new file mode 100644 index 000000000..84cc787bd --- /dev/null +++ b/docs/accounting/accounts/retrieve-a-account.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/account/{id} +--- \ No newline at end of file diff --git a/docs/accounting/addresses/list-addresss.mdx b/docs/accounting/addresses/list-addresss.mdx new file mode 100644 index 000000000..b04e0effd --- /dev/null +++ b/docs/accounting/addresses/list-addresss.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/address +--- \ No newline at end of file diff --git a/docs/accounting/addresses/retrieve-a-address.mdx b/docs/accounting/addresses/retrieve-a-address.mdx new file mode 100644 index 000000000..832f8e27f --- /dev/null +++ b/docs/accounting/addresses/retrieve-a-address.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/address/{id} +--- \ No newline at end of file diff --git a/docs/accounting/attachments/create-a-attachment.mdx b/docs/accounting/attachments/create-a-attachment.mdx new file mode 100644 index 000000000..7bf846f1f --- /dev/null +++ b/docs/accounting/attachments/create-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/attachment +--- \ No newline at end of file diff --git a/docs/accounting/attachments/list-attachments.mdx b/docs/accounting/attachments/list-attachments.mdx new file mode 100644 index 000000000..dceeb5854 --- /dev/null +++ b/docs/accounting/attachments/list-attachments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/attachment +--- \ No newline at end of file diff --git a/docs/accounting/attachments/retrieve-a-attachment.mdx b/docs/accounting/attachments/retrieve-a-attachment.mdx new file mode 100644 index 000000000..a6828b942 --- /dev/null +++ b/docs/accounting/attachments/retrieve-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/attachment/{id} +--- \ No newline at end of file diff --git a/docs/accounting/balancesheets/list-balancesheets.mdx b/docs/accounting/balancesheets/list-balancesheets.mdx new file mode 100644 index 000000000..f2efb5f5c --- /dev/null +++ b/docs/accounting/balancesheets/list-balancesheets.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/balancesheet +--- \ No newline at end of file diff --git a/docs/accounting/balancesheets/retrieve-a-balancesheet.mdx b/docs/accounting/balancesheets/retrieve-a-balancesheet.mdx new file mode 100644 index 000000000..2c0ad0815 --- /dev/null +++ b/docs/accounting/balancesheets/retrieve-a-balancesheet.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/balancesheet/{id} +--- \ No newline at end of file diff --git a/docs/accounting/cashflowstatements/list-cashflowstatements.mdx b/docs/accounting/cashflowstatements/list-cashflowstatements.mdx new file mode 100644 index 000000000..dc71d41bd --- /dev/null +++ b/docs/accounting/cashflowstatements/list-cashflowstatements.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/cashflowstatement +--- \ No newline at end of file diff --git a/docs/accounting/cashflowstatements/retrieve-a-cashflowstatement.mdx b/docs/accounting/cashflowstatements/retrieve-a-cashflowstatement.mdx new file mode 100644 index 000000000..53b9d24a5 --- /dev/null +++ b/docs/accounting/cashflowstatements/retrieve-a-cashflowstatement.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/cashflowstatement/{id} +--- \ No newline at end of file diff --git a/docs/accounting/companyinfos/list-companyinfos.mdx b/docs/accounting/companyinfos/list-companyinfos.mdx new file mode 100644 index 000000000..901e8fc4b --- /dev/null +++ b/docs/accounting/companyinfos/list-companyinfos.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/companyinfo +--- \ No newline at end of file diff --git a/docs/accounting/companyinfos/retrieve-a-companyinfo.mdx b/docs/accounting/companyinfos/retrieve-a-companyinfo.mdx new file mode 100644 index 000000000..fcd6f3184 --- /dev/null +++ b/docs/accounting/companyinfos/retrieve-a-companyinfo.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/companyinfo/{id} +--- \ No newline at end of file diff --git a/docs/accounting/contacts/create-a-contact.mdx b/docs/accounting/contacts/create-a-contact.mdx new file mode 100644 index 000000000..b7fb52914 --- /dev/null +++ b/docs/accounting/contacts/create-a-contact.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/contact +--- \ No newline at end of file diff --git a/docs/accounting/contacts/list-contacts.mdx b/docs/accounting/contacts/list-contacts.mdx new file mode 100644 index 000000000..10acb873e --- /dev/null +++ b/docs/accounting/contacts/list-contacts.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/contact +--- \ No newline at end of file diff --git a/docs/accounting/contacts/retrieve-a-contact.mdx b/docs/accounting/contacts/retrieve-a-contact.mdx new file mode 100644 index 000000000..4b44622f3 --- /dev/null +++ b/docs/accounting/contacts/retrieve-a-contact.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/contact/{id} +--- \ No newline at end of file diff --git a/docs/accounting/creditnotes/list-creditnotes.mdx b/docs/accounting/creditnotes/list-creditnotes.mdx new file mode 100644 index 000000000..d0c649410 --- /dev/null +++ b/docs/accounting/creditnotes/list-creditnotes.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/creditnote +--- \ No newline at end of file diff --git a/docs/accounting/creditnotes/retrieve-a-creditnote.mdx b/docs/accounting/creditnotes/retrieve-a-creditnote.mdx new file mode 100644 index 000000000..ef24795d3 --- /dev/null +++ b/docs/accounting/creditnotes/retrieve-a-creditnote.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/creditnote/{id} +--- \ No newline at end of file diff --git a/docs/accounting/expenses/create-a-expense.mdx b/docs/accounting/expenses/create-a-expense.mdx new file mode 100644 index 000000000..27b39340b --- /dev/null +++ b/docs/accounting/expenses/create-a-expense.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/expense +--- \ No newline at end of file diff --git a/docs/accounting/expenses/list-expenses.mdx b/docs/accounting/expenses/list-expenses.mdx new file mode 100644 index 000000000..96e6fc98b --- /dev/null +++ b/docs/accounting/expenses/list-expenses.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/expense +--- \ No newline at end of file diff --git a/docs/accounting/expenses/retrieve-a-expense.mdx b/docs/accounting/expenses/retrieve-a-expense.mdx new file mode 100644 index 000000000..b154f0a87 --- /dev/null +++ b/docs/accounting/expenses/retrieve-a-expense.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/expense/{id} +--- \ No newline at end of file diff --git a/docs/accounting/incomestatements/list-incomestatements.mdx b/docs/accounting/incomestatements/list-incomestatements.mdx new file mode 100644 index 000000000..b4fee9183 --- /dev/null +++ b/docs/accounting/incomestatements/list-incomestatements.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/incomestatement +--- \ No newline at end of file diff --git a/docs/accounting/incomestatements/retrieve-a-incomestatement.mdx b/docs/accounting/incomestatements/retrieve-a-incomestatement.mdx new file mode 100644 index 000000000..934381c5c --- /dev/null +++ b/docs/accounting/incomestatements/retrieve-a-incomestatement.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/incomestatement/{id} +--- \ No newline at end of file diff --git a/docs/accounting/invoices/create-a-invoice.mdx b/docs/accounting/invoices/create-a-invoice.mdx new file mode 100644 index 000000000..130b117bd --- /dev/null +++ b/docs/accounting/invoices/create-a-invoice.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/invoice +--- \ No newline at end of file diff --git a/docs/accounting/invoices/list-invoices.mdx b/docs/accounting/invoices/list-invoices.mdx new file mode 100644 index 000000000..0908a70c5 --- /dev/null +++ b/docs/accounting/invoices/list-invoices.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/invoice +--- \ No newline at end of file diff --git a/docs/accounting/invoices/retrieve-a-invoice.mdx b/docs/accounting/invoices/retrieve-a-invoice.mdx new file mode 100644 index 000000000..bafe99c95 --- /dev/null +++ b/docs/accounting/invoices/retrieve-a-invoice.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/invoice/{id} +--- \ No newline at end of file diff --git a/docs/accounting/items/list-items.mdx b/docs/accounting/items/list-items.mdx new file mode 100644 index 000000000..61f2869cb --- /dev/null +++ b/docs/accounting/items/list-items.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/item +--- \ No newline at end of file diff --git a/docs/accounting/items/retrieve-a-item.mdx b/docs/accounting/items/retrieve-a-item.mdx new file mode 100644 index 000000000..886a230e9 --- /dev/null +++ b/docs/accounting/items/retrieve-a-item.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/item/{id} +--- \ No newline at end of file diff --git a/docs/accounting/journalentries/create-a-journalentry.mdx b/docs/accounting/journalentries/create-a-journalentry.mdx new file mode 100644 index 000000000..5cd50058f --- /dev/null +++ b/docs/accounting/journalentries/create-a-journalentry.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/journalentry +--- \ No newline at end of file diff --git a/docs/accounting/journalentries/list-journalentrys.mdx b/docs/accounting/journalentries/list-journalentrys.mdx new file mode 100644 index 000000000..2389a5975 --- /dev/null +++ b/docs/accounting/journalentries/list-journalentrys.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/journalentry +--- \ No newline at end of file diff --git a/docs/accounting/journalentries/retrieve-a-journalentry.mdx b/docs/accounting/journalentries/retrieve-a-journalentry.mdx new file mode 100644 index 000000000..650e13c47 --- /dev/null +++ b/docs/accounting/journalentries/retrieve-a-journalentry.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/journalentry/{id} +--- \ No newline at end of file diff --git a/docs/_snippets/footer.mdx b/docs/accounting/overview.mdx similarity index 100% rename from docs/_snippets/footer.mdx rename to docs/accounting/overview.mdx diff --git a/docs/accounting/payments/create-a-payment.mdx b/docs/accounting/payments/create-a-payment.mdx new file mode 100644 index 000000000..fd222795b --- /dev/null +++ b/docs/accounting/payments/create-a-payment.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/payment +--- \ No newline at end of file diff --git a/docs/accounting/payments/list-payments.mdx b/docs/accounting/payments/list-payments.mdx new file mode 100644 index 000000000..4c1606cb9 --- /dev/null +++ b/docs/accounting/payments/list-payments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/payment +--- \ No newline at end of file diff --git a/docs/accounting/payments/retrieve-a-payment.mdx b/docs/accounting/payments/retrieve-a-payment.mdx new file mode 100644 index 000000000..63e3bb222 --- /dev/null +++ b/docs/accounting/payments/retrieve-a-payment.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/payment/{id} +--- \ No newline at end of file diff --git a/docs/accounting/phonenumbers/list-phonenumbers.mdx b/docs/accounting/phonenumbers/list-phonenumbers.mdx new file mode 100644 index 000000000..fa9920dea --- /dev/null +++ b/docs/accounting/phonenumbers/list-phonenumbers.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/phonenumber +--- \ No newline at end of file diff --git a/docs/accounting/phonenumbers/retrieve-a-phonenumber.mdx b/docs/accounting/phonenumbers/retrieve-a-phonenumber.mdx new file mode 100644 index 000000000..9cf4582ce --- /dev/null +++ b/docs/accounting/phonenumbers/retrieve-a-phonenumber.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/phonenumber/{id} +--- \ No newline at end of file diff --git a/docs/accounting/purchaseorders/create-a-purchaseorder.mdx b/docs/accounting/purchaseorders/create-a-purchaseorder.mdx new file mode 100644 index 000000000..16eceb154 --- /dev/null +++ b/docs/accounting/purchaseorders/create-a-purchaseorder.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /accounting/purchaseorder +--- \ No newline at end of file diff --git a/docs/accounting/purchaseorders/list-purchaseorders.mdx b/docs/accounting/purchaseorders/list-purchaseorders.mdx new file mode 100644 index 000000000..faf5ea5fb --- /dev/null +++ b/docs/accounting/purchaseorders/list-purchaseorders.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/purchaseorder +--- \ No newline at end of file diff --git a/docs/accounting/purchaseorders/retrieve-a-purchaseorder.mdx b/docs/accounting/purchaseorders/retrieve-a-purchaseorder.mdx new file mode 100644 index 000000000..951236bce --- /dev/null +++ b/docs/accounting/purchaseorders/retrieve-a-purchaseorder.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/purchaseorder/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/teams/api/create.mdx b/docs/accounting/quickstart.mdx similarity index 100% rename from docs/ticketing/teams/api/create.mdx rename to docs/accounting/quickstart.mdx diff --git a/docs/accounting/taxrates/list-taxrates.mdx b/docs/accounting/taxrates/list-taxrates.mdx new file mode 100644 index 000000000..e8b93eb38 --- /dev/null +++ b/docs/accounting/taxrates/list-taxrates.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/taxrate +--- \ No newline at end of file diff --git a/docs/accounting/taxrates/retrieve-a-taxrate.mdx b/docs/accounting/taxrates/retrieve-a-taxrate.mdx new file mode 100644 index 000000000..5fce1d49b --- /dev/null +++ b/docs/accounting/taxrates/retrieve-a-taxrate.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/taxrate/{id} +--- \ No newline at end of file diff --git a/docs/accounting/trackingcategories/list-trackingcategorys.mdx b/docs/accounting/trackingcategories/list-trackingcategorys.mdx new file mode 100644 index 000000000..03e26e80a --- /dev/null +++ b/docs/accounting/trackingcategories/list-trackingcategorys.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/trackingcategory +--- \ No newline at end of file diff --git a/docs/accounting/trackingcategories/retrieve-a-trackingcategory.mdx b/docs/accounting/trackingcategories/retrieve-a-trackingcategory.mdx new file mode 100644 index 000000000..214055f8c --- /dev/null +++ b/docs/accounting/trackingcategories/retrieve-a-trackingcategory.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/trackingcategory/{id} +--- \ No newline at end of file diff --git a/docs/accounting/transactions/list-transactions.mdx b/docs/accounting/transactions/list-transactions.mdx new file mode 100644 index 000000000..d5a9a1b70 --- /dev/null +++ b/docs/accounting/transactions/list-transactions.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/transaction +--- \ No newline at end of file diff --git a/docs/accounting/transactions/retrieve-a-transaction.mdx b/docs/accounting/transactions/retrieve-a-transaction.mdx new file mode 100644 index 000000000..adaca1621 --- /dev/null +++ b/docs/accounting/transactions/retrieve-a-transaction.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/transaction/{id} +--- \ No newline at end of file diff --git a/docs/accounting/vendorcredits/list-vendorcredits.mdx b/docs/accounting/vendorcredits/list-vendorcredits.mdx new file mode 100644 index 000000000..e96bac2e6 --- /dev/null +++ b/docs/accounting/vendorcredits/list-vendorcredits.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/vendorcredit +--- \ No newline at end of file diff --git a/docs/accounting/vendorcredits/retrieve-a-vendorcredit.mdx b/docs/accounting/vendorcredits/retrieve-a-vendorcredit.mdx new file mode 100644 index 000000000..dce743772 --- /dev/null +++ b/docs/accounting/vendorcredits/retrieve-a-vendorcredit.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /accounting/vendorcredit/{id} +--- \ No newline at end of file diff --git a/docs/ats/activities/create-a-activity.mdx b/docs/ats/activities/create-a-activity.mdx new file mode 100644 index 000000000..cabc6a61d --- /dev/null +++ b/docs/ats/activities/create-a-activity.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ats/activity +--- \ No newline at end of file diff --git a/docs/ats/activities/list-activities.mdx b/docs/ats/activities/list-activities.mdx new file mode 100644 index 000000000..223db3389 --- /dev/null +++ b/docs/ats/activities/list-activities.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/activity +--- \ No newline at end of file diff --git a/docs/ats/activities/retrieve-a-activity.mdx b/docs/ats/activities/retrieve-a-activity.mdx new file mode 100644 index 000000000..f0a2e448a --- /dev/null +++ b/docs/ats/activities/retrieve-a-activity.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/activity/{id} +--- \ No newline at end of file diff --git a/docs/ats/applications/create-an-application.mdx b/docs/ats/applications/create-an-application.mdx new file mode 100644 index 000000000..79785d276 --- /dev/null +++ b/docs/ats/applications/create-an-application.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ats/application +--- \ No newline at end of file diff --git a/docs/ats/applications/list-applications.mdx b/docs/ats/applications/list-applications.mdx new file mode 100644 index 000000000..29a5b4de5 --- /dev/null +++ b/docs/ats/applications/list-applications.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/application +--- \ No newline at end of file diff --git a/docs/ats/applications/retrieve-an-application.mdx b/docs/ats/applications/retrieve-an-application.mdx new file mode 100644 index 000000000..306cd93b6 --- /dev/null +++ b/docs/ats/applications/retrieve-an-application.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/application/{id} +--- \ No newline at end of file diff --git a/docs/ats/attachments/create-a-attachment.mdx b/docs/ats/attachments/create-a-attachment.mdx new file mode 100644 index 000000000..9d70911a4 --- /dev/null +++ b/docs/ats/attachments/create-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ats/attachment +--- \ No newline at end of file diff --git a/docs/ats/attachments/list-attachments.mdx b/docs/ats/attachments/list-attachments.mdx new file mode 100644 index 000000000..2c1ade33f --- /dev/null +++ b/docs/ats/attachments/list-attachments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/attachment +--- \ No newline at end of file diff --git a/docs/ats/attachments/retrieve-a-attachment.mdx b/docs/ats/attachments/retrieve-a-attachment.mdx new file mode 100644 index 000000000..65258d781 --- /dev/null +++ b/docs/ats/attachments/retrieve-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/attachment/{id} +--- \ No newline at end of file diff --git a/docs/ats/candidates/create-a-candidate.mdx b/docs/ats/candidates/create-a-candidate.mdx new file mode 100644 index 000000000..59e4c0c5b --- /dev/null +++ b/docs/ats/candidates/create-a-candidate.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ats/candidate +--- \ No newline at end of file diff --git a/docs/ats/candidates/list-candidates.mdx b/docs/ats/candidates/list-candidates.mdx new file mode 100644 index 000000000..9905b8c9c --- /dev/null +++ b/docs/ats/candidates/list-candidates.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/candidate +--- \ No newline at end of file diff --git a/docs/ats/candidates/retrieve-a-candidate.mdx b/docs/ats/candidates/retrieve-a-candidate.mdx new file mode 100644 index 000000000..6aecc109b --- /dev/null +++ b/docs/ats/candidates/retrieve-a-candidate.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/candidate/{id} +--- \ No newline at end of file diff --git a/docs/ats/departments/list-departments.mdx b/docs/ats/departments/list-departments.mdx new file mode 100644 index 000000000..2e368d55d --- /dev/null +++ b/docs/ats/departments/list-departments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/department +--- \ No newline at end of file diff --git a/docs/ats/departments/retrieve-a-department.mdx b/docs/ats/departments/retrieve-a-department.mdx new file mode 100644 index 000000000..f4af2b3e8 --- /dev/null +++ b/docs/ats/departments/retrieve-a-department.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/department/{id} +--- \ No newline at end of file diff --git a/docs/ats/eeocs/list-eeocss.mdx b/docs/ats/eeocs/list-eeocss.mdx new file mode 100644 index 000000000..66d816e73 --- /dev/null +++ b/docs/ats/eeocs/list-eeocss.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/eeocs +--- \ No newline at end of file diff --git a/docs/ats/eeocs/retrieve-a-eeocs.mdx b/docs/ats/eeocs/retrieve-a-eeocs.mdx new file mode 100644 index 000000000..20a204a1c --- /dev/null +++ b/docs/ats/eeocs/retrieve-a-eeocs.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/eeocs/{id} +--- \ No newline at end of file diff --git a/docs/ats/interviews/create-a-interview.mdx b/docs/ats/interviews/create-a-interview.mdx new file mode 100644 index 000000000..b12099d11 --- /dev/null +++ b/docs/ats/interviews/create-a-interview.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ats/interview +--- \ No newline at end of file diff --git a/docs/ats/interviews/list-interviews.mdx b/docs/ats/interviews/list-interviews.mdx new file mode 100644 index 000000000..21d8e22f4 --- /dev/null +++ b/docs/ats/interviews/list-interviews.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/interview +--- \ No newline at end of file diff --git a/docs/ats/interviews/retrieve-a-interview.mdx b/docs/ats/interviews/retrieve-a-interview.mdx new file mode 100644 index 000000000..7f579e7d8 --- /dev/null +++ b/docs/ats/interviews/retrieve-a-interview.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/interview/{id} +--- \ No newline at end of file diff --git a/docs/ats/jobinterviewstages/list-jobinterviewstages.mdx b/docs/ats/jobinterviewstages/list-jobinterviewstages.mdx new file mode 100644 index 000000000..263be14fa --- /dev/null +++ b/docs/ats/jobinterviewstages/list-jobinterviewstages.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/jobinterviewstage +--- \ No newline at end of file diff --git a/docs/ats/jobinterviewstages/retrieve-a-jobinterviewstage.mdx b/docs/ats/jobinterviewstages/retrieve-a-jobinterviewstage.mdx new file mode 100644 index 000000000..680bc16a7 --- /dev/null +++ b/docs/ats/jobinterviewstages/retrieve-a-jobinterviewstage.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/jobinterviewstage/{id} +--- \ No newline at end of file diff --git a/docs/ats/jobs/list-jobs.mdx b/docs/ats/jobs/list-jobs.mdx new file mode 100644 index 000000000..5b776c149 --- /dev/null +++ b/docs/ats/jobs/list-jobs.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/job +--- \ No newline at end of file diff --git a/docs/ats/jobs/retrieve-a-job.mdx b/docs/ats/jobs/retrieve-a-job.mdx new file mode 100644 index 000000000..dff77d300 --- /dev/null +++ b/docs/ats/jobs/retrieve-a-job.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/job/{id} +--- \ No newline at end of file diff --git a/docs/ats/offers/list-offers.mdx b/docs/ats/offers/list-offers.mdx new file mode 100644 index 000000000..31042e75e --- /dev/null +++ b/docs/ats/offers/list-offers.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/offer +--- \ No newline at end of file diff --git a/docs/ats/offers/retrieve-a-offer.mdx b/docs/ats/offers/retrieve-a-offer.mdx new file mode 100644 index 000000000..b1769a24e --- /dev/null +++ b/docs/ats/offers/retrieve-a-offer.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/offer/{id} +--- \ No newline at end of file diff --git a/docs/ats/offices/list-offices.mdx b/docs/ats/offices/list-offices.mdx new file mode 100644 index 000000000..867b02981 --- /dev/null +++ b/docs/ats/offices/list-offices.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/office +--- \ No newline at end of file diff --git a/docs/ats/offices/retrieve-a-office.mdx b/docs/ats/offices/retrieve-a-office.mdx new file mode 100644 index 000000000..7277dca24 --- /dev/null +++ b/docs/ats/offices/retrieve-a-office.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/office/{id} +--- \ No newline at end of file diff --git a/docs/ats/rejectreasons/list-rejectreasons.mdx b/docs/ats/rejectreasons/list-rejectreasons.mdx new file mode 100644 index 000000000..b9368ed8f --- /dev/null +++ b/docs/ats/rejectreasons/list-rejectreasons.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/rejectreason +--- \ No newline at end of file diff --git a/docs/ats/rejectreasons/retrieve-a-rejectreason.mdx b/docs/ats/rejectreasons/retrieve-a-rejectreason.mdx new file mode 100644 index 000000000..fc960c736 --- /dev/null +++ b/docs/ats/rejectreasons/retrieve-a-rejectreason.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/rejectreason/{id} +--- \ No newline at end of file diff --git a/docs/ats/scorecards/list-scorecards.mdx b/docs/ats/scorecards/list-scorecards.mdx new file mode 100644 index 000000000..9bc649cbc --- /dev/null +++ b/docs/ats/scorecards/list-scorecards.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/scorecard +--- \ No newline at end of file diff --git a/docs/ats/scorecards/retrieve-a-scorecard.mdx b/docs/ats/scorecards/retrieve-a-scorecard.mdx new file mode 100644 index 000000000..84f4737ed --- /dev/null +++ b/docs/ats/scorecards/retrieve-a-scorecard.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/scorecard/{id} +--- \ No newline at end of file diff --git a/docs/ats/tags/list-tags.mdx b/docs/ats/tags/list-tags.mdx new file mode 100644 index 000000000..af7ada2fe --- /dev/null +++ b/docs/ats/tags/list-tags.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/tag +--- \ No newline at end of file diff --git a/docs/ats/tags/retrieve-a-tag.mdx b/docs/ats/tags/retrieve-a-tag.mdx new file mode 100644 index 000000000..8eb27c3bf --- /dev/null +++ b/docs/ats/tags/retrieve-a-tag.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/tag/{id} +--- \ No newline at end of file diff --git a/docs/ats/users/list-users.mdx b/docs/ats/users/list-users.mdx new file mode 100644 index 000000000..dd2b0b042 --- /dev/null +++ b/docs/ats/users/list-users.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/user +--- \ No newline at end of file diff --git a/docs/ats/users/retrieve-a-user.mdx b/docs/ats/users/retrieve-a-user.mdx new file mode 100644 index 000000000..aa9de541d --- /dev/null +++ b/docs/ats/users/retrieve-a-user.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ats/user/{id} +--- \ No newline at end of file diff --git a/docs/crm/quick-start.mdx b/docs/crm/quickstart.mdx similarity index 100% rename from docs/crm/quick-start.mdx rename to docs/crm/quickstart.mdx diff --git a/docs/mint.json b/docs/mint.json index 49b53a481..113f9f9b2 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -1,473 +1,859 @@ { "$schema": "https://mintlify.com/schema.json", "name": "Panora Documentation", - "openapi": "https://raw.githubusercontent.com/panoratech/Panora/main/docs/openapi-with-code-samples.yaml", + "openapi": "https://raw.githubusercontent.com/panoratech/Panora/main/docs/openapi-with-code-samples.yaml", "primaryTab": { - "name": "Home" + "name": "Home" }, "analytics": { - "posthog": { - "apiKey": "phc_WhWJfNPOHAuWVdyTacGxrPa9JW54scnofA9KVEjFcFw" + "posthog": { + "apiKey": "phc_WhWJfNPOHAuWVdyTacGxrPa9JW54scnofA9KVEjFcFw" }, "hotjar": { - "hjid": "5154921", - "hjsv": "e2Bs3cIPcF08ngtrjwX+JBB8" - } + "hjid": "5154921", + "hjsv": "e2Bs3cIPcF08ngtrjwX+JBB8" + } }, "api": { - "baseUrl": "https://api.panora.dev", - "auth": { - "method": "bearer" - } + "baseUrl": "https://api.panora.dev", + "auth": { + "method": "bearer" + } }, "modeToggle": { - "default": "light", - "isHidden": false + "default": "light", + "isHidden": false }, "feedback": { - "thumbsRating": true, - "suggestEdit": true, - "raiseIssue": true + "thumbsRating": true, + "suggestEdit": true, + "raiseIssue": true }, "logo": { - "dark":"logo/white_logo.png", - "light":"logo/black_logo.png" + "dark": "logo/white_logo.png", + "light": "logo/black_logo.png" }, "favicon": "logo/fav.png", - "colors":{ - "anchors":{ - "from":"#000000", - "to":"#000000" + "colors": { + "anchors": { + "from": "#000000", + "to": "#000000" }, - "dark":"#000000", - "light":"#FFFFFF", - "primary":"#000000" - }, + "dark": "#000000", + "light": "#FFFFFF", + "primary": "#000000" + }, "topbarLinks": [ - { - "name": "Home", - "url": "https://panora.dev" - }, - { - "name": "Blog", - "url": "https://panora.dev/blog" - } + { + "name": "Home", + "url": "https://panora.dev" + }, + { + "name": "Blog", + "url": "https://panora.dev/blog" + } ], "topbarCtaButton": { - "type": "github", - "url": "https://github.com/panoratech/Panora" + "type": "github", + "url": "https://github.com/panoratech/Panora" }, "tabs": [ - { - "name": "CRM", - "url": "crm" - }, - { - "name": "Ticketing", - "url": "ticketing" - }, - { - "name": "API Reference", - "url": "api-reference" - } + { + "name": "Accounting", + "url": "accounting" + }, + { + "name": + + "ATS", + "url": "ats" + }, + { + "name": "CRM", + "url": "crm" + }, + { + "name": "Ticketing", + "url": "ticketing" + }, + { + "name": "API Reference", + "url": "api-reference" + } ], - "anchors": [ - ], + "anchors": [], "navigation": [ - { - "group": "Documentation", - "pages": [ - "welcome", - "quick-start", - "catalog" - - ] - }, - { - "group": "", - "pages": ["crm/overview", "crm/quick-start"] - }, - { - "group": "Unified Objects", - "pages": [ - { - "group": "Contacts", - "pages": [ "crm/contacts/overview", "crm/contacts/api/list", "crm/contacts/api/get", "crm/contacts/api/create", "crm/contacts/api/update" ] - }, - { - "group": "Companies", - "pages": [ "crm/companies/overview", "crm/companies/api/list", "crm/companies/api/get", "crm/companies/api/create", "crm/companies/api/update" ] - }, - { - "group": "Deals", - "pages": [ "crm/deals/overview", "crm/deals/api/list", "crm/deals/api/get", "crm/deals/api/create", "crm/deals/api/update" ] - }, - { - "group": "Notes", - "pages": [ "crm/notes/overview", "crm/notes/api/list", "crm/notes/api/get", "crm/notes/api/create" ] - }, - { - "group": "Engagements", - "pages": [ "crm/engagements/overview", "crm/engagements/api/list", "crm/engagements/api/get", "crm/engagements/api/create", "crm/engagements/api/update" ] - }, - { - "group": "Tasks", - "pages": [ "crm/tasks/overview", "crm/tasks/api/list", "crm/tasks/api/get"] - }, - { - "group": "Users", - "pages": [ "crm/users/overview", "crm/users/api/list", "crm/users/api/get" ] - } - ] - }, - { - "group": "", - "pages": [ - "ticketing/overview", - "ticketing/quick-start" - ] - }, - { - "group": "Core Objects", - "pages": [ - { - "group": "Tickets", - "pages": [ "ticketing/tickets/overview", "ticketing/tickets/api/list" , "ticketing/tickets/api/get", "ticketing/tickets/api/create", "ticketing/tickets/api/update" ] - }, - { - "group": "Comments", - "pages": [ "ticketing/comments/overview", "ticketing/comments/api/list", "ticketing/comments/api/get", "ticketing/comments/api/create", "ticketing/comments/api/update" ] - }, - { - "group": "Users", - "pages": [ "ticketing/users/overview", "ticketing/users/api/list", "ticketing/users/api/get" ] - }, - { - "group": "Contacts", - "pages": [ "ticketing/contacts/overview", "ticketing/contacts/api/list", "ticketing/contacts/api/get", "ticketing/contacts/api/create", "ticketing/contacts/api/update" ] - }, - { - "group": "Accounts", - "pages": [ "ticketing/accounts/overview", "ticketing/accounts/api/list", "ticketing/accounts/api/get", "ticketing/accounts/api/create", "ticketing/accounts/api/update" ] - }, - { - "group": "Tags", - "pages": [ "ticketing/tags/overview", "ticketing/tags/api/list", "ticketing/tags/api/get" ] - }, - { - "group": "Teams", - "pages": [ "ticketing/teams/overview", "ticketing/teams/api/list", "ticketing/teams/api/get" ] - } - ] - }, - { - "group": "", - "pages": [ - "api-reference/introduction", - "api-reference/authentication", - "api-reference/errors", - "api-reference/pagination" - ] - }, - { - "group": "Unified Objects", - "pages": [ - { - "group": "CRM", + { + "group": "Documentation", "pages": [ - { - "group": "Contact", - "pages": [ - "api-reference/crmcontact/list-a-batch-of-crm-contacts", - "api-reference/crmcontact/create-crm-contact", - "api-reference/crmcontact/update-a-crm-contact", - "api-reference/crmcontact/retrieve-a-crm-contact", - "api-reference/crmcontact/add-a-batch-of-crm-contacts" - ] - }, - { - "group": "Deal", - "pages": [ - "api-reference/crmdeal/list-a-batch-of-deals", - "api-reference/crmdeal/create-a-deal", - "api-reference/crmdeal/retrieve-a-deal", - "api-reference/crmdeal/update-a-deal", - "api-reference/crmdeal/add-a-batch-of-deals" - ] - }, - { - "group": "Note", - "pages": [ - "api-reference/crmnote/list-a-batch-of-notes", - "api-reference/crmnote/create-a-note", - "api-reference/crmnote/retrieve-a-note", - "api-reference/crmnote/add-a-batch-of-notes" - ] - }, - { - "group": "Company", - "pages": [ - "api-reference/crmcompany/list-a-batch-of-companies", - "api-reference/crmcompany/create-a-company", - "api-reference/crmcompany/update-a-company", - "api-reference/crmcompany/retrieve-a-company", - "api-reference/crmcompany/add-a-batch-of-companies" - ] - }, - { - "group": "Engagement", - "pages": [ - "api-reference/crmengagement/list-a-batch-of-engagements", - "api-reference/crmengagement/create-a-engagement", - "api-reference/crmengagement/update-a-engagement", - "api-reference/crmengagement/retrieve-a-engagement", - "api-reference/crmengagement/add-a-batch-of-engagements" - ] - }, - { - "group": "Stage", - "pages": [ - "api-reference/crmstage/list-a-batch-of-stages", - "api-reference/crmstage/retrieve-a-stage" - ] - }, - { - "group": "Task", - "pages": [ - "api-reference/crmtask/list-a-batch-of-tasks", - "api-reference/crmtask/create-a-task", - "api-reference/crmtask/update-a-task", - "api-reference/crmtask/retrieve-a-task", - "api-reference/crmtask/add-a-batch-of-tasks" - ] - }, - { - "group": "User", - "pages": [ - "api-reference/crmuser/list-a-batch-of-users", - "api-reference/crmuser/retrieve-a-user" - ] - } + "welcome", + "quick-start", + "catalog" ] - }, - { - "group": "Ticketing", + }, + { + "group": "", "pages": [ - { - "group": "Ticket", - "pages": [ - "api-reference/ticketingticket/list-a-batch-of-tickets", - "api-reference/ticketingticket/create-a-ticket", - "api-reference/ticketingticket/update-a-ticket", - "api-reference/ticketingticket/retrieve-a-ticket", - "api-reference/ticketingticket/add-a-batch-of-tickets" - ] - }, - { - "group": "Comment", - "pages": [ - "api-reference/ticketingcomment/list-a-batch-of-comments", - "api-reference/ticketingcomment/create-a-comment", - "api-reference/ticketingcomment/retrieve-a-comment", - "api-reference/ticketingcomment/add-a-batch-of-comments" - ] - }, - { - "group": "User", - "pages": [ - "api-reference/ticketinguser/list-a-batch-of-users", - "api-reference/ticketinguser/retrieve-a-user" - ] - }, - { - "group": "Attachment", - "pages": [ - "api-reference/ticketingattachment/list-a-batch-of-attachments", - "api-reference/ticketingattachment/create-a-attachment", - "api-reference/ticketingattachment/retrieve-a-attachment", - "api-reference/ticketingattachment/download-a-attachment", - "api-reference/ticketingattachment/add-a-batch-of-attachments" - ] - }, - { - "group": "Contact", - "pages": [ - "api-reference/ticketingcontact/list-a-batch-of-contacts", - "api-reference/ticketingcontact/retrieve-a-contact" - ] - }, - { - "group": "Account", - "pages": [ - "api-reference/ticketingaccount/list-a-batch-of-accounts", - "api-reference/ticketingaccount/retrieve-an-account" - ] - }, - { - "group": "Tag", - "pages": [ - "api-reference/ticketingtag/list-a-batch-of-tags", - "api-reference/ticketingtag/retrieve-a-tag" - ] - }, - { - "group": "Team", - "pages": [ - "api-reference/ticketingteam/list-a-batch-of-teams", - "api-reference/ticketingteam/retrieve-a-team" - ] - } + "crm/overview", + "crm/quickstart" ] - } - ] - }, - { - "group": "Core Resources", - "pages": [ - { - "group": "Auth", + }, + { + "group": "Unified Objects", "pages": [ - "api-reference/auth/register", - "api-reference/auth/log-in", - "api-reference/auth/get-users", - "api-reference/auth/retrieve-api-keys", - "api-reference/auth/create-api-key" + { + "group": "Contacts", + "pages": [ + "crm/contacts/overview", + "crm/contacts/api/list", + "crm/contacts/api/get", + "crm/contacts/api/create", + "crm/contacts/api/update" + ] + }, + { + "group": "Companies", + "pages": [ + "crm/companies/overview", + "crm/companies/api/list", + "crm/companies/api/get", + "crm/companies/api/create", + "crm/companies/api/update" + ] + }, + { + "group": "Deals", + "pages": [ + "crm/deals/overview", + "crm/deals/api/list", + "crm/deals/api/get", + "crm/deals/api/create", + "crm/deals/api/update" + ] + }, + { + "group": "Notes", + "pages": [ + "crm/notes/overview", + "crm/notes/api/list", + "crm/notes/api/get", + "crm/notes/api/create" + ] + }, + { + "group": "Engagements", + "pages": [ + "crm/engagements/overview", + "crm/engagements/api/list", + "crm/engagements/api/get", + "crm/engagements/api/create", + "crm/engagements/api/update" + ] + }, + { + "group": "Tasks", + "pages": [ + "crm/tasks/overview", + "crm/tasks/api/list", + "crm/tasks/api/get" + ] + }, + { + "group": "Users", + "pages": [ + "crm/users/overview", + "crm/users/api/list", + "crm/users/api/get" + ] + } ] - }, - { - "group": "Connections", + }, + { + "group": "Accounting", "pages": [ - "api-reference/connections/capture-oauth-callback", - "api-reference/connections/list-connections" + { + "group": "Accounting Balance Sheets", + "pages": [ + "accounting/accountingbalancesheets/retrieve-a-balancesheet" + ] + }, + { + "group": "Accounts", + "pages": [ + "accounting/accounts/create-a-account", + "accounting/accounts/list-accounts", + "accounting/accounts/retrieve-a-account" + ] + }, + { + "group": "Addresses", + "pages": [ + "accounting/addresses/list-addresss", + "accounting/addresses/retrieve-a-address" + ] + }, + { + "group": "Attachments", + "pages": [ + "accounting/attachments/list-attachments", + "accounting/attachments/retrieve-a-attachment", + "accounting/attachments/create-a-attachment" + ] + }, + { + "group": "Balance Sheets", + "pages": [ + "accounting/balancesheets/list-balancesheets", + "accounting/balancesheets/retrieve-a-balancesheet" + ] + }, + { + "group": "Cash Flow Statements", + "pages": [ + "accounting/cashflowstatements/list-cashflowstatements", + "accounting/cashflowstatements/retrieve-a-cashflowstatement" + ] + }, + { + "group": "Company Infos", + "pages": [ + "accounting/companyinfos/list-companyinfos", + "accounting/companyinfos/retrieve-a-companyinfo" + ] + }, + { + "group": "Contacts", + "pages": [ + "accounting/contacts/create-a-contact", + "accounting/contacts/list-contacts", + "accounting/contacts/retrieve-a-contact" + ] + }, + { + "group": "Credit Notes", + "pages": [ + "accounting/creditnotes/list-creditnotes", + "accounting/creditnotes/retrieve-a-creditnote" + ] + }, + { + "group": "Expenses", + "pages": [ + "accounting/expenses/create-a-expense", + "accounting/expenses/list-expenses", + "accounting/expenses/retrieve-a-expense" + ] + }, + { + "group": "Income Statements", + "pages": [ + "accounting/incomestatements/list-incomestatements", + "accounting/incomestatements/retrieve-a-incomestatement" + ] + }, + { + "group": "Invoices", + "pages": [ + "accounting/invoices/list-invoices", + "accounting/invoices/retrieve-a-invoice", + "accounting/invoices/create-a-invoice" + ] + }, + { + "group": "Items", + "pages": [ + "accounting/items/retrieve-a-item", + "accounting/items/list-items" + ] + }, + { + "group": "Journal Entries", + "pages": [ + "accounting/journalentries/create-a-journalentry", + "accounting/journalentries/retrieve-a-journalentry", + "accounting/journalentries/list-journalentrys" + ] + }, + { + "group": "Overview", + "pages": [ + "accounting/overview" + ] + }, + { + "group": "Payments", + "pages": [ + "accounting/payments/create-a-payment", + "accounting/payments/list-payments", + "accounting/payments/retrieve-a-payment" + ] + }, + { + "group": "Phone Numbers", + "pages": [ + "accounting/phonenumbers/retrieve-a-phonenumber", + "accounting/phonenumbers/list-phonenumbers" + ] + }, + { + "group": "Purchase Orders", + "pages": [ + "accounting/purchaseorders/list-purchaseorders", + "accounting/purchaseorders/retrieve-a-purchaseorder", + "accounting/purchaseorders/create-a-purchaseorder" + ] + }, + { + "group": "Quickstart", + "pages": [ + "accounting/quickstart" + ] + }, + { + "group": "Tax Rates", + "pages": [ + "accounting/taxrates/list-taxrates", + "accounting/taxrates/retrieve-a-taxrate" + ] + }, + { + "group": "Tracking Categories", + "pages": [ + "accounting/trackingcategories/list-trackingcategorys", + "accounting/trackingcategories/retrieve-a-trackingcategory" + ] + }, + { + "group": "Transactions", + "pages": [ + "accounting/transactions/list-transactions", + "accounting/transactions/retrieve-a-transaction" + ] + }, + { + "group": "Vendor Credits", + "pages": [ + "accounting/vendorcredits/retrieve-a-vendorcredit", + "accounting/vendorcredits/list-vendorcredits" + ] + } ] - }, - { - "group": "Webhook", + }, + { + "group": "ATS", "pages": [ - "api-reference/webhook/retrieve-webhooks-metadata", - "api-reference/webhook/add-webhook-metadata", - "api-reference/webhook/update-webhook-status" + { + "group": "Activities", + "pages": [ + "ats/activities/create-a-activity", + "ats/activities/list-activities", + "ats/activities/retrieve-a-activity" + ] + }, + { + "group": "Applications", + "pages": [ + "ats/applications/create-an-application", + "ats/applications/list-applications", + "ats/applications/retrieve-an-application" + ] + }, + { + "group": "Attachments", + "pages": [ + "ats/attachments/create-a-attachment", + "ats/attachments/list-attachments", + "ats/attachments/retrieve-a-attachment" + ] + }, + { + "group": "Candidates", + "pages": [ + "ats/candidates/create-a-candidate", + "ats/candidates/list-candidates", + "ats/candidates/retrieve-a-candidate" + ] + }, + { + "group": "Departments", + "pages": [ + "ats/departments/list-departments", + "ats/departments/retrieve-a-department" + ] + }, + { + "group": "EEOCs", + "pages": [ + "ats/eeocs/list-eeocss", + "ats/eeocs/retrieve-a-eeocs" + ] + }, + { + "group": "Interviews", + "pages": [ + "ats/interviews/create-a-interview", + "ats/interviews/list-interviews", + "ats/interviews/retrieve-a-interview" + ] + }, + { + "group": "Job Interview Stages", + "pages": [ + "ats/jobinterviewstages/list-jobinterviewstages", + "ats/jobinterviewstages/retrieve-a-jobinterviewstage" + ] + }, + { + "group": "Jobs", + "pages": [ + "ats/jobs/list-jobs", + "ats/jobs/retrieve-a-job" + ] + }, + { + "group": "Offers", + "pages": [ + "ats/offers/list-offers", + "ats/offers/retrieve-a-offer" + ] + }, + { + "group": "Offices", + "pages": [ + "ats/offices/list-offices", + "ats/offices/retrieve-a-office" + ] + }, + { + "group": "Reject Reasons", + "pages": [ + "ats/rejectreasons/list-rejectreasons", + "ats/rejectreasons/retrieve-a-rejectreason" + ] + }, + { + "group": "Scorecards", + "pages": [ + "ats/scorecards/list-scorecards", + "ats/scorecards/retrieve-a-scorecard" + ] + }, + { + "group": "Tags", + "pages": [ + "ats/tags/list-tags", + "ats/tags/retrieve-a-tag" + ] + }, + { + "group": "Users", + "pages": [ + "ats/users/list-users", + "ats/users/retrieve-a-user" + ] + } ] - }, - { - "group": "Linked Users", + }, + + + + + { + "group": "", "pages": [ - "api-reference/linked-users/add-linked-user", - "api-reference/linked-users/retrieve-linked-users", - "api-reference/linked-users/retrieve-a-linked-user" + "ticketing/overview", + "ticketing/quickstart" ] - }, - { - "group": "Organisations", + }, + { + "group": "Unified Objects", "pages": [ - "api-reference/organisations/retrieve-organisations", - "api-reference/organisations/create-an-organisation" + { + "group": "Accounts", + "pages": [ + "ticketing/accounts/list-accounts", + "ticketing/accounts/retrieve-an-account" + ] + }, + { + "group": "Attachments", + "pages": [ + "ticketing/attachments/create-a-attachment", + "ticketing/attachments/list-attachments", + "ticketing/attachments/retrieve-a-attachment" + ] + }, + { + "group": "Collections", + "pages": [ + "ticketing/collections/list-collections", + "ticketing/collections/retrieve-a-collection" + ] + }, + { + "group": "Comments", + "pages": [ + "ticketing/comments/create-a-comment", + "ticketing/comments/list-comments", + "ticketing/comments/retrieve-a-comment" + ] + }, + { + "group": "Contacts", + "pages": [ + "ticketing/contacts/list-all-contacts", + "ticketing/contacts/retrieve-a-contact" + ] + }, + { + "group": "Tags", + "pages": [ + "ticketing/tags/list-tags", + "ticketing/tags/retrieve-a-tag" + ] + }, + { + "group": "Teams", + "pages": [ + "ticketing/teams/list-teams", + "ticketing/teams/retrieve-a-team" + ] + }, + { + "group": "Tickets", + "pages": [ + "ticketing/tickets/create-a-ticket", + "ticketing/tickets/list-tickets", + "ticketing/tickets/retrieve-a-ticket" + ] + }, + { + "group": "Users", + "pages": [ + "ticketing/users/list-users", + "ticketing/users/retrieve-a-user" + ] + } ] - }, - { - "group": "Projects", + }, + { + "group": "", "pages": [ - "api-reference/projects/retrieve-projects", - "api-reference/projects/create-a-project" + "api-reference/introduction", + "api-reference/authentication", + "api-reference/errors", + "api-reference/pagination" ] - }, - { - "group": "Field Mappings", + }, + { + "group": "Unified Objects", "pages": [ - "api-reference/field-mapping/retrieve-field-mapping-entities", - "api-reference/field-mapping/retrieve-field-mappings", - "api-reference/field-mapping/retrieve-field-mappings-values", - "api-reference/field-mapping/define-target-field", - "api-reference/field-mapping/map-custom-field", - "api-reference/field-mapping/retrieve-custom-properties" + { + "group": "CRM", + "pages": [ + { + "group": "Contact", + "pages": [ + "api-reference/crmcontact/list-a-batch-of-crm-contacts", + "api-reference/crmcontact/create-crm-contact", + "api-reference/crmcontact/update-a-crm-contact", + "api-reference/crmcontact/retrieve-a-crm-contact", + "api-reference/crmcontact/add-a-batch-of-crm-contacts" + ] + }, + { + "group": "Deal", + "pages": [ + "api-reference/crmdeal/list-a-batch-of-deals", + "api-reference/crmdeal/create-a-deal", + "api-reference/crmdeal/retrieve-a-deal", + "api-reference/crmdeal/update-a-deal", + "api-reference/crmdeal/add-a-batch-of-deals" + ] + }, + { + "group": "Note", + "pages": [ + "api-reference/crmnote/list-a-batch-of-notes", + "api-reference/crmnote/create-a-note", + "api-reference/crmnote/retrieve-a-note", + "api-reference/crmnote/add-a-batch-of-notes" + ] + }, + { + "group": "Company", + "pages": [ + "api-reference/crmcompany/list-a-batch-of-companies", + "api-reference/crmcompany/create-a-company", + "api-reference/crmcompany/update-a-company", + "api-reference/crmcompany/retrieve-a-company", + "api-reference/crmcompany/add-a-batch-of-companies" + ] + }, + { + "group": "Engagement", + "pages": [ + "api-reference/crmengagement/list-a-batch-of-engagements", + "api-reference/crmengagement/create-a-engagement", + "api-reference/crmengagement/update-a-engagement", + "api-reference/crmengagement/retrieve-a-engagement", + "api-reference/crmengagement/add-a-batch-of-engagements" + ] + }, + { + "group": "Stage", + "pages": [ + "api-reference/crmstage/list-a-batch-of-stages", + "api-reference/crmstage/retrieve-a-stage" + ] + }, + { + "group": "Task", + "pages": [ + "api-reference/crmtask/list-a-batch-of-tasks", + "api-reference/crmtask/create-a-task", + "api-reference/crmtask/update-a-task", + "api-reference/crmtask/retrieve-a-task", + "api-reference/crmtask/add-a-batch-of-tasks" + ] + }, + { + "group": "User", + "pages": [ + "api-reference/crmuser/list-a-batch-of-users", + "api-reference/crmuser/retrieve-a-user" + ] + } + ] + }, + { + "group": "Ticketing", + "pages": [ + { + "group": "Ticket", + "pages": [ + "api-reference/ticketingticket/list-a-batch-of-tickets", + "api-reference/ticketingticket/create-a-ticket", + "api-reference/ticketingticket/update-a-ticket", + "api-reference/ticketingticket/retrieve-a-ticket", + "api-reference/ticketingticket/add-a-batch-of-tickets" + ] + }, + { + "group": "Comment", + "pages": [ + "api-reference/ticketingcomment/list-a-batch-of-comments", + "api-reference/ticketingcomment/create-a-comment", + "api-reference/ticketingcomment/retrieve-a-comment", + "api-reference/ticketingcomment/add-a-batch-of-comments" + ] + }, + { + "group": "User", + "pages": [ + "api-reference/ticketinguser/list-a-batch-of-users", + "api-reference/ticketinguser/retrieve-a-user" + ] + }, + { + "group": "Attachment", + "pages": [ + "api-reference/ticketingattachment/list-a-batch-of-attachments", + "api-reference/ticketingattachment/create-a-attachment", + "api-reference/ticketingattachment/retrieve-a-attachment", + "api-reference/ticketingattachment/download-a-attachment", + "api-reference/ticketingattachment/add-a-batch-of-attachments" + ] + }, + { + "group": "Contact", + "pages": [ + "api-reference/ticketingcontact/list-a-batch-of-contacts", + "api-reference/ticketingcontact/retrieve-a-contact" + ] + }, + { + "group": "Account", + "pages": [ + "api-reference/ticketingaccount/list-a-batch-of-accounts", + "api-reference/ticketingaccount/retrieve-an-account" + ] + }, + { + "group": "Tag", + "pages": [ + "api-reference/ticketingtag/list-a-batch-of-tags", + "api-reference/ticketingtag/retrieve-a-tag" + ] + }, + { + "group": "Team", + "pages": [ + "api-reference/ticketingteam/list-a-batch-of-teams", + "api-reference/ticketingteam/retrieve-a-team" + ] + } + ] + } ] - }, - { - "group": "Events", + }, + { + "group": "Core Resources", "pages": [ - "api-reference/events/retrieve-events" + { + "group": "Auth", + "pages": [ + "api-reference/auth/register", + "api-reference/auth/log-in", + "api-reference/auth/get-users", + "api-reference/auth/retrieve-api-keys", + "api-reference/auth/create-api-key" + ] + }, + { + "group": "Connections", + "pages": [ + "api-reference/connections/capture-oauth-callback", + "api-reference/connections/list-connections" + ] + }, + { + "group": "Webhook", + "pages": [ + "api-reference/webhook/retrieve-webhooks-metadata", + "api-reference/webhook/add-webhook-metadata", + "api-reference/webhook/update-webhook-status" + ] + }, + { + "group": "Linked Users", + "pages": [ + "api-reference/linked-users/add-linked-user", + "api-reference/linked-users/retrieve-linked-users", + "api-reference/linked-users/retrieve-a-linked-user" + ] + }, + { + "group": "Organisations", + "pages": [ + "api-reference/organisations/retrieve-organisations", + "api-reference/organisations/create-an-organisation" + ] + }, + { + "group": "Projects", + "pages": [ + "api-reference/projects/retrieve-projects", + "api-reference/projects/create-a-project" + ] + }, + { + "group": "Field Mappings", + "pages": [ + "api-reference/field-mapping/retrieve-field-mapping-entities", + "api-reference/field-mapping/retrieve-field-mappings", + "api-reference/field-mapping/retrieve-field-mappings-values", + "api-reference/field-mapping/define-target-field", + "api-reference/field-mapping/map-custom-field", + "api-reference/field-mapping/retrieve-custom-properties" + ] + }, + { + "group": "Events", + "pages": [ + "api-reference/events/retrieve-events" + ] + }, + { + "group": "Magic Links", + "pages": [ + "api-reference/magic-link/create-a-magic-link", + "api-reference/magic-link/retrieve-magic-links", + "api-reference/magic-link/retrieve-a-magic-link" + ] + }, + { + "group": "Passthrough", + "pages": [ + "api-reference/passthrough/make-a-passthrough-request" + ] + } ] - }, - { - "group": "Magic Links", + }, + { + "group": "Core Concepts", "pages": [ - "api-reference/magic-link/create-a-magic-link", - "api-reference/magic-link/retrieve-magic-links", - "api-reference/magic-link/retrieve-a-magic-link" + "core-concepts/auth", + "core-concepts/magic-links", + "core-concepts/custom-fields", + "core-concepts/sync-strategies" ] - }, - { - "group": "Passthrough", + }, + { + "group": "Recipes", "pages": [ - "api-reference/passthrough/make-a-passthrough-request" + "recipes/embed-catalog", + "recipes/import-existing-users", + "recipes/catch-connection-token", + "recipes/add-custom-provider-creds" ] - } - ] - }, - { - "group": "Core Concepts", - "pages": [ - "core-concepts/auth", - "core-concepts/magic-links", - "core-concepts/custom-fields", - "core-concepts/sync-strategies" - ] - }, - { - "group": "Recipes", - "pages": [ - "recipes/embed-catalog", - "recipes/import-existing-users", - "recipes/catch-connection-token", - "recipes/add-custom-provider-creds" - ] - }, - { - "group": "Glossary", - "pages": ["glossary/connection-object", "glossary/linked-account-object", + }, + { + "group": "Glossary", + "pages": [ + "glossary/connection-object", + "glossary/linked-account-object", + { + "group": "Metadata", + "pages": [ + "glossary/metadata/category", + "glossary/metadata/connectors" + ] + } + ] + }, { - "group": "Metadata", - "pages": ["glossary/metadata/category", "glossary/metadata/connectors"] - }] - }, - - { - "group": "Devtools", - "pages": [ - { - "group": "SDKs", - "pages": ["backend-sdk/typescript", "backend-sdk/python"] - } - ] - }, - { - "group": "Webhooks", - "pages": [ - "webhooks/overview", - { - "group": "Events", - "pages": ["webhooks/events/overview" , "webhooks/events/event-types"] - } - ] - }, - - { - "group": "Open-Source", - "pages": [ - "open-source/self-host-guide", - "open-source/contributors" - ] - }, - { - "group": "Support", - "pages": [ - "support/get_help" - ] - } + "group": "Devtools", + "pages": [ + { + "group": "SDKs", + "pages": [ + "backend-sdk/typescript", + "backend-sdk/python" + ] + } + ] + }, + { + "group": "Webhooks", + "pages": [ + "webhooks/overview", + { + "group": "Events", + "pages": [ + "webhooks/events/overview", + "webhooks/events/event-types" + ] + } + ] + }, + { + "group": "Open-Source", + "pages": [ + "open-source/self-hosting/guide", + "open-source/contributors/setup" + ] + }, + { + "group": "Support", + "pages": [ + "support/get_help" + ] + } ], "footerSocials": { - "twitter": "https://twitter.com/panoradotdev", - "github": "https://github.com/panoratech/Panora", - "discord": "https://discord.gg/G7fr4HNyTb" + "twitter": "https://twitter.com/panoradotdev", + "github": "https://github.com/panoratech/Panora", + "discord": "https://discord.gg/G7fr4HNyTb" } - } \ No newline at end of file +} \ No newline at end of file diff --git a/docs/open-source/selfhost/envVariables.mdx b/docs/open-source/self-hosting/envVariables.mdx similarity index 100% rename from docs/open-source/selfhost/envVariables.mdx rename to docs/open-source/self-hosting/envVariables.mdx diff --git a/docs/open-source/selfhost/self-host-guide.mdx b/docs/open-source/self-hosting/guide.mdx similarity index 100% rename from docs/open-source/selfhost/self-host-guide.mdx rename to docs/open-source/self-hosting/guide.mdx diff --git a/docs/open-source/selfhost/ngrok.mdx b/docs/open-source/self-hosting/ngrok.mdx similarity index 100% rename from docs/open-source/selfhost/ngrok.mdx rename to docs/open-source/self-hosting/ngrok.mdx diff --git a/docs/syncwithCode.sh b/docs/syncwithCode.sh index 09db8f307..8fd6e5290 100644 --- a/docs/syncwithCode.sh +++ b/docs/syncwithCode.sh @@ -8,4 +8,5 @@ grep '^|' ./packages/api/src/crm/contact/README.md > docs/snippets/crm-contact-c # Ticketing grep '^|' ./packages/api/src/ticketing/README.md > docs/snippets/ticketing-catalog.mdx +npx @mintlify/scraping@latest openapi-file openapi-with-code-samples.yaml -o objects echo "Copy Done!" \ No newline at end of file diff --git a/docs/ticketing/accounts/api/create.mdx b/docs/ticketing/accounts/api/create.mdx deleted file mode 100644 index c4c74be0d..000000000 --- a/docs/ticketing/accounts/api/create.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Create an account" -description: "Create an account in any Ticketing Platform using this endpoint" -openapi: "POST /ticketing/accounts" ---- diff --git a/docs/ticketing/accounts/api/get.mdx b/docs/ticketing/accounts/api/get.mdx deleted file mode 100644 index a4098166f..000000000 --- a/docs/ticketing/accounts/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve an account" -description: "Retrieve an account in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/accounts/{id}" ---- diff --git a/docs/ticketing/accounts/api/list.mdx b/docs/ticketing/accounts/api/list.mdx deleted file mode 100644 index 5e2401b31..000000000 --- a/docs/ticketing/accounts/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List all accounts" -description: "List all accounts in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/accounts" ---- diff --git a/docs/ticketing/accounts/api/update.mdx b/docs/ticketing/accounts/api/update.mdx deleted file mode 100644 index 44f747c5d..000000000 --- a/docs/ticketing/accounts/api/update.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Update an account" -description: "Update an account in any Ticketing Platform using this endpoint" -openapi: "PATCH /ticketing/accounts" ---- diff --git a/docs/ticketing/accounts/list-accounts.mdx b/docs/ticketing/accounts/list-accounts.mdx new file mode 100644 index 000000000..acb99c761 --- /dev/null +++ b/docs/ticketing/accounts/list-accounts.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/accounts +--- \ No newline at end of file diff --git a/docs/ticketing/accounts/overview.mdx b/docs/ticketing/accounts/overview.mdx deleted file mode 100644 index 5b0b8b58b..000000000 --- a/docs/ticketing/accounts/overview.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Overview' ---- diff --git a/docs/ticketing/accounts/retrieve-an-account.mdx b/docs/ticketing/accounts/retrieve-an-account.mdx new file mode 100644 index 000000000..81c451509 --- /dev/null +++ b/docs/ticketing/accounts/retrieve-an-account.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/accounts/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/attachments/create-a-attachment.mdx b/docs/ticketing/attachments/create-a-attachment.mdx new file mode 100644 index 000000000..2a8cb164b --- /dev/null +++ b/docs/ticketing/attachments/create-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ticketing/attachments +--- \ No newline at end of file diff --git a/docs/ticketing/attachments/list-attachments.mdx b/docs/ticketing/attachments/list-attachments.mdx new file mode 100644 index 000000000..a2eeb20a7 --- /dev/null +++ b/docs/ticketing/attachments/list-attachments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/attachments +--- \ No newline at end of file diff --git a/docs/ticketing/attachments/retrieve-a-attachment.mdx b/docs/ticketing/attachments/retrieve-a-attachment.mdx new file mode 100644 index 000000000..4685ab7a3 --- /dev/null +++ b/docs/ticketing/attachments/retrieve-a-attachment.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/attachments/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/collections/list-collections.mdx b/docs/ticketing/collections/list-collections.mdx new file mode 100644 index 000000000..5b7bd89cc --- /dev/null +++ b/docs/ticketing/collections/list-collections.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/collections +--- \ No newline at end of file diff --git a/docs/ticketing/collections/retrieve-a-collection.mdx b/docs/ticketing/collections/retrieve-a-collection.mdx new file mode 100644 index 000000000..f03e54414 --- /dev/null +++ b/docs/ticketing/collections/retrieve-a-collection.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/collections/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/comments/api/create.mdx b/docs/ticketing/comments/api/create.mdx deleted file mode 100644 index edfcb9367..000000000 --- a/docs/ticketing/comments/api/create.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Create a Comment" -description: "Create a comment in any Ticketing Platform using this endpoint" -openapi: "POST /ticketing/comments" ---- diff --git a/docs/ticketing/comments/api/get.mdx b/docs/ticketing/comments/api/get.mdx deleted file mode 100644 index ac4a25856..000000000 --- a/docs/ticketing/comments/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve a Comment" -description: "Retrieve a comment in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/comments/{id}" ---- diff --git a/docs/ticketing/comments/api/list.mdx b/docs/ticketing/comments/api/list.mdx deleted file mode 100644 index de1ba152e..000000000 --- a/docs/ticketing/comments/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List Comments" -description: "List comments in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/comments" ---- diff --git a/docs/ticketing/comments/api/update.mdx b/docs/ticketing/comments/api/update.mdx deleted file mode 100644 index b49d113f0..000000000 --- a/docs/ticketing/comments/api/update.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Update a Comment" -description: "Update a comment in any Ticketing connection using this endpoint" -openapi: "PATCH /ticketing/comments" ---- diff --git a/docs/ticketing/comments/create-a-comment.mdx b/docs/ticketing/comments/create-a-comment.mdx new file mode 100644 index 000000000..84a926b07 --- /dev/null +++ b/docs/ticketing/comments/create-a-comment.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ticketing/comments +--- \ No newline at end of file diff --git a/docs/ticketing/comments/list-comments.mdx b/docs/ticketing/comments/list-comments.mdx new file mode 100644 index 000000000..b84d9d0f1 --- /dev/null +++ b/docs/ticketing/comments/list-comments.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/comments +--- \ No newline at end of file diff --git a/docs/ticketing/comments/overview.mdx b/docs/ticketing/comments/overview.mdx deleted file mode 100644 index 8203bd375..000000000 --- a/docs/ticketing/comments/overview.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Overview' -description: 'Manipulate comments in any Ticketing Platform using these endpoint' ---- diff --git a/docs/ticketing/comments/retrieve-a-comment.mdx b/docs/ticketing/comments/retrieve-a-comment.mdx new file mode 100644 index 000000000..eb67a02be --- /dev/null +++ b/docs/ticketing/comments/retrieve-a-comment.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/comments/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/api/create.mdx b/docs/ticketing/contacts/api/create.mdx deleted file mode 100644 index 15fea705a..000000000 --- a/docs/ticketing/contacts/api/create.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Create a Contact" -description: "Create a contact in any Ticketing Platform using this endpoint" -openapi: "POST /ticketing/contacts" ---- diff --git a/docs/ticketing/contacts/api/get.mdx b/docs/ticketing/contacts/api/get.mdx deleted file mode 100644 index 6324a76dd..000000000 --- a/docs/ticketing/contacts/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve a Contact" -description: "Retrieve a contact in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/contacts" ---- diff --git a/docs/ticketing/contacts/api/list.mdx b/docs/ticketing/contacts/api/list.mdx deleted file mode 100644 index 460724f0e..000000000 --- a/docs/ticketing/contacts/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List Contacts" -description: "List all contacts from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/contacts/{id}" ---- diff --git a/docs/ticketing/contacts/api/update.mdx b/docs/ticketing/contacts/api/update.mdx deleted file mode 100644 index 17a38c7b9..000000000 --- a/docs/ticketing/contacts/api/update.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Update a Contact" -description: "Update a Contact from any Ticketing Platform using this endpoint" -openapi: "PATCH /ticketing/contacts" ---- diff --git a/docs/ticketing/contacts/list-all-contacts.mdx b/docs/ticketing/contacts/list-all-contacts.mdx new file mode 100644 index 000000000..5e2e76d85 --- /dev/null +++ b/docs/ticketing/contacts/list-all-contacts.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/contacts +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/overview.mdx b/docs/ticketing/contacts/overview.mdx deleted file mode 100644 index 5b0b8b58b..000000000 --- a/docs/ticketing/contacts/overview.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Overview' ---- diff --git a/docs/ticketing/contacts/retrieve-a-contact.mdx b/docs/ticketing/contacts/retrieve-a-contact.mdx new file mode 100644 index 000000000..ebade59f4 --- /dev/null +++ b/docs/ticketing/contacts/retrieve-a-contact.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/contacts/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/overview.mdx b/docs/ticketing/overview.mdx index b3725b4c1..92cdcd0af 100644 --- a/docs/ticketing/overview.mdx +++ b/docs/ticketing/overview.mdx @@ -1,13 +1,10 @@ --- title: 'Overview' -description: "" +description: '' --- +import crmCatalog from '/snippets/crm-catalog.mdx'; -import catalog from '/snippets/ticketing-catalog.mdx'; - -Welcome to the reference documentation for the Panora Ticketing API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. +Welcome to the reference documentation for the Panora Customer Relationship Management (CRM) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users.

- - - + \ No newline at end of file diff --git a/docs/ticketing/quick-start.mdx b/docs/ticketing/quick-start.mdx deleted file mode 100644 index 96090cfa4..000000000 --- a/docs/ticketing/quick-start.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Quick Start" -description: "Learn how to write and read data from your multiple ticketing platforms" ---- - -## Create a ticket in any platform using Panora - - - We assume for this tutorial that you have a valid Panora API Key, and a - `connection_token`. Find help [here](/core-concepts/auth). - - - - - You can find the Typescript SDK [here](https://www.npmjs.com/package/@panora/sdk-typescript) - - - - ```javascript TypeScript SDK - import { PanoraSDK } from '@panora/sdk-typescript'; - const sdk = new PanoraSDK({ accessToken: "MY_API_KEY" }); - ``` - - ```python Python SDK - sdk = PanoraSDK('YOUR_BEARER_TOKEN') - ``` - - ```java Java SDK - PanoraSDK sdk = new PanoraSDK("YOUR_BEARER_TOKEN"); - ``` - - - - - In this example, we will create a ticket in a Provider. Visit other sections of the documentation to find category-specific examples - - - ```shell curl - curl --request POST \ - --url https://api.panora.dev/ticketing/tickets \ - --header 'Authorization: Bearer dfsdf' \ - --header 'Content-Type: application/json' \ - --header 'x-connection-token: ' \ - --data '{ - "account_id": 'account_id', - "assigned_to": ['aliquip', 'enim'], - "comment": ['pariatur nulla deserunt', 'irure incididunt Duis minim'], - "completed_at": '1912-09-29T15:29:41.0Z', - "contact_id": 'contact_id', - "description": ['Duis nostrud in', 'magna adipisicing'], - "due_date": '1945-12-08T15:08:52.0Z', - "name": 'name', - "parent_ticket": 'parent_ticket', - "priority": 'priority', - "status": 'status', - "tags": ['cillum', 'officia dolore'], - "field_mappings": {} - }' - ``` - - ```javascript TypeScript - import { PanoraSDK } from '@panora/sdk-typescript'; - - const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN }); - - (async () => { - const input = { - account_id: 'account_id', - assigned_to: ['aliquip', 'enim'], - comment: ['pariatur nulla deserunt', 'irure incididunt Duis minim'], - completed_at: '1912-09-29T15:29:41.0Z', - contact_id: 'contact_id', - description: ['Duis nostrud in', 'magna adipisicing'], - due_date: '1945-12-08T15:08:52.0Z', - field_mappings: {}, - name: 'name', - parent_ticket: 'parent_ticket', - priority: 'priority', - status: 'status', - tags: ['cillum', 'officia dolore'], - type_: 'type', - }; - const result = await sdk.ticketingTickets.addTicket(input, 'connection_token', { - remoteData: true, - }); - console.log(result); - })(); - ``` - - - - diff --git a/docs/ticketing/quickstart.mdx b/docs/ticketing/quickstart.mdx new file mode 100644 index 000000000..86c557f67 --- /dev/null +++ b/docs/ticketing/quickstart.mdx @@ -0,0 +1,97 @@ +--- +title: "Quick Start" +description: "Read and write data to multiple ticketing platforms using a single API" +--- + +## Create a ticket in a ticketing platform using Panora + + + We assume for this tutorial that you have a valid Panora API Key, and a + `connection_token`. Find help [here](/core-concepts/auth). + + + + + You can find the Typescript SDK [here](https://www.npmjs.com/package/@panora/sdk-typescript) + + + + ```javascript TypeScript SDK + import { PanoraSDK } from '@panora/sdk-typescript'; + const sdk = new PanoraSDK({ accessToken: "MY_API_KEY" }); + ``` + + ```python Python SDK + sdk = PanoraSDK('YOUR_BEARER_TOKEN') + ``` + + ```java Java SDK + PanoraSDK sdk = new PanoraSDK("YOUR_BEARER_TOKEN"); + ``` + + + + + In this example, we will create a ticket in a ticketing platform. Visit other sections of the documentation to find category-specific examples + + + ```shell curl + curl --request POST \ + --url https://api.panora.dev/ticketing/tickets \ + --header 'Authorization: Bearer dfsdf' \ + --header 'Content-Type: application/json' \ + --header 'x-connection-token: ' \ + --data '{ + "subject": "Issue with login", + "description": "User is unable to login with correct credentials", + "priority": "high", + "status": "open", + "assignee": "support_agent" + }' + ``` + + ```javascript TypeScript + import { PanoraSDK } from '@panora/sdk-typescript'; + const sdk = new PanoraSDK({ accessToken: "MY_API_KEY" }); + + (async () => { + const input = { + subject: 'Issue with login', + description: 'User is unable to login with correct credentials', + priority: 'high', + status: 'open', + assignee: 'support_agent', + }; + const result = await sdk.ticketingTicket.createTicket(input, 'connection_token', { + remoteData: true, + }); + console.log(result); + })(); + ``` + + ```python Python + from os import getenv + from pprint import pprint + from panorasdk import PanoraSDK + sdk = PanoraSDK() + sdk.set_access_token(getenv("YOUR_API_KEY")) + request_body = { + 'subject': 'Issue with login', + 'description': 'User is unable to login with correct credentials', + 'priority': 'high', + 'status': 'open', + 'assignee': 'support_agent' + } + results = sdk.ticketing_ticket.create_ticket( + request_input = request_body, + connection_token = 'USER_CONNECTION_TOKEN', + remote_data = True + ) + + pprint(vars(results)) + + ``` + + + + diff --git a/docs/ticketing/tags/api/get.mdx b/docs/ticketing/tags/api/get.mdx deleted file mode 100644 index dd5961e6e..000000000 --- a/docs/ticketing/tags/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve a tag" -description: "Retrieve a tag in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/tags/{id}" ---- diff --git a/docs/ticketing/tags/api/list.mdx b/docs/ticketing/tags/api/list.mdx deleted file mode 100644 index 3d9220e77..000000000 --- a/docs/ticketing/tags/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List all tags" -description: "List all tags in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/tags" ---- diff --git a/docs/ticketing/tags/list-tags.mdx b/docs/ticketing/tags/list-tags.mdx new file mode 100644 index 000000000..bb3776026 --- /dev/null +++ b/docs/ticketing/tags/list-tags.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/tags +--- \ No newline at end of file diff --git a/docs/ticketing/tags/overview.mdx b/docs/ticketing/tags/overview.mdx deleted file mode 100644 index 5b0b8b58b..000000000 --- a/docs/ticketing/tags/overview.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Overview' ---- diff --git a/docs/ticketing/tags/retrieve-a-tag.mdx b/docs/ticketing/tags/retrieve-a-tag.mdx new file mode 100644 index 000000000..26958be76 --- /dev/null +++ b/docs/ticketing/tags/retrieve-a-tag.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/tags/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/teams/api/get.mdx b/docs/ticketing/teams/api/get.mdx deleted file mode 100644 index 3c23cadd1..000000000 --- a/docs/ticketing/teams/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve a Team" -description: "Retrieve a Team from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/teams/{id}" ---- diff --git a/docs/ticketing/teams/api/list.mdx b/docs/ticketing/teams/api/list.mdx deleted file mode 100644 index 2b787d553..000000000 --- a/docs/ticketing/teams/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List Teams" -description: "List all teams from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/teams/{id}" ---- diff --git a/docs/ticketing/teams/api/update.mdx b/docs/ticketing/teams/api/update.mdx deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/ticketing/teams/list-teams.mdx b/docs/ticketing/teams/list-teams.mdx new file mode 100644 index 000000000..b57a4de9c --- /dev/null +++ b/docs/ticketing/teams/list-teams.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/teams +--- \ No newline at end of file diff --git a/docs/ticketing/teams/overview.mdx b/docs/ticketing/teams/overview.mdx deleted file mode 100644 index 5b0b8b58b..000000000 --- a/docs/ticketing/teams/overview.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Overview' ---- diff --git a/docs/ticketing/teams/retrieve-a-team.mdx b/docs/ticketing/teams/retrieve-a-team.mdx new file mode 100644 index 000000000..5d786d060 --- /dev/null +++ b/docs/ticketing/teams/retrieve-a-team.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/teams/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/api/create.mdx b/docs/ticketing/tickets/api/create.mdx deleted file mode 100644 index 963cba5ee..000000000 --- a/docs/ticketing/tickets/api/create.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Create a Ticket" -description: "Create a ticket in any Ticketing Platform using this endpoint" -openapi: "POST /ticketing/tickets" ---- diff --git a/docs/ticketing/tickets/api/get.mdx b/docs/ticketing/tickets/api/get.mdx deleted file mode 100644 index ed3a2cbdb..000000000 --- a/docs/ticketing/tickets/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List Tickets" -description: "List tickets in any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/tickets" ---- diff --git a/docs/ticketing/tickets/api/list.mdx b/docs/ticketing/tickets/api/list.mdx deleted file mode 100644 index 34b2de223..000000000 --- a/docs/ticketing/tickets/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List Tickets" -description: "List Tickets from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/tickets" ---- diff --git a/docs/ticketing/tickets/api/update.mdx b/docs/ticketing/tickets/api/update.mdx deleted file mode 100644 index 9d8d0f6c8..000000000 --- a/docs/ticketing/tickets/api/update.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Update a Ticket" -description: "Update a Ticket from any Ticketing Platform using this endpoint" -openapi: "PATCH /ticketing/tickets" ---- diff --git a/docs/ticketing/tickets/create-a-ticket.mdx b/docs/ticketing/tickets/create-a-ticket.mdx new file mode 100644 index 000000000..82c9a1634 --- /dev/null +++ b/docs/ticketing/tickets/create-a-ticket.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /ticketing/tickets +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/list-tickets.mdx b/docs/ticketing/tickets/list-tickets.mdx new file mode 100644 index 000000000..3320f2a35 --- /dev/null +++ b/docs/ticketing/tickets/list-tickets.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/tickets +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/overview.mdx b/docs/ticketing/tickets/overview.mdx deleted file mode 100644 index 53b1577e9..000000000 --- a/docs/ticketing/tickets/overview.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: 'The tickets object' -description: 'Introduction to our Ticketing `ticket` Unified Model' ---- - -## The Unified `ticket` Object -The `ticket` object is used to represent an existing ticket in a ticketing system. - -### Properties - - -```json JSON -{ - "id_tcg_ticket": "f4e1ff72-e727-409a-8935-a63a63d4891e", - "first_name": "John", - "last_name": "Doe", - "email_addresses": [ - { - "email_address": "johndoe@work.com", - "email_address_type": "work" - }, - { - "email_address": "johndoe@personal.com", - "email_address_type": "phone" - } - ], - "remote_data": { - } -} -``` - - - - - - - - Panora Defined UUID for this contact - - - - The full name of the `contact` - - - - The last name of this `contact` - - - - Array containing all the non-standard data points for this `contact`. Requires mapping. - - - - Original data, as provided by the source CRM - - - - diff --git a/docs/ticketing/tickets/retrieve-a-ticket.mdx b/docs/ticketing/tickets/retrieve-a-ticket.mdx new file mode 100644 index 000000000..47e424d81 --- /dev/null +++ b/docs/ticketing/tickets/retrieve-a-ticket.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/tickets/{id} +--- \ No newline at end of file diff --git a/docs/ticketing/users/api/get.mdx b/docs/ticketing/users/api/get.mdx deleted file mode 100644 index d30996bf3..000000000 --- a/docs/ticketing/users/api/get.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Retrieve a user" -description: "Retrieve a User from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/users/{id}" ---- diff --git a/docs/ticketing/users/api/list.mdx b/docs/ticketing/users/api/list.mdx deleted file mode 100644 index eb9539749..000000000 --- a/docs/ticketing/users/api/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "List users" -description: "List Users from any Ticketing Platform using this endpoint" -openapi: "GET /ticketing/users" ---- diff --git a/docs/ticketing/users/list-users.mdx b/docs/ticketing/users/list-users.mdx new file mode 100644 index 000000000..6723c5b6b --- /dev/null +++ b/docs/ticketing/users/list-users.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/users +--- \ No newline at end of file diff --git a/docs/ticketing/users/overview.mdx b/docs/ticketing/users/overview.mdx deleted file mode 100644 index 5b0b8b58b..000000000 --- a/docs/ticketing/users/overview.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Overview' ---- diff --git a/docs/ticketing/users/retrieve-a-user.mdx b/docs/ticketing/users/retrieve-a-user.mdx new file mode 100644 index 000000000..cca6b1298 --- /dev/null +++ b/docs/ticketing/users/retrieve-a-user.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /ticketing/users/{id} +--- \ No newline at end of file