Skip to content

Commit

Permalink
Merge pull request #9 from ballerina-platform/doc-fix
Browse files Browse the repository at this point in the history 
Fix documentation issues
  • Loading branch information
@MohamedSabthar
MohamedSabthar authored Jan 22, 2025
2 parents 6e313bb + c1989b9 commit e8e2a3c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Within app developer accounts, you can create [developer test account](https://d

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

### Step 3: Create a HubSpot App under your account.
### Step 3: Create a HubSpot App under your account

1. In your developer account, navigate to the "Apps" section. Click on "Create App"

![Hubspot Create App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/create_app_1.png)

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

### Step 4: Configure the Authentication Flow.
### Step 4: Configure the Authentication Flow

1. Move to the Auth Tab. (Second tab next to App Info)

Expand Down Expand Up @@ -91,13 +91,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 the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>` and `<YOUR_SCOPES>` with your specific value.
Replace the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>`, and `<YOUR_SCOPES>` with your specific value.

![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)
![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)

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

4. Run the following curl command. Replace the `<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>`.
3. Run the following curl command. Replace the `<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 @@ -128,7 +128,7 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token
}
```

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

## Quickstart

Expand Down Expand Up @@ -159,7 +159,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
final orders:ConnectionConfig config = {
auth : {
clientId,
Expand All @@ -173,7 +173,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;

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

#### Read an order by ID

Expand All @@ -188,7 +188,7 @@ public function main() returns error? {
The `HubSpot CRM Commerce Orders` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/), covering the following use cases:

1. [Batch Operations](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/batch-operations) - Perform Batch operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perford CRUD operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perform CRUD operations on Orders in HubSpot
3. [Search Operation](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/search-operation) - Perform Search operations on Orders in HubSpot

## Build from the source
Expand Down
20 changes: 10 additions & 10 deletions ballerina/Module.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ Within app developer accounts, you can create [developer test account](https://d

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

### Step 3: Create a HubSpot App under your account.
### Step 3: Create a HubSpot App under your account

1. In your developer account, navigate to the "Apps" section. Click on "Create App"

![Hubspot Create App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/create_app_1.png)

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

### Step 4: Configure the Authentication Flow.
### Step 4: Configure the Authentication Flow

1. Move to the Auth Tab. (Second tab next to App Info)

Expand Down Expand Up @@ -83,13 +83,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 the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>` and `<YOUR_SCOPES>` with your specific value.
Replace the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>`, and `<YOUR_SCOPES>` with your specific value.

![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)
![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)

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

4. Run the following curl command. Replace the `<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>`.
3. Run the following curl command. Replace the `<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,7 +120,7 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token
}
```

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

## Quickstart

Expand Down Expand Up @@ -151,7 +151,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
final orders:ConnectionConfig config = {
auth : {
clientId,
Expand All @@ -165,7 +165,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;

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

#### Read an order by ID

Expand All @@ -180,5 +180,5 @@ public function main() returns error? {
The `HubSpot CRM Commerce Orders` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/), covering the following use cases:

1. [Batch Operations](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/batch-operations) - Perform Batch operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perford CRUD operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perform CRUD operations on Orders in HubSpot
3. [Search Operation](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/search-operation) - Perform Search operations on Orders in HubSpot
20 changes: 10 additions & 10 deletions ballerina/Package.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ Within app developer accounts, you can create [developer test account](https://d

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

### Step 3: Create a HubSpot App under your account.
### Step 3: Create a HubSpot App under your account

1. In your developer account, navigate to the "Apps" section. Click on "Create App"

![Hubspot Create App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/create_app_1.png)

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

### Step 4: Configure the Authentication Flow.
### Step 4: Configure the Authentication Flow

1. Move to the Auth Tab. (Second tab next to App Info)

Expand Down Expand Up @@ -83,13 +83,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 the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>` and `<YOUR_SCOPES>` with your specific value.
Replace the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>`, and `<YOUR_SCOPES>` with your specific value.

![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)
![Hubspot Get Auth Code](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/main/docs/setup/resources/install_app.png)

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

4. Run the following curl command. Replace the `<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>`.
3. Run the following curl command. Replace the `<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,7 +120,7 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token
}
```

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

## Quickstart

Expand Down Expand Up @@ -151,7 +151,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
final orders:ConnectionConfig config = {
auth : {
clientId,
Expand All @@ -165,7 +165,7 @@ import ballerinax/hubspot.crm.commerce.orders as orders;

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

#### Read an order by ID

Expand All @@ -180,5 +180,5 @@ public function main() returns error? {
The `HubSpot CRM Commerce Orders` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/), covering the following use cases:

1. [Batch Operations](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/batch-operations) - Perform Batch operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perford CRUD operations on Orders in HubSpot
2. [Order Management](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/order-management) - Perform CRUD operations on Orders in HubSpot
3. [Search Operation](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.commerce.orders/tree/main/examples/search-operation) - Perform Search operations on Orders in HubSpot

0 comments on commit e8e2a3c

Please sign in to comment.