source-planhat contribution from natikgadzhi (#44566)
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
This commit is contained in:
49
airbyte-integrations/connectors/source-planhat/README.md
Normal file
49
airbyte-integrations/connectors/source-planhat/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Planhat
|
||||
This directory contains the manifest-only connector for `source-planhat`.
|
||||
|
||||
This source can sync data for the [general Planhat API](https://docs.planhat.com/)
|
||||
|
||||
This Source is capable of syncing the following core Streams:
|
||||
|
||||
- [companies](https://docs.planhat.com/#companies)
|
||||
- [conversations](https://docs.planhat.com/#conversations)
|
||||
- [custom_fields](https://docs.planhat.com/#custom_fields)
|
||||
- [endusers](https://docs.planhat.com/#endusers)
|
||||
- [invoices](https://docs.planhat.com/#invoices)
|
||||
- [issues](https://docs.planhat.com/#issues)
|
||||
- [licenses](https://docs.planhat.com/#licenses)
|
||||
- [nps](https://docs.planhat.com/#nps)
|
||||
- [opportunities](https://docs.planhat.com/#opportunities)
|
||||
- [objectives](https://docs.planhat.com/#objectives)
|
||||
- [sales](https://docs.planhat.com/#sales)
|
||||
- [tasks](https://docs.planhat.com/#tasks)
|
||||
- [tickets](https://docs.planhat.com/#tickets)
|
||||
- [users](https://docs.planhat.com/#users)
|
||||
## Usage
|
||||
|
||||
- You can use this connector as any other connector in Airbyte Marketplace.
|
||||
- You can load this connector in `pyairbyte` using `get_source`!
|
||||
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
|
||||
|
||||
Please refer to the manifest-only connector documentation for more details.
|
||||
|
||||
## Local Development
|
||||
We recommend you use the Connector Builder to edit this connector.
|
||||
|
||||
But, if you want to develop this connector locally, you can use the following steps.
|
||||
|
||||
### Environment Setup
|
||||
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).
|
||||
|
||||
### Build
|
||||
This will create a dev image (`source-planhat:dev`) that you can use to test the connector locally.
|
||||
```bash
|
||||
airbyte-ci connectors --name=source-planhat build
|
||||
```
|
||||
|
||||
### Test
|
||||
This will run the acceptance tests for the connector.
|
||||
```bash
|
||||
airbyte-ci connectors --name=source-planhat test
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
|
||||
# for more information about how to configure these tests
|
||||
connector_image: airbyte/source-planhat:dev
|
||||
acceptance_tests:
|
||||
spec:
|
||||
tests:
|
||||
- spec_path: "manifest.yaml"
|
||||
connection:
|
||||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
|
||||
discovery:
|
||||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
|
||||
basic_read:
|
||||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
|
||||
incremental:
|
||||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
|
||||
full_refresh:
|
||||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
|
||||
15
airbyte-integrations/connectors/source-planhat/icon.svg
Normal file
15
airbyte-integrations/connectors/source-planhat/icon.svg
Normal file
@@ -0,0 +1,15 @@
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
|
||||
width="400.000000pt" height="400.000000pt" viewBox="0 0 400.000000 400.000000"
|
||||
preserveAspectRatio="xMidYMid meet">
|
||||
|
||||
<g transform="translate(0.000000,400.000000) scale(0.100000,-0.100000)"
|
||||
fill="#000000" stroke="none">
|
||||
<path d="M0 2000 l0 -2000 2000 0 2000 0 0 2000 0 2000 -2000 0 -2000 0 0
|
||||
-2000z m2195 710 c151 -39 311 -137 401 -247 58 -72 119 -198 145 -302 11 -45
|
||||
19 -84 17 -87 -2 -2 -42 3 -89 10 -204 35 -308 41 -674 41 -363 0 -466 -7
|
||||
-692 -43 -62 -10 -61 -12 -38 85 53 223 224 423 439 511 156 63 325 74 491 32z
|
||||
m105 -720 c485 -34 850 -131 981 -260 74 -73 72 -137 -7 -210 -116 -107 -425
|
||||
-199 -809 -242 -181 -20 -801 -17 -971 5 -277 35 -512 93 -659 163 -33 16 -84
|
||||
51 -113 79 -50 49 -52 53 -52 104 0 49 3 55 48 99 192 190 909 309 1582 262z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 813 B |
2432
airbyte-integrations/connectors/source-planhat/manifest.yaml
Normal file
2432
airbyte-integrations/connectors/source-planhat/manifest.yaml
Normal file
File diff suppressed because it is too large
Load Diff
35
airbyte-integrations/connectors/source-planhat/metadata.yaml
Normal file
35
airbyte-integrations/connectors/source-planhat/metadata.yaml
Normal file
@@ -0,0 +1,35 @@
|
||||
metadataSpecVersion: "1.0"
|
||||
data:
|
||||
allowedHosts:
|
||||
hosts:
|
||||
- api.planhat.com
|
||||
registryOverrides:
|
||||
oss:
|
||||
enabled: true
|
||||
cloud:
|
||||
enabled: true
|
||||
remoteRegistries:
|
||||
pypi:
|
||||
enabled: false
|
||||
packageName: airbyte-source-planhat
|
||||
connectorBuildOptions:
|
||||
baseImage: docker.io/airbyte/source-declarative-manifest:4.5.4@sha256:b07a521add11f987c63c0db68c1b57e90bec0c985f1cb6f3c5a1940cde628a70
|
||||
connectorSubtype: api
|
||||
connectorType: source
|
||||
definitionId: 03fdd212-bd09-4e7b-b472-5b8f1b73969b
|
||||
dockerImageTag: 0.0.1
|
||||
dockerRepository: airbyte/source-planhat
|
||||
githubIssueLabel: source-planhat
|
||||
icon: icon.svg
|
||||
license: MIT
|
||||
name: Planhat
|
||||
releaseDate: 2024-08-22
|
||||
releaseStage: alpha
|
||||
supportLevel: community
|
||||
documentationUrl: https://docs.airbyte.com/integrations/sources/planhat
|
||||
tags:
|
||||
- language:manifest-only
|
||||
- cdk:low-code
|
||||
ab_internal:
|
||||
ql: 100
|
||||
sl: 100
|
||||
73
docs/integrations/sources/planhat.md
Normal file
73
docs/integrations/sources/planhat.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Planhat
|
||||
This source can sync data for the [general Planhat API](https://docs.planhat.com/)
|
||||
|
||||
This Source is capable of syncing the following core Streams:
|
||||
|
||||
- [companies](https://docs.planhat.com/#companies)
|
||||
- [conversations](https://docs.planhat.com/#conversations)
|
||||
- [custom_fields](https://docs.planhat.com/#custom_fields)
|
||||
- [endusers](https://docs.planhat.com/#endusers)
|
||||
- [invoices](https://docs.planhat.com/#invoices)
|
||||
- [issues](https://docs.planhat.com/#issues)
|
||||
- [licenses](https://docs.planhat.com/#licenses)
|
||||
- [nps](https://docs.planhat.com/#nps)
|
||||
- [opportunities](https://docs.planhat.com/#opportunities)
|
||||
- [objectives](https://docs.planhat.com/#objectives)
|
||||
- [sales](https://docs.planhat.com/#sales)
|
||||
- [tasks](https://docs.planhat.com/#tasks)
|
||||
- [tickets](https://docs.planhat.com/#tickets)
|
||||
- [users](https://docs.planhat.com/#users)
|
||||
## Configuration
|
||||
|
||||
| Input | Type | Description | Default Value |
|
||||
|-------|------|-------------|---------------|
|
||||
| `api_token` | `string` | API Token. Your Planhat <a href="https://docs.planhat.com/#authentication">API Access Token</a> | |
|
||||
|
||||
## Streams
|
||||
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|
||||
|-------------|-------------|------------|---------------------|----------------------|
|
||||
| assets | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| churn | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| companies | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| conversations | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| custom_fields | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| endusers | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| invoices | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| issues | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| licenses | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| nps | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| workflows | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| opportunities | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| objectives | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| sales | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| tasks | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| tickets | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
| users | _id | DefaultPaginator | ✅ | ❌ |
|
||||
|
||||
|
||||
## Changelog
|
||||
|
||||
<details>
|
||||
<summary>Expand to review</summary>
|
||||
|
||||
| Version | Date | Subject |
|
||||
|------------------|------------|----------------|
|
||||
| 0.0.1 | 2024-08-22 | Initial release by natikgadzhi via Connector Builder|
|
||||
|
||||
</details>
|
||||
Reference in New Issue
Block a user