README.md

Ballerina HubSpot CRM Commerce Taxes connector

Overview

HubSpot is an AI-powered customer relationship management (CRM) platform.

The ballerinax/hubspot.crm.commerce.taxes offers APIs to connect and interact with the Taxes endpoints, specifically based on the HubSpot REST API

Setup guide

You need a HubSpot developer account with an app to use HubSpot connectors.

Step 1: Create HubSpot Developer Project

1. 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.

   

Finally "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.

   

   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=<client_id>&redirect_uri=<redirect_url>&scope=<scopes>
   

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

     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=<CODE>&redirect_uri=<YOUR_REDIRECT_URI>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_CLIENT_SECRET>'

   • Windows

     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=<CODE>&redirect_uri=<YOUR_REDIRECT_URI>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_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.

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:

    clientId = <Client Id>
    clientSecret = <Client Secret>
    refreshToken = <Refresh Token>

2. Instantiate a OAuth2RefreshTokenGrantConfig with the obtained credentials and initialize the connector with it.

   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 usecase is shown below.

Create a New Tax

   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, covering the following use cases:

1. 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 - 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
   • OpenJDK

   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.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./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.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the hubspot.crm.commerce.taxes package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.