feat: File Storage APIs

panoratech · Jul 28, 2024 · 3349d3e · 3349d3e
1 parent ade8f7d
commit 3349d3e
Show file tree

Hide file tree

Showing 25 changed files with 195 additions and 68 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/accounting/quickstart.mdx b/docs/accounting/quickstart.mdx
@@ -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).
diff --git a/docs/ats/overview.mdx b/docs/ats/overview.mdx
@@ -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 />
diff --git a/docs/catalog.mdx b/docs/catalog.mdx
@@ -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>
@@ -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>
@@ -84,4 +82,9 @@ icon: album-collection
   } horizontal>
   </Card>
 </CardGroup>
+  </Tab>
+
+</Tabs>
+
+
 
diff --git a/docs/crm/overview.mdx b/docs/crm/overview.mdx
@@ -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 />
diff --git a/docs/crm/quickstart.mdx b/docs/crm/quickstart.mdx
@@ -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

diff --git a/docs/file-storage/drives/list-drives.mdx b/docs/file-storage/drives/list-drives.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/drives
+---
diff --git a/docs/file-storage/drives/retrieve-a-drive.mdx b/docs/file-storage/drives/retrieve-a-drive.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/drives/{id}
+---
diff --git a/docs/file-storage/files/create-a-file.mdx b/docs/file-storage/files/create-a-file.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /filestorage/files
+---
diff --git a/docs/file-storage/files/list-files.mdx b/docs/file-storage/files/list-files.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/files
+---
diff --git a/docs/file-storage/files/retrieve-a-file.mdx b/docs/file-storage/files/retrieve-a-file.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/files/{id}
+---
diff --git a/docs/file-storage/groups/list-groups.mdx b/docs/file-storage/groups/list-groups.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/groups
+---
diff --git a/docs/file-storage/groups/retrieve-a-group.mdx b/docs/file-storage/groups/retrieve-a-group.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/groups/{id}
+---
diff --git a/docs/file-storage/olders/create-a-folder.mdx b/docs/file-storage/olders/create-a-folder.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /filestorage/folders
+---
diff --git a/docs/file-storage/olders/list-folders.mdx b/docs/file-storage/olders/list-folders.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/folders
+---
diff --git a/docs/file-storage/olders/retrieve-a-folder.mdx b/docs/file-storage/olders/retrieve-a-folder.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/folders/{id}
+---
diff --git a/docs/file-storage/overview.mdx b/docs/file-storage/overview.mdx
@@ -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 />
diff --git a/docs/file-storage/users/list-users.mdx b/docs/file-storage/users/list-users.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/users
+---
diff --git a/docs/file-storage/users/retrieve-a-user.mdx b/docs/file-storage/users/retrieve-a-user.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /filestorage/users/{id}
+---
diff --git a/docs/mint.json b/docs/mint.json
@@ -72,6 +72,10 @@
             "name": "CRM",
             "url": "crm"
         },
+        {
+            "name": "File Storage",
+            "url": "file-storage"
+        },
         {
             "name": "Ticketing",
             "url": "ticketing"
@@ -94,8 +98,8 @@
         {
             "group": "",
             "pages": [
-                "crm/overview",
-                "crm/quickstart"
+                "crm/quickstart",
+                "crm/overview"
             ]
         },
         {
@@ -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",
@@ -339,8 +397,17 @@
                 }
             ]
         },
+
+        {
+            "group": "",
+            "pages": [
+                "ats/overview"            
+            ]
+        },
+
+
         {
-            "group": "ATS",
+            "group": "ATS Objects",
             "pages": [
                 {
                     "group": "Activities",
@@ -461,8 +528,8 @@
         {
             "group": "",
             "pages": [
-                "ticketing/overview",
-                "ticketing/quickstart"
+                "ticketing/quickstart",
+                "ticketing/overview"
             ]
         },
         {

diff --git a/docs/snippets/ats-catalog.mdx b/docs/snippets/ats-catalog.mdx
@@ -0,0 +1,3 @@
+|             | Activities | Applications | Candidates | Departments | Interviews | Jobs | Offers | Offices | Scorecard | Users |
+|-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:|
+| Ashby       | ✔          | ✔            | ✔          | ✔           | ✔          | ✔    | ✔      | ✔       | ✔         | ✔     |
diff --git a/docs/snippets/filestorage-catalog.mdx b/docs/snippets/filestorage-catalog.mdx
@@ -0,0 +1,6 @@
+| File Storage                                           | Drives | Files | Folders | Groups | Users | Permissions | Shared Links |
+|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
+| [Google Drive]()            |       ✔️ |  ✔️   |   ✔️  |        ✔️   | ✔️    |     |           |
+| [Box]()        |        |   ✔️   |   ✔️   |      ✔️     |  ✔️    |  ✔️   |           |
+| [Dropbox]()          |       |  ✔️   |   ✔️  | ✔️          |   ✔️  |   ✔️  |           |
+| [OneDrive]() |      ✔️ | ✔️   |    ✔️|      ✔️  |   ✔️  |     |           |
diff --git a/docs/syncwithCode.sh b/docs/syncwithCode.sh
@@ -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!"
diff --git a/docs/ticketing/quickstart.mdx b/docs/ticketing/quickstart.mdx
@@ -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

diff --git a/packages/api/src/accounting/README.md b/packages/api/src/accounting/README.md
@@ -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)