diff --git a/docs/catalog.mdx b/docs/catalog.mdx index 0a3e9158f..23ebd1de1 100644 --- a/docs/catalog.mdx +++ b/docs/catalog.mdx @@ -52,6 +52,18 @@ icon: album-collection } horizontal> + + } horizontal> + + + } horizontal> + + + } horizontal> + @@ -66,7 +78,7 @@ icon: album-collection + } horizontal> } horizontal> + + } horizontal> + + + + + } horizontal> + + + + diff --git a/docs/hris/overview.mdx b/docs/hris/overview.mdx new file mode 100644 index 000000000..b150243b0 --- /dev/null +++ b/docs/hris/overview.mdx @@ -0,0 +1,10 @@ +--- +title: 'Overview' +description: '' +--- +import hrisCatalog from '/snippets/hris-catalog.mdx'; + +Welcome to the reference documentation for the Panora HRIS API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. + +## Supported HRIS Providers & Objects + \ No newline at end of file diff --git a/docs/hris/quickstart.mdx b/docs/hris/quickstart.mdx new file mode 100644 index 000000000..d46c93e4f --- /dev/null +++ b/docs/hris/quickstart.mdx @@ -0,0 +1,89 @@ +--- +title: "Quick Start" +description: "Read and write data to multiple HRIS platforms using a single API" +icon: "star" +--- + +## Get employees in an HRIS 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 { Panora } from '@panora/sdk'; + const panora = new Panora({ apiKey: process.env.API_KEY }); + ``` + + ```python Python SDK + import os + from panora_sdk import Panora + panora = Panora( + api_key=os.getenv("API_KEY", ""), + ) + ``` + + + + + In this example, we will get employees in an HRIS. Visit other sections of the documentation to find category-specific examples + + + ```shell curl + curl --request GET \ + --url https://api.panora.dev/hris/employees \ + --header 'x-api-key: ' \ + --header 'Content-Type: application/json' \ + --header 'x-connection-token: ' \ + ``` + + ```javascript TypeScript + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: process.env.API_KEY, + }); + + const result = await panora.hris.employees.list({ + xConnectionToken: "", + remoteData: true, + limit: 10, + cursor: "1b8b05bb-5273-4012-b520-8657b0b90874", + }); + + for await (const page of result) { + // handle page + } + + console.log(result); + ``` + + ```python Python + import os + from panora_sdk import Panora + + panora = Panora( + api_key=os.getenv("API_KEY", ""), + ) + + res = panora.ticketing.tickets.list(x_connection_token="", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874") + + if res is not None: + while True: + # handle items + + res = res.Next() + if res is None: + break + ``` + + + + diff --git a/docs/integrations/ecommerce/amazon/index.mdx b/docs/integrations/ecommerce/amazon/index.mdx new file mode 100644 index 000000000..c4cbdfb6b --- /dev/null +++ b/docs/integrations/ecommerce/amazon/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Amazon" +description: "" +--- + +# Common Objects + + +| Unified Model | Supported | Provider Endpoints | +| -------- | ------------------------------------- | ------------------------------------- | +| Customer | Yes ✅ | /admin/api/2024-07/customers.json | +| Order | Yes ✅ | /admin/api/2024-07/orders.json | +| Fulfillment | Yes ✅ | /admin/api/2024-07/orders/:remote_order_id/fulfillments.json| +| Fulfillment Orders | No 🚫| | +| Product | Yes ✅ | /admin/api/2024-07/products.json | + + +| Features | Supported | +| -------- | ------------------------------------- | +| Scopes | | +| Realtime webhook | No 🚫| \ No newline at end of file diff --git a/docs/integrations/ecommerce/index.mdx b/docs/integrations/ecommerce/index.mdx index 931fa1f19..c25b37ebf 100644 --- a/docs/integrations/ecommerce/index.mdx +++ b/docs/integrations/ecommerce/index.mdx @@ -9,4 +9,16 @@ icon: crab } horizontal> + + } horizontal> + + + } horizontal> + + + } horizontal> + diff --git a/docs/integrations/ecommerce/squarespace/index.mdx b/docs/integrations/ecommerce/squarespace/index.mdx new file mode 100644 index 000000000..f7ddf2d7b --- /dev/null +++ b/docs/integrations/ecommerce/squarespace/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Squarespace" +description: "" +--- + +# Common Objects + + +| Unified Model | Supported | Provider Endpoints | +| -------- | ------------------------------------- | ------------------------------------- | +| Customer | Yes ✅ | /admin/api/2024-07/customers.json | +| Order | Yes ✅ | /admin/api/2024-07/orders.json | +| Fulfillment | Yes ✅ | /admin/api/2024-07/orders/:remote_order_id/fulfillments.json| +| Fulfillment Orders | No 🚫| | +| Product | Yes ✅ | /admin/api/2024-07/products.json | + + +| Features | Supported | +| -------- | ------------------------------------- | +| Scopes | | +| Realtime webhook | No 🚫| \ No newline at end of file diff --git a/docs/integrations/ecommerce/woocommerce/index.mdx b/docs/integrations/ecommerce/woocommerce/index.mdx new file mode 100644 index 000000000..0931aeca0 --- /dev/null +++ b/docs/integrations/ecommerce/woocommerce/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Woocommerce" +description: "" +--- + +# Common Objects + + +| Unified Model | Supported | Provider Endpoints | +| -------- | ------------------------------------- | ------------------------------------- | +| Customer | Yes ✅ | /admin/api/2024-07/customers.json | +| Order | Yes ✅ | /admin/api/2024-07/orders.json | +| Fulfillment | Yes ✅ | /admin/api/2024-07/orders/:remote_order_id/fulfillments.json| +| Fulfillment Orders | No 🚫| | +| Product | Yes ✅ | /admin/api/2024-07/products.json | + + +| Features | Supported | +| -------- | ------------------------------------- | +| Scopes | | +| Realtime webhook | No 🚫| \ No newline at end of file diff --git a/docs/integrations/hris/gusto/index.mdx b/docs/integrations/hris/gusto/index.mdx new file mode 100644 index 000000000..aecd42b50 --- /dev/null +++ b/docs/integrations/hris/gusto/index.mdx @@ -0,0 +1,30 @@ +--- +title: "Gusto" +description: "" +--- + +# Common Objects + +| Unified Model | Supported | Provider Endpoints | +| ---------------- | --------- | ------------------ | +| Bankinfo | No 🚫 | | +| Benefit | Yes ✅ | /v1/employees/${employee.remote_id}/employee_benefits | +| Company | Yes ✅ | /v1/companies/${id} | +| Dependent | No 🚫 | | +| Employee | Yes ✅ | /v1/companies/${company.remote_id}/employees | +| Employeepayrollrun | No 🚫 | | +| Employerbenefit | Yes ✅ | /v1/companies/${company.remote_id}/company_benefits | +| Employment | Yes ✅ | /v1/companies/${company.remote_id}/employees | +| Group | Yes ✅ | /v1/companies/${company.remote_id}/departments | +| Location | Yes ✅ | [/v1/employees/${employee.remote_id}/work_addresses , /v1/employees/${employee.remote_id}/home_addresses] | +| Paygroup | No 🚫 | | +| Payrollrun | No 🚫 | | +| Timeoff | No 🚫 | | +| Timeoffbalance | No 🚫 | | +| Timesheetentry | No 🚫 | | + + +| Features | Supported | +| -------- | ------------------------------------- | +| Scopes || +| Realtime webhook | No 🚫| \ No newline at end of file diff --git a/docs/integrations/hris/index.mdx b/docs/integrations/hris/index.mdx new file mode 100644 index 000000000..8a01ce2eb --- /dev/null +++ b/docs/integrations/hris/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Providers" +description: "" +icon: crab +--- + + + + } horizontal> + + diff --git a/docs/integrations/ticketing/github/index.mdx b/docs/integrations/ticketing/github/index.mdx new file mode 100644 index 000000000..f4ff6ee37 --- /dev/null +++ b/docs/integrations/ticketing/github/index.mdx @@ -0,0 +1,25 @@ +--- +title: "Github" +description: "" +--- + +# Common Objects + + +| Unified Model | Supported | Provider Endpoints | +| -------- | ------------------------------------- | ------------------------------------- | +| Account | Yes ✅ | /accounts | +| Attachment | No 🚫 | Coming Soon | +| Collection |No 🚫 | | +| Comment | Yes ✅| /conversations/:remote_ticket_id/comments | +| Contact | Yes ✅ | /contacts | +| Tag | Yes ✅| /tags | +| Team | Yes ✅| /teams | +| Ticket | Yes ✅ | /conversations | +| User | Yes ✅| /teammates| + + +| Features | Supported | +| -------- | ------------------------------------- | +| Scopes | | +| Realtime webhook | No 🚫| \ No newline at end of file diff --git a/docs/integrations/ticketing/index.mdx b/docs/integrations/ticketing/index.mdx index 1ea6c979c..0f66b1a37 100644 --- a/docs/integrations/ticketing/index.mdx +++ b/docs/integrations/ticketing/index.mdx @@ -21,4 +21,8 @@ icon: crab } horizontal> + + } horizontal> + diff --git a/docs/mint.json b/docs/mint.json index b893a8287..5456ae6ec 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -135,6 +135,13 @@ } ] }, + { + "group": "", + "pages": [ + "hris/quickstart", + "hris/overview" + ] + }, { "group": "", "pages": [ @@ -915,6 +922,10 @@ "name": "E-Commerce", "url": "ecommerce" }, + { + "name": "HRIS", + "url": "hris" + }, { "name": "File Storage", "url": "file-storage" diff --git a/docs/snippets/hris-catalog.mdx b/docs/snippets/hris-catalog.mdx new file mode 100644 index 000000000..9fc70aee0 --- /dev/null +++ b/docs/snippets/hris-catalog.mdx @@ -0,0 +1,3 @@ +| | Bankinfo | Benefit | Company | Dependent | Employee | Employeepayrollrun | Employerbenefit | Employment | Group | Location | Paygroup | Payrollrun | Timeoff | Timeoffbalance | Timesheetentry | +|-------------|----------|:-------:|:-------:|:---------:|:--------:|:------------------:|:---------------:|:----------:|:-----:|:--------:|:--------:|:----------:|:-------:|:--------------:|:---------------:| +| Gusto | ❌ | ✔ | ✔ | ❌ | ✔ | ❌ | ✔ | ✔ | ✔ | ✔ | ❌ | ❌ | ❌ | ❌ | ❌ | \ No newline at end of file