https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes
This Ballerina connector provides capabilities to integrate with HubSpot CRM Taxes API.
https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes
ballerina connectors crm hubspot integration library
Last synced: 5 months ago
JSON representation
This Ballerina connector provides capabilities to integrate with HubSpot CRM Taxes API.
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2024-12-16T04:45:04.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-05-16T06:47:30.000Z (7 months ago)
- Last Synced: 2025-06-19T05:15:40.081Z (5 months ago)
- Topics: ballerina, connectors, crm, hubspot, integration, library
- Language: Ballerina
- Size: 1.82 MB
- Stars: 0
- Watchers: 47
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ballerina HubSpot CRM Commerce Taxes connector
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/actions/workflows/ci.yml)
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/commits/master)
[](https://github.com/ballerina-platform/ballerina-library/labels/module%hubspot.crm.commerce.taxes)
## Overview
[HubSpot](https://www.hubspot.com) is an AI-powered customer relationship management (CRM) platform.
The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact with the [Taxes](https://developers.hubspot.com/docs/guides/api/crm/commerce/taxes) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api)
## Setup guide
You need a [HubSpot developer account](https://developers.hubspot.com/get-started) with an [app](https://developers.hubspot.com/docs/guides/apps/public-apps/overview) to use HubSpot connectors.
### Step 1: Create HubSpot Developer Project
1. [Login](https://app.hubspot.com/login) to HubSpot developer account.
2. Create a public app by clicking on Create app.
3. Click on "Create app".
4. Under "App Info"
- Enter "Public app name".
- Update "App logo" (optional).
- Update "Description" (optional).
Then move to the "Auth" tab.
5. Setup the "Redirect URLs" with respective links.
6. Finally click on "Create app".
### Step 2: Get `Client ID` and `Client secret`
Navigate to the "Auth" tab.
### Step 3: Get `access token` and `refresh token`
1. Set scopes under "Auth" tab for your app based on the [API requirements](https://developers.hubspot.com/docs/reference/api).
Enable scopes required for HubSpot CRM Taxes API based on your use case.
- `crm.objects.line_items.read`
- `crm.objects.line_items.write`
- `oauth`
2. In the "Auth" tab under "Sample install URL (OAuth)" section "Copy full URL".
> **Note:** The above copied URL is in the following format.
```
https://app.hubspot.com/oauth/authorize?client_id=&redirect_uri=&scope=
```
3. Choose the preferred account.
Choose account and authorize the client.
4. "This site can’t be reached" message will appear. Look in the URL and find the authorization code.
5. Send a http request to the HubSpot.
- Linux/macOS
```bash
curl --request POST \
--url https://api.hubapi.com/oauth/v1/token \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'grant_type=authorization_code&code=&redirect_uri=&client_id=&client_secret='
```
- Windows
```bash
curl --request POST ^
--url https://api.hubapi.com/oauth/v1/token ^
--header 'content-type: application/x-www-form-urlencoded' ^
--data 'grant_type=authorization_code&code=&redirect_uri=&client_id=&client_secret='
```
6. Above command returns the `access token` and `refresh token`.
7. Use these tokens to authorize the client.
## Quickstart
To use the `HubSpot CRM Commerce Taxes` connector in your Ballerina application, update the `.bal` file as follows:
### Step 1: Import the module
Import the `hubspot.crm.commerce.taxes` module and `oauth2` module.
```ballerina
import ballerina/oauth2;
import ballerinax/hubspot.crm.commerce.taxes;
```
### Step 2: Instantiate a new connector
1. Create a `Config.toml` file and, configure the obtained credentials obtained in the above steps as follows:
```toml
clientId =
clientSecret =
refreshToken =
```
2. Instantiate a `OAuth2RefreshTokenGrantConfig` with the obtained credentials and initialize the connector with it.
```ballerina
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
taxes:ConnectionConfig config = {
auth : {
clientId,
clientSecret,
refreshToken,
credentialBearer: oauth2:POST_BODY_BEARER
}
};
final taxes:Client hubSpotClient = check new (config);
```
### Step 3: Invoke the connector operation
Now, utilize the available connector operations. A sample use case is shown below.
#### Create a New Tax
```ballerina
taxes:SimplePublicObjectInputForCreate payload = {
associations: [],
objectWriteTraceId: "1234",
properties: {
"hs_label": "A percentage-based tax of 6%",
"hs_type": "PERCENT",
"hs_value": "6"
}
taxes:SimplePublicObject response = check hubspotClientTax->/.post(payload);
};
```
## Examples
The `HubSpot CRM Commerce Taxes` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples), covering the following use cases:
1. [Manage Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/manage-taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to create a tax and manage it through the sales pipeline.
2. [Search Taxes](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.taxes/tree/main/examples/search_taxes/) - see how the Ballerina `hubspot.crm.commerce.taxes` connector can be used to search for taxes using properties and create a batch of taxes
## Build from the source
### Setting up the prerequisites
1. Download and install Java SE Development Kit (JDK) version 21. 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 [`hubspot.crm.commerce.taxes` package](https://central.ballerina.io/ballerinax/hubspot.crm.commerce.taxes/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.