@orchesty/connector-calendly 1.0.1 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Calendly Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-calendly)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Calendly, a simple scheduling tool for businesses that eliminates email back and forth, helping save time and increase sales.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**OAuth 2.0**
|
|
11
|
+
|
|
12
|
+
This connector uses the Calendly OAuth 2.0 authorization flow. After entering your credentials in Orchesty, you will be redirected to Calendly to authorize access.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `client_id` | OAuth application Client ID from the Calendly Developer Portal |
|
|
17
|
+
| `client_secret` | OAuth application Client Secret from the Calendly Developer Portal |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `CalendlyGetUserConnector` | Connector | Retrieves a single Calendly user by UUID via `GET /users/{uuid}` |
|
|
24
|
+
| `CalendlyInviteUserConnector` | Connector | Invites a user to an organization via `POST /organizations/{uuid}/invitations` |
|
|
25
|
+
| `CalendlyListEventsBatch` | Batch | Paginates through all scheduled events via `GET /scheduled_events` using cursor-based pagination |
|
|
26
|
+
|
|
27
|
+
## Setup
|
|
28
|
+
|
|
29
|
+
### Credentials
|
|
30
|
+
|
|
31
|
+
1. Log in to the [Calendly Developer Portal](https://developer.calendly.com).
|
|
32
|
+
2. Create a new OAuth application.
|
|
33
|
+
3. Note the **Client ID** and **Client Secret**.
|
|
34
|
+
4. Set the **Redirect URI** to the OAuth callback URL provided by Orchesty.
|
|
35
|
+
5. In Orchesty, open the Calendly application settings and fill in:
|
|
36
|
+
- **Client Id** — paste your Client ID
|
|
37
|
+
- **Client Secret** — paste your Client Secret
|
|
38
|
+
6. Complete the OAuth authorization flow by clicking **Authorize** in Orchesty.
|
|
39
|
+
|
|
40
|
+
### API Documentation
|
|
41
|
+
|
|
42
|
+
Calendly API Reference: [https://developer.calendly.com/api-docs](https://developer.calendly.com/api-docs)
|
|
43
|
+
|
|
44
|
+
## Installation & Usage
|
|
45
|
+
|
|
46
|
+
Install the package:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npm install @orchesty/connector-calendly @orchesty/nodejs-sdk
|
|
50
|
+
# or
|
|
51
|
+
pnpm add @orchesty/connector-calendly @orchesty/nodejs-sdk
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Register the application and nodes in your Orchesty DI container:
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
58
|
+
import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
|
|
59
|
+
import CalendlyApplication from '@orchesty/connector-calendly/dist/CalendlyApplication';
|
|
60
|
+
import CalendlyGetUserConnector from '@orchesty/connector-calendly/dist/Connector/CalendlyGetUserConnector';
|
|
61
|
+
import CalendlyInviteUserConnector from '@orchesty/connector-calendly/dist/Connector/CalendlyInviteUserConnector';
|
|
62
|
+
import CalendlyListEventsBatch from '@orchesty/connector-calendly/dist/Batch/CalendlyListEventsBatch';
|
|
63
|
+
|
|
64
|
+
const app = new CalendlyApplication(container.get(OAuth2Provider));
|
|
65
|
+
container.setApplication(app);
|
|
66
|
+
container.setNode(new CalendlyGetUserConnector(), app);
|
|
67
|
+
container.setNode(new CalendlyInviteUserConnector(), app);
|
|
68
|
+
container.setNode(new CalendlyListEventsBatch(), app);
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
74
|
+
|
|
75
|
+
## Contributing
|
|
76
|
+
|
|
77
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
78
|
+
|
|
79
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
80
|
+
|
|
81
|
+
All contributions should include:
|
|
82
|
+
- Source code in `src/` following the existing connector structure
|
|
83
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
84
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-calendly",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-calendly",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
15
18
|
},
|
|
16
19
|
"engines": {
|
|
17
20
|
"node": ">=24"
|