Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in the documentation #8

Merged
merged 2 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,52 +29,52 @@ Within app developer accounts, you can create a [developer test account](https:/

1. Go to Test accounts section from the left sidebar.

![Test Account](docs/resources/testAccount.png)
![Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccount.png)

2. Click on the Create developer test account button on the top right corner.

![Development Test Account](docs/resources/developmentTestAccount.png)
![Development Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/developmentTestAccount.png)

3. In the pop-up window, provide a name for the test account and click on the Create button.

![Create Account](docs/resources/createAccount.png)
![Create Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/createAccount.png)

4. You will see the newly created test account in the list of test accounts.

![Test Account Portal](docs/resources/testAccountPortal.png)
![Test Account Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccountPortal.png)

### Step 3: Create a HubSpot App

1. Navigate to the Apps section from the left sidebar and click on the Create app button on the top right corner.

![App Section](docs/resources/appSection.png)
![App Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/appSection.png)

2. Provide a public app name and description for your app.

![Naming the App](docs/resources/namingApp.png)
![Naming the App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/namingApp.png)

### Step 4: Setup Authentication

1. Move to the Auth tab.

![Auth Section](docs/resources/auth.png)
![Auth Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/auth.png)

2. In the Scopes section, add the following scopes for your app using the Add new scopes button.
- `marketing.campaigns.read`
- `marketing.campaigns.revenue.read`
- `marketing.campaigns.write`

![Marketing Scopes](docs/resources/marketingScopes.png)
![Marketing Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/marketingScopes.png)

3. In the Redirect URL section, add the redirect URL for your app. This is the URL where the user will be redirected after the authentication process. You can use `localhost` for testing purposes. Then click the "Create App" button.

![Redirect URL](docs/resources/redirectURL.png)
![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/redirectURL.png)

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

Navigate to the Auth tab and you will see the `Client ID`, and `Client Secret` for your app. Make sure to save these values.

![Client ID and Client Secret](docs/resources/clientId_secretId.png)
![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/clientId_secretId.png)

### Step 6: Setup Authentication Flow

Expand All @@ -89,7 +89,7 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token

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

![Account Select](docs/resources/accountSelect.png)
![Account Select](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/accountSelect.png)

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

Expand Down Expand Up @@ -184,8 +184,8 @@ public function main() returns error? {

The `HubSpot Marketing Campaigns ` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples), covering the following use cases:

1. [Batch of Campaigns](examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms
1. [Batch of Campaigns](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms

## Build from the source

Expand Down
32 changes: 16 additions & 16 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,59 +15,58 @@ If you have an account already, go to the [HubSpot developer portal](https://dev
If you don't have a HubSpot Developer Account you can sign up to a free account [here](https://developers.hubspot.com/get-started)

### Step 2 (Optional): Create a Developer Test Account

Within app developer accounts, you can create a [developer test account](https://developers.hubspot.com/docs/getting-started/account-types#developer-test-accounts) under your account 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.

1. Go to Test accounts section from the left sidebar.

![Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/testAccount.png)
![Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccount.png)

2. Click on the Create developer test account button on the top right corner.

![Development Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/developmentTestAccount.png)
![Development Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/developmentTestAccount.png)

3. In the pop-up window, provide a name for the test account and click on the Create button.

![Create Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/createAccount.png)
![Create Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/createAccount.png)

4. You will see the newly created test account in the list of test accounts.

![Test Account Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/testAccountPortal.png)
![Test Account Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccountPortal.png)

### Step 3: Create a HubSpot App

1. Navigate to the Apps section from the left sidebar and click on the Create app button on the top right corner.

![App Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/appSection.png)
![App Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/appSection.png)

2. Provide a public app name and description for your app.

![Naming the App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/namingApp.png)
![Naming the App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/namingApp.png)

### Step 4: Setup Authentication

1. Move to the Auth tab.

![Auth Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/auth.png)
![Auth Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/auth.png)

2. In the Scopes section, add the following scopes for your app using the Add new scopes button.
- `marketing.campaigns.read`
- `marketing.campaigns.revenue.read`
- `marketing.campaigns.write`

![Marketing Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/marketingScopes.png)
![Marketing Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/marketingScopes.png)

3. In the Redirect URL section, add the redirect URL for your app. This is the URL where the user will be redirected after the authentication process. You can use `localhost` for testing purposes. Then click the "Create App" button.

![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/redirectURL.png)
![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/redirectURL.png)

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

Navigate to the Auth tab and you will see the `Client ID`, and `Client Secret` for your app. Make sure to save these values.

![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/clientId_secretId.png)
![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/clientId_secretId.png)

### Step 6: Setup Authentication Flow

Expand All @@ -82,7 +81,7 @@ Before proceeding with the Quickstart, ensure you have obtained the Access Token

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

![Account Select](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/blob/fb6603714f9b563b74775579577749ad62726576/docs/resources/accountSelect.png)
![Account Select](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/accountSelect.png)

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

Expand All @@ -95,9 +94,10 @@ Before proceeding with the Quickstart, ensure you have obtained the Access 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
```bash
curl --request POST ^
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>'
Expand Down Expand Up @@ -174,7 +174,7 @@ public function main() returns error? {

## Examples

The `HubSpot Marketing Campaigns` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples), covering the following use cases:
The `HubSpot Marketing Campaigns ` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples), covering the following use cases:

1. [Batch of Campaigns](examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms
1. [Batch of Campaigns](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms
29 changes: 14 additions & 15 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,59 +15,58 @@ If you have an account already, go to the [HubSpot developer portal](https://dev
If you don't have a HubSpot Developer Account you can sign up to a free account [here](https://developers.hubspot.com/get-started)

### Step 2 (Optional): Create a Developer Test Account

Within app developer accounts, you can create a [developer test account](https://developers.hubspot.com/docs/getting-started/account-types#developer-test-accounts) under your account 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.

1. Go to Test accounts section from the left sidebar.

![Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/testAccount.png)
![Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccount.png)

2. Click on the Create developer test account button on the top right corner.

![Development Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/developmentTestAccount.png)
![Development Test Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/developmentTestAccount.png)

3. In the pop-up window, provide a name for the test account and click on the Create button.

![Create Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/createAccount.png)
![Create Account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/createAccount.png)

4. You will see the newly created test account in the list of test accounts.

![Test Account Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/testAccountPortal.png)
![Test Account Portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/testAccountPortal.png)

### Step 3: Create a HubSpot App

1. Navigate to the Apps section from the left sidebar and click on the Create app button on the top right corner.

![App Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/appSection.png)
![App Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/appSection.png)

2. Provide a public app name and description for your app.

![Naming the App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/namingApp.png)
![Naming the App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/namingApp.png)

### Step 4: Setup Authentication

1. Move to the Auth tab.

![Auth Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/auth.png)
![Auth Section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/auth.png)

2. In the Scopes section, add the following scopes for your app using the Add new scopes button.
- `marketing.campaigns.read`
- `marketing.campaigns.revenue.read`
- `marketing.campaigns.write`

![Marketing Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/marketingScopes.png)
![Marketing Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/marketingScopes.png)

3. In the Redirect URL section, add the redirect URL for your app. This is the URL where the user will be redirected after the authentication process. You can use `localhost` for testing purposes. Then click the "Create App" button.

![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/redirectURL.png)
![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/redirectURL.png)

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

Navigate to the Auth tab and you will see the `Client ID`, and `Client Secret` for your app. Make sure to save these values.

![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/clientId_secretId.png)
![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/clientId_secretId.png)

### Step 6: Setup Authentication Flow

Expand All @@ -78,11 +77,11 @@ 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.

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

![Account Select](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/resources/accountSelect.png)
![Account Select](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/main/docs/setup/resources/accountSelect.png)

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

Expand Down Expand Up @@ -177,5 +176,5 @@ public function main() returns error? {

The `HubSpot Marketing Campaigns ` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples), covering the following use cases:

1. [Batch of Campaigns](examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms
1. [Batch of Campaigns](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/batch_of_campaigns) - Fully manage a batch of campaigns
2. [Campaign Lifecycle with Assets](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.campaigns/tree/main/examples/campaign_lifecycle_with_assets) - Full life cycle of a campaign associated with assets such as forms
File renamed without changes
File renamed without changes
File renamed without changes
Loading