Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: File Storage APIs #578

Merged
merged 1 commit into from
Jul 28, 2024
+195 −68
Merged

feat: File Storage APIs #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions docs/README.md
View file
Open in desktop

This file was deleted.

7 changes: 7 additions & 0 deletions docs/accounting/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Quick Start"
description: "Read and write data to multiple Accounting platforms using a single API"
icon: "star"
---

We're releasing this API soon! Get updates [here](https://panora.co/signup).
10 changes: 10 additions & 0 deletions docs/ats/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Overview'
description: ''
---
import atsCatalog from '/snippets/ats-catalog.mdx';

Welcome to the reference documentation for the ATS (Applicant Tracking System) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users.

## Supported ATS Providers & Objects
<atsCatalog />
55 changes: 29 additions & 26 deletions docs/catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,22 @@ description: ""
icon: album-collection
---

## ATS

<CardGroup cols={2}>
<Card title="Ashby" href="/integrations/ats/ashby/index" icon={
<img src="https://images.ctfassets.net/p03bi75xct27/2tVvkghDdMJxzkMca2QLnr/31b520c5e07db0103948af171fb54e99/ashby_logo_square.jpeg?q=80&fm=webp&w=2048" />
} horizontal>
</Card>
</CardGroup>


## CRM

<CardGroup cols={2}>
<Tabs>
<Tab title="ATS">
<CardGroup cols={2}>
<Card title="Ashby" href="/integrations/ats/ashby/index" icon={
<img src="https://images.ctfassets.net/p03bi75xct27/2tVvkghDdMJxzkMca2QLnr/31b520c5e07db0103948af171fb54e99/ashby_logo_square.jpeg?q=80&fm=webp&w=2048" />
} horizontal>
</Card>
</CardGroup>
</Tab>
<Tab title="Accounting">
Coming soon!
</Tab>
<Tab title="CRM">
A single schema to push and pull CRM data across platforms.
<CardGroup cols={2}>
<Card title="Hubspot" href="/integrations/crm/hubspot/index" icon={
<img src="https://assets-global.website-files.com/6421a177cdeeaf3c6791b745/64d61202dd99e63d40d446f6_hubspot%20logo.png" />
} horizontal>
Expand All @@ -42,31 +45,26 @@ icon: album-collection
} horizontal>
</Card>
</CardGroup>


# Ecommerce

<CardGroup cols={2}>
</Tab>
<Tab title="Ecommerce">
<CardGroup cols={2}>
<Card title="Shopify" href="/integrations/ecommerce/shopify/index" icon={
<img src="https://cdn.freebiesupply.com/logos/large/2x/shopify-logo-png-transparent.png" />
} horizontal>
</Card>
</CardGroup>


# File Storage

<CardGroup cols={2}>
</Tab>
<Tab title="File Storage">
<CardGroup cols={2}>
<Card title="Box" href="/integrations/filestorage/box/index" icon={
<img src="https://gdm-catalog-fmapi-prod.imgix.net/ProductLogo/95b201e8-845a-4064-a9b2-a8eb49d19ca3.png?w=128&h=128&fit=max&dpr=3&auto=format&q=50" />
} horizontal>
</Card>
</CardGroup>


# Ticketing

<CardGroup cols={2}>
</Tab>
<Tab title="Ticketing">
<CardGroup cols={2}>
<Card title="Zendesk" href="/integrations/ticketing/zendesk/index" icon={
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRNKVceZGVM7PbARp_2bjdOICUxlpS5B29UYlurvh6Z2Q&s" />
} horizontal>
Expand All @@ -84,4 +82,9 @@ icon: album-collection
} horizontal>
</Card>
</CardGroup>
</Tab>

</Tabs>



2 changes: 1 addition & 1 deletion docs/crm/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ import crmCatalog from '/snippets/crm-catalog.mdx';

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.

<br></br>
## Supported CRM Providers & Objects
<crmCatalog />
1 change: 1 addition & 0 deletions docs/crm/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Quick Start"
description: "Read and write data to multiple CRM platforms using a single API"
icon: "star"
---

## Create a contact in a crm using Panora
Expand Down
3 changes: 3 additions & 0 deletions docs/file-storage/drives/list-drives.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/drives
---
3 changes: 3 additions & 0 deletions docs/file-storage/drives/retrieve-a-drive.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/drives/{id}
---
3 changes: 3 additions & 0 deletions docs/file-storage/files/create-a-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /filestorage/files
---
3 changes: 3 additions & 0 deletions docs/file-storage/files/list-files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/files
---
3 changes: 3 additions & 0 deletions docs/file-storage/files/retrieve-a-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/files/{id}
---
3 changes: 3 additions & 0 deletions docs/file-storage/groups/list-groups.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/groups
---
3 changes: 3 additions & 0 deletions docs/file-storage/groups/retrieve-a-group.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/groups/{id}
---
3 changes: 3 additions & 0 deletions docs/file-storage/olders/create-a-folder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /filestorage/folders
---
3 changes: 3 additions & 0 deletions docs/file-storage/olders/list-folders.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/folders
---
3 changes: 3 additions & 0 deletions docs/file-storage/olders/retrieve-a-folder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/folders/{id}
---
10 changes: 10 additions & 0 deletions docs/file-storage/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Overview'
description: ''
---
import filestorageCatalog from '/snippets/filestorage-catalog.mdx';

Welcome to the reference documentation for the Panora File Storage (CRM) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users.

## Supported File Storage Providers & Objects
<filestorageCatalog />
3 changes: 3 additions & 0 deletions docs/file-storage/users/list-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/users
---
3 changes: 3 additions & 0 deletions docs/file-storage/users/retrieve-a-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /filestorage/users/{id}
---
79 changes: 73 additions & 6 deletions docs/mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@
"name": "CRM",
"url": "crm"
},
{
"name": "File Storage",
"url": "file-storage"
},
{
"name": "Ticketing",
"url": "ticketing"
Expand All @@ -94,8 +98,8 @@
{
"group": "",
"pages": [
"crm/overview",
"crm/quickstart"
"crm/quickstart",
"crm/overview"
]
},
{
Expand Down Expand Up @@ -168,8 +172,62 @@
}
]
},


{
"group": "",
"pages": [
"file-storage/overview"
]
},

{
"group": "File Storage Objects",
"pages": [
{
"group": "Drives",
"pages": [
"file-storage/drives/list-drives",
"file-storage/drives/retrieve-a-drive"
]
},
{
"group": "Files",
"pages": [
"file-storage/files/create-a-file",
"file-storage/files/list-files",
"file-storage/files/retrieve-a-file"
]
},
{
"group": "Folders",
"pages": [
"file-storage/olders/create-a-folder",
"file-storage/olders/list-folders",
"file-storage/olders/retrieve-a-folder"
]
},
{
"group": "Groups",
"pages": [
"file-storage/groups/list-groups",
"file-storage/groups/retrieve-a-group"
]
},
{
"group": "Users",
"pages": [
"file-storage/users/list-users",
"file-storage/users/retrieve-a-user"
]
}
]
},



{
"group": "Accounting",
"group": "Accounting Objects",
"pages": [
{
"group": "Accounting Balance Sheets",
Expand Down Expand Up @@ -339,8 +397,17 @@
}
]
},

{
"group": "",
"pages": [
"ats/overview"
]
},


{
"group": "ATS",
"group": "ATS Objects",
"pages": [
{
"group": "Activities",
Expand Down Expand Up @@ -461,8 +528,8 @@
{
"group": "",
"pages": [
"ticketing/overview",
"ticketing/quickstart"
"ticketing/quickstart",
"ticketing/overview"
]
},
{
Expand Down
3 changes: 3 additions & 0 deletions docs/snippets/ats-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
| | Activities | Applications | Candidates | Departments | Interviews | Jobs | Offers | Offices | Scorecard | Users |
|-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:|
| Ashby | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
6 changes: 6 additions & 0 deletions docs/snippets/filestorage-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
| File Storage | Drives | Files | Folders | Groups | Users | Permissions | Shared Links |
|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
| [Google Drive]() | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | |
| [Box]() | | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Dropbox]() | | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [OneDrive]() | ✔️ | ✔️ | ✔️| ✔️ | ✔️ | | |
13 changes: 10 additions & 3 deletions docs/syncwithCode.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,18 @@
# This will import integration tables from codebase

# CRM
grep '^|' ./packages/api/src/crm/README.md > docs/snippets/crm-catalog.mdx
grep '^|' ./packages/api/src/crm/contact/README.md > docs/snippets/crm-contact-catalog.mdx
grep '^|' ../packages/api/src/crm/README.md > snippets/crm-catalog.mdx
grep '^|' ../packages/api/src/crm/contact/README.md > snippets/crm-contact-catalog.mdx

# Ticketing
grep '^|' ./packages/api/src/ticketing/README.md > docs/snippets/ticketing-catalog.mdx
grep '^|' ../packages/api/src/ticketing/README.md > snippets/ticketing-catalog.mdx

#ATS
grep '^|' ../packages/api/src/ats/README.md > snippets/ats-catalog.mdx

# File Storage
grep '^|' ../packages/api/src/filestorage/README.md > snippets/filestorage-catalog.mdx

npx @mintlify/scraping@latest openapi-file openapi-with-code-samples.yaml -o objects

echo "Copy Done!"
1 change: 1 addition & 0 deletions docs/ticketing/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Quick Start"
description: "Read and write data to multiple ticketing platforms using a single API"
icon: "star"
---

## Create a ticket in a ticketing platform using Panora
Expand Down
8 changes: 8 additions & 0 deletions packages/api/src/accounting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### Accounting
Panora supports integration with the following objects across multiple platforms:

| | Object1 | Object2 | Object3 | Object4 | Object5 | Object6 | Object7 | Object8 | Object9 | Object10 |
|-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:|
| Platform | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |

Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
Loading