https://github.com/ballerina-platform/module-ballerinax-intercom
This Ballerina connector provides capabilities to integrate with Intercom.
https://github.com/ballerina-platform/module-ballerinax-intercom
ballerina integration intercom wso2
Last synced: 4 months ago
JSON representation
This Ballerina connector provides capabilities to integrate with Intercom.
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerinax-intercom
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2024-10-15T03:35:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T04:55:01.000Z (over 1 year ago)
- Last Synced: 2024-10-29T05:31:50.925Z (over 1 year ago)
- Topics: ballerina, integration, intercom, wso2
- Language: Ballerina
- Homepage: https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis
- Size: 63.5 KB
- Stars: 0
- Watchers: 48
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ballerina Intercom connector
[](https://github.com/ballerina-platform/module-ballerinax-intercom/actions/workflows/ci.yml)
[](https://github.com/ballerina-platform/module-ballerinax-intercom/actions/workflows/trivy-scan.yml)
[](https://github.com/ballerina-platform/module-ballerinax-intercom/actions/workflows/build-with-bal-test-graalvm.yml)
[](https://github.com/ballerina-platform/module-ballerinax-intercom/commits/master)
[](https://github.com/ballerina-platform/ballerina-library/labels/module%intercom)
## Overview
[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
## Setup guide
[//]: # (TODO: Add detailed steps to obtain credentials and configure the module.)
## Quickstart
[//]: # (TODO: Add a quickstart guide to demonstrate a basic functionality of the module, including sample code snippets.)
## Examples
The `Intercom` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-intercom/tree/main/examples/), covering the following use cases:
[//]: # (TODO: Add examples)
## Build from the source
### Setting up the prerequisites
1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:
* [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
* [OpenJDK](https://adoptium.net/)
> **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.
2. Download and install [Ballerina Swan Lake](https://ballerina.io/).
3. Download and install [Docker](https://www.docker.com/get-started).
> **Note**: Ensure that the Docker daemon is running before executing any tests.
4. Export Github Personal access token with read package permissions as follows,
```bash
export packageUser=
export packagePAT=
```
### Build options
Execute the commands below to build from the source.
1. To build the package:
```bash
./gradlew clean build
```
2. To run the tests:
```bash
./gradlew clean test
```
3. To build the without the tests:
```bash
./gradlew clean build -x test
```
4. To run tests against different environments:
```bash
./gradlew clean test -Pgroups=
```
5. To debug the package with a remote debugger:
```bash
./gradlew clean build -Pdebug=
```
6. To debug with the Ballerina language:
```bash
./gradlew clean build -PbalJavaDebug=
```
7. Publish the generated artifacts to the local Ballerina Central repository:
```bash
./gradlew clean build -PpublishToLocalCentral=true
```
8. Publish the generated artifacts to the Ballerina Central repository:
```bash
./gradlew clean build -PpublishToCentral=true
```
## Contribute to Ballerina
As an open-source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
## Code of conduct
All the contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
## Useful links
* For more information go to the [`intercom` package](https://central.ballerina.io/ballerinax/intercom/latest).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.