Skip to content

Commit

Permalink
Merge pull request #10 from ballerina-platform/doc-fix
Browse files Browse the repository at this point in the history 
Fix documentation issues
  • Loading branch information
@ThisaruGuruge
ThisaruGuruge authored Jan 22, 2025
2 parents b81243e + 3162ac0 commit 1cc02d1
Show file tree
Hide file tree
Showing 3 changed files with 171 additions and 183 deletions.
117 changes: 57 additions & 60 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,24 @@
[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems.svg)](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/commits/master)
[![GitHub Issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-library/module/hubspot.crm.object.lineitems.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-library/labels/module%hubspot.crm.object.lineitems)

# Overview
## Overview

[HubSpot](https://www.hubspot.com/our-story) is an AI-powered customer platform.
[HubSpot](https://www.hubspot.com/our-story) is an AI-powered customer platform.

The `ballerinax/hubspot.crm.obj.lineitems` package offers APIs to connect and interact with the [HubSpot CRM Lineitems API](https://developers.hubspot.com/docs/reference/api/crm/objects/line-items) endpoints, specially based on [HubSpot REST API v3](https://developers.hubspot.com/docs/reference/api).

# Setup guide
## Setup guide

To use the HubSpot Line items connector, you must have access to the HubSpot API through a HubSpot developer account and a HubSpot App under it. Therefore, you need to register for a developer account at HubSpot if you don't have one already.
To use the HubSpot Line items connector, you must have access to the HubSpot API through a HubSpot developer account and a HubSpot App under it. Therefore, you need to register for a developer account at HubSpot if you don't have one already.

#### Step 01 : Create/ Login to a HubSpot Developer Account
### Step 01 : Create/ Login to a HubSpot Developer Account

If you have an account already go to the [Hubspot account portal](https://app.hubspot.com/myaccounts-beta)

If you don't have a developer account, register for a free Hubspot developer account.[(click here)](https://app.hubspot.com/signup-hubspot/developers?_ga=2.207749649.2047916093.1734412948-232493525.1734412948&step=landing_page)
If you don't have a developer account, register for a free HubSpot developer account.[(click here)](https://app.hubspot.com/signup-hubspot/developers?_ga=2.207749649.2047916093.1734412948-232493525.1734412948&step=landing_page)

### Step 02 (Optional) : Create a Developer test account:

#### Step 02 (Optional) : Create a Developer test account:
Within app developer accounts, you can create [Developer test accounts](https://developers.hubspot.com/beta-docs/getting-started/account-types#developer-test-accounts) to test apps and integrations without affecting any real HubSpot data.

Note: These accounts are only for development and testing purposes. In production you should not use Developer Test Accounts.
Expand All @@ -31,43 +32,43 @@ Note: These accounts are only for development and testing purposes. In productio

![Hubspot Developer Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/test_acc_1.png)


2. Click Create developer test account.

![Hubspot Developer Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/test_acc_2.png)

3. Create developer test account by providing a name

#### Step 03 : Create a HubSpot App under your account
### Step 03 : Create a HubSpot App under your account

1. In your developer account, navigate to the [Apps](https://app.hubspot.com/developer/48567544/applications) section.
1. In your developer account, navigate to the [Apps](https://app.hubspot.com/developer/48567544/applications) section.
Click on `Create App`
![create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/create_app_1.png)
![create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/create_app_1.png)

2. Provide the necessary details, including the app name and description.

#### Step 04 : Configure the Authentication Flow
### Step 04 : Configure the Authentication Flow

1. Move to the Auth tab.
![alt text](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/image.png)

![alt text](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/image.png)

2. In the Scopes section, add necessary scopes for your app using the "Add new scope" button. For line items API connector we will have to add the following 3 scopes in addition to the existing `oauth` scope.
* `e-commerce`
* `crm.objects.line_items.read`
* `crm.objects.line_items.write`

* `e-commerce`
* `crm.objects.line_items.read`
* `crm.objects.line_items.write`

![Hubspot set scope](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/image-2.png)

3. Add your Redirect URI in the relevant section. You can also use localhost addresses for local development purposes. Click Create App.
3. Add your Redirect URI in the relevant section. You can also use localhost addresses for local development purposes. Click Create App.
![Hubspot create app final](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/create_app_final.png)

### Step 5: Get your Client ID and Client Secret

#### Step 5: Get your Client ID and Client Secret

- Navigate to the Auth section of your app. Make sure to save the provided Client ID and Client Secret.
- Navigate to the Auth section of your app. Make sure to save the provided Client ID and Client Secret.
![Hubspot get credentials](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/main/docs/setup/resources/get_credentials.png)

#### Step 6: Setup Authentication Flow
### Step 6: Setup Authentication Flow

Before proceeding with the Quickstart, ensure you have obtained the Access Token using the following steps:

Expand All @@ -77,17 +78,13 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token
https://app.hubspot.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&scope=<YOUR_SCOPES>&redirect_uri=<YOUR_REDIRECT_URI>
```

Replace `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>` and `<YOUR_SCOPES>` with your specific value.
Replace `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>`, and `<YOUR_SCOPES>` with your specific value.

2. Paste it in the browser and select your developer test account to install the app when prompted.

3. A code will be displayed in the browser. Copy the code.

```
Received code: na1-129d-860c-xxxx-xxxx-xxxxxxxxxxxx
```

4. Run the following curl command. Replace `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI`> and `<YOUR_CLIENT_SECRET>` with your specific value. Use the code you received in the above step 3 as the `<CODE>`.
4. Run the following curl command. Replace `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>`, and `<YOUR_CLIENT_SECRET>` with your specific value. Use the code you received in the above step 3 as the `<CODE>`.

- Linux/macOS

Expand Down Expand Up @@ -120,20 +117,20 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token

5. Store the access token securely for use in your application.

# Quickstart
## Quickstart

To use the `HubSpot CRM Object Line items` connector in your Ballerina application, update the `.bal` file as follows:

#### Step 1: Import the module
### Step 1: Import the module

Import the `hubspot.crm.obj.lineitems` module and `oauth2` module.
Import the `ballerinax/hubspot.crm.obj.lineitems` module and `oauth2` module.

```ballerina
import ballerinax/hubspot.crm.obj.lineitems as hslineitems;
import ballerina/oauth2;
```

#### Step 2: Instantiate a new connector
### Step 2: Instantiate a new connector

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

Expand All @@ -146,11 +143,12 @@ import ballerina/oauth2;
clientId,
clientSecret,
refreshToken,
credentialBearer: oauth2:POST_BODY_BEARER
credentialBearer: oauth2:POST_BODY_BEARER
};
final hslineitems:Client hubSpotLineItems = check new ({ auth });
```

2. Create a `Config.toml` file and, configure the obtained credentials obtained in the above steps as follows:

```toml
Expand All @@ -159,54 +157,53 @@ import ballerina/oauth2;
refreshToken = <Refresh Token>
```

#### Step 3: Invoke the connector operation
### Step 3: Invoke the connector operation

Now, utilize the available connector operations. A sample usecase is shown below.
Now, utilize the available connector operations. A sample use case is shown below.

#### Create a New Line item

```bash
```ballerina
public function main() returns error? {
hslineitems:SimplePublicObjectInputForCreate payload = {
"associations": [
{
"types": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 20
"associations": [
{
"types": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 20
}
],
"to": {
"id": "31232284502"
}
}
],
"objectWriteTraceId": "2",
"properties": {
"price": "400.00",
"quantity": "10",
"name": "Item 6"
}
],
"to": {
"id": "31232284502"
}
}
],"objectWriteTraceId": "2",
"properties": {
"price": "400.00",
"quantity": "10",
"name": "Item 6"
}
};
hslineitems::SimplePublicObject response = check hubSpotLineItems->/crm/v3/objects/line_items.post(payload);
};
hslineitems::SimplePublicObject response = check hubSpotLineItems->/crm/v3/objects/line_items.post(payload);
}
```
#### Step 4 : Run the Ballerina application

### Step 4 : Run the Ballerina application

```bash
bal run
```

# Examples
## Examples

The `Ballerina HubSpot CRM Lineitems Connector` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-hubspot.crm.object.lineitems/tree/main/examples/), covering the following use cases:

1. [Customer Order fulfillment](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/tree/main/examples/customer-order-fulfillment) - Manage customer orders in a warehouse system
2. [Inventory management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.object.lineitems/tree/main/examples/inventory-management) - Manage inventory for an operational deal in an E-commerce platform

# Build from the source
## Build from the source

### Setting up the prerequisites

Expand Down
Loading

0 comments on commit 1cc02d1

Please sign in to comment.