@matimo/hubspot 0.1.0-alpha.9

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.
Files changed (54) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +389 -0
  3. package/definition.yaml +73 -0
  4. package/package.json +17 -0
  5. package/tools/hubspot-create-company/definition.yaml +57 -0
  6. package/tools/hubspot-create-contact/definition.yaml +79 -0
  7. package/tools/hubspot-create-custom-object/definition.yaml +57 -0
  8. package/tools/hubspot-create-deal/definition.yaml +69 -0
  9. package/tools/hubspot-create-invoice/definition.yaml +47 -0
  10. package/tools/hubspot-create-lead/definition.yaml +73 -0
  11. package/tools/hubspot-create-line-item/definition.yaml +64 -0
  12. package/tools/hubspot-create-order/definition.yaml +63 -0
  13. package/tools/hubspot-create-product/definition.yaml +58 -0
  14. package/tools/hubspot-create-ticket/definition.yaml +64 -0
  15. package/tools/hubspot-delete-company/definition.yaml +43 -0
  16. package/tools/hubspot-delete-contact/definition.yaml +43 -0
  17. package/tools/hubspot-delete-custom-object/definition.yaml +43 -0
  18. package/tools/hubspot-delete-deal/definition.yaml +43 -0
  19. package/tools/hubspot-delete-invoice/definition.yaml +38 -0
  20. package/tools/hubspot-delete-lead/definition.yaml +38 -0
  21. package/tools/hubspot-delete-line-item/definition.yaml +38 -0
  22. package/tools/hubspot-delete-order/definition.yaml +38 -0
  23. package/tools/hubspot-delete-product/definition.yaml +38 -0
  24. package/tools/hubspot-delete-ticket/definition.yaml +43 -0
  25. package/tools/hubspot-get-company/definition.yaml +49 -0
  26. package/tools/hubspot-get-contact/definition.yaml +56 -0
  27. package/tools/hubspot-get-custom-object/definition.yaml +54 -0
  28. package/tools/hubspot-get-deal/definition.yaml +42 -0
  29. package/tools/hubspot-get-invoice/definition.yaml +49 -0
  30. package/tools/hubspot-get-lead/definition.yaml +55 -0
  31. package/tools/hubspot-get-line-item/definition.yaml +49 -0
  32. package/tools/hubspot-get-order/definition.yaml +49 -0
  33. package/tools/hubspot-get-product/definition.yaml +49 -0
  34. package/tools/hubspot-get-ticket/definition.yaml +42 -0
  35. package/tools/hubspot-list-companies/definition.yaml +49 -0
  36. package/tools/hubspot-list-contacts/definition.yaml +59 -0
  37. package/tools/hubspot-list-custom-objects/definition.yaml +60 -0
  38. package/tools/hubspot-list-deals/definition.yaml +49 -0
  39. package/tools/hubspot-list-invoices/definition.yaml +55 -0
  40. package/tools/hubspot-list-leads/definition.yaml +61 -0
  41. package/tools/hubspot-list-line-items/definition.yaml +55 -0
  42. package/tools/hubspot-list-orders/definition.yaml +55 -0
  43. package/tools/hubspot-list-products/definition.yaml +55 -0
  44. package/tools/hubspot-list-tickets/definition.yaml +49 -0
  45. package/tools/hubspot-update-company/definition.yaml +54 -0
  46. package/tools/hubspot-update-contact/definition.yaml +62 -0
  47. package/tools/hubspot-update-custom-object/definition.yaml +57 -0
  48. package/tools/hubspot-update-deal/definition.yaml +54 -0
  49. package/tools/hubspot-update-invoice/definition.yaml +52 -0
  50. package/tools/hubspot-update-lead/definition.yaml +55 -0
  51. package/tools/hubspot-update-line-item/definition.yaml +52 -0
  52. package/tools/hubspot-update-order/definition.yaml +52 -0
  53. package/tools/hubspot-update-product/definition.yaml +52 -0
  54. package/tools/hubspot-update-ticket/definition.yaml +54 -0
@@ -0,0 +1,38 @@
1
+ name: hubspot-delete-line-item
2
+ version: '1.0.0'
3
+ description: Delete a line item from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot line item ID.
10
+
11
+ execution:
12
+ type: http
13
+ method: DELETE
14
+ url: 'https://api.hubapi.com/crm/v3/objects/line_items/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+
24
+ output_schema:
25
+ type: object
26
+
27
+ error_handling:
28
+ retry: 2
29
+ backoff_type: exponential
30
+ initial_delay_ms: 500
31
+
32
+ requires_approval: true
33
+
34
+ examples:
35
+ - name: Delete a line item
36
+ params:
37
+ id: "12345"
38
+ expected_result: Line item deleted
@@ -0,0 +1,38 @@
1
+ name: hubspot-delete-order
2
+ version: '1.0.0'
3
+ description: Delete an order from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot order ID.
10
+
11
+ execution:
12
+ type: http
13
+ method: DELETE
14
+ url: 'https://api.hubapi.com/crm/v3/objects/orders/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+
24
+ output_schema:
25
+ type: object
26
+
27
+ error_handling:
28
+ retry: 2
29
+ backoff_type: exponential
30
+ initial_delay_ms: 500
31
+
32
+ requires_approval: true
33
+
34
+ examples:
35
+ - name: Delete an order
36
+ params:
37
+ id: "12345"
38
+ expected_result: Order deleted
@@ -0,0 +1,38 @@
1
+ name: hubspot-delete-product
2
+ version: '1.0.0'
3
+ description: Delete a product from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot product ID.
10
+
11
+ execution:
12
+ type: http
13
+ method: DELETE
14
+ url: 'https://api.hubapi.com/crm/v3/objects/products/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+
24
+ output_schema:
25
+ type: object
26
+
27
+ error_handling:
28
+ retry: 2
29
+ backoff_type: exponential
30
+ initial_delay_ms: 500
31
+
32
+ requires_approval: true
33
+
34
+ examples:
35
+ - name: Delete a product
36
+ params:
37
+ id: "12345"
38
+ expected_result: Product deleted
@@ -0,0 +1,43 @@
1
+ name: hubspot-delete-ticket
2
+ version: '1.0.0'
3
+ description: Delete a ticket from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot ticket ID to delete.
10
+
11
+ execution:
12
+ type: http
13
+ method: DELETE
14
+ url: 'https://api.hubapi.com/crm/v3/objects/tickets/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+ notes:
24
+ env: MATIMO_HUBSPOT_API_KEY
25
+
26
+ requires_approval: true
27
+
28
+ output_schema:
29
+ type: object
30
+ properties:
31
+ status: { type: string }
32
+ required: [status]
33
+
34
+ error_handling:
35
+ retry: 2
36
+ backoff_type: exponential
37
+ initial_delay_ms: 500
38
+
39
+ examples:
40
+ - name: 'Delete ticket by ID'
41
+ params:
42
+ id: '999'
43
+ expected_result: 'Ticket successfully deleted.'
@@ -0,0 +1,49 @@
1
+ name: hubspot-get-company
2
+ version: '1.0.0'
3
+ description: Retrieve a specific company by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot company ID to retrieve.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Specific properties to return (e.g., name, domain, industry).
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/companies/{id}'
19
+ query_params:
20
+ properties: '{properties}'
21
+ headers:
22
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+ notes:
30
+ env: MATIMO_HUBSPOT_API_KEY
31
+
32
+ output_schema:
33
+ type: object
34
+ properties:
35
+ id: { type: string }
36
+ properties: { type: object }
37
+ createdAt: { type: string }
38
+ required: [id, properties]
39
+
40
+ error_handling:
41
+ retry: 2
42
+ backoff_type: exponential
43
+ initial_delay_ms: 500
44
+
45
+ examples:
46
+ - name: 'Get company by ID'
47
+ params:
48
+ id: '456'
49
+ expected_result: 'Company object with all properties.'
@@ -0,0 +1,56 @@
1
+ name: hubspot-get-contact
2
+ version: '1.0.0'
3
+ description: Retrieve a specific contact by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot contact ID to retrieve.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Specific properties to return (e.g., firstname, lastname, email). If not specified, all properties are returned.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/contacts/{id}'
19
+ query_params:
20
+ properties: '{properties}'
21
+ headers:
22
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+ notes:
30
+ env: MATIMO_HUBSPOT_API_KEY
31
+
32
+ output_schema:
33
+ type: object
34
+ properties:
35
+ id: { type: string }
36
+ properties: { type: object }
37
+ createdAt: { type: string }
38
+ updatedAt: { type: string }
39
+ archived: { type: boolean }
40
+ required: [id, properties]
41
+
42
+ error_handling:
43
+ retry: 2
44
+ backoff_type: exponential
45
+ initial_delay_ms: 500
46
+
47
+ examples:
48
+ - name: 'Get contact by ID'
49
+ params:
50
+ id: '123'
51
+ expected_result: 'Contact object with all properties.'
52
+ - name: 'Get specific properties'
53
+ params:
54
+ id: '123'
55
+ properties: ['firstname', 'lastname', 'email']
56
+ expected_result: 'Contact with only specified properties.'
@@ -0,0 +1,54 @@
1
+ name: hubspot-get-custom-object
2
+ version: '1.0.0'
3
+ description: Retrieve a specific custom object by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ object_type:
7
+ type: string
8
+ required: true
9
+ description: The custom object type ID (e.g., 'my_custom_object').
10
+ id:
11
+ type: string
12
+ required: true
13
+ description: The custom object ID.
14
+ properties:
15
+ type: array
16
+ required: false
17
+ description: Array of property names to retrieve.
18
+
19
+ execution:
20
+ type: http
21
+ method: GET
22
+ url: 'https://api.hubapi.com/crm/v3/objects/{object_type}/{id}'
23
+ headers:
24
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
25
+ query_params:
26
+ properties: '{properties}'
27
+ timeout: 30000
28
+
29
+ authentication:
30
+ type: bearer
31
+ location: header
32
+ name: Authorization
33
+
34
+ output_schema:
35
+ type: object
36
+ properties:
37
+ id:
38
+ type: string
39
+ properties:
40
+ type: object
41
+
42
+ error_handling:
43
+ retry: 2
44
+ backoff_type: exponential
45
+ initial_delay_ms: 500
46
+
47
+ requires_approval: false
48
+
49
+ examples:
50
+ - name: Get a custom object
51
+ params:
52
+ object_type: my_custom_object
53
+ id: "12345"
54
+ expected_result: Custom object with ID 12345
@@ -0,0 +1,42 @@
1
+ name: hubspot-get-deal
2
+ version: '1.0.0'
3
+ description: Retrieve a specific deal by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot deal ID to retrieve.
10
+
11
+ execution:
12
+ type: http
13
+ method: GET
14
+ url: 'https://api.hubapi.com/crm/v3/objects/deals/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+ notes:
24
+ env: MATIMO_HUBSPOT_API_KEY
25
+
26
+ output_schema:
27
+ type: object
28
+ properties:
29
+ id: { type: string }
30
+ properties: { type: object }
31
+ required: [id, properties]
32
+
33
+ error_handling:
34
+ retry: 2
35
+ backoff_type: exponential
36
+ initial_delay_ms: 500
37
+
38
+ examples:
39
+ - name: 'Get deal by ID'
40
+ params:
41
+ id: '789'
42
+ expected_result: 'Deal object with all properties.'
@@ -0,0 +1,49 @@
1
+ name: hubspot-get-invoice
2
+ version: '1.0.0'
3
+ description: Retrieve a specific invoice by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot invoice ID.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Array of property names to retrieve.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/invoices/{id}'
19
+ headers:
20
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
21
+ query_params:
22
+ properties: '{properties}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+
30
+ output_schema:
31
+ type: object
32
+ properties:
33
+ id:
34
+ type: string
35
+ properties:
36
+ type: object
37
+
38
+ error_handling:
39
+ retry: 2
40
+ backoff_type: exponential
41
+ initial_delay_ms: 500
42
+
43
+ requires_approval: false
44
+
45
+ examples:
46
+ - name: Get an invoice
47
+ params:
48
+ id: "12345"
49
+ expected_result: Invoice with ID 12345
@@ -0,0 +1,55 @@
1
+ name: hubspot-get-lead
2
+ version: '1.0.0'
3
+ description: Retrieve a specific lead by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot lead ID to retrieve.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Array of property names to retrieve (e.g., ['email', 'firstname', 'lastname']).
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/leads/{id}'
19
+ headers:
20
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
21
+ query_params:
22
+ properties: '{properties}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+
30
+ output_schema:
31
+ type: object
32
+ properties:
33
+ id:
34
+ type: string
35
+ properties:
36
+ type: object
37
+ required:
38
+ - id
39
+
40
+ error_handling:
41
+ retry: 2
42
+ backoff_type: exponential
43
+ initial_delay_ms: 500
44
+
45
+ requires_approval: false
46
+
47
+ examples:
48
+ - name: Get a lead by ID
49
+ params:
50
+ id: "12345"
51
+ properties:
52
+ - email
53
+ - firstname
54
+ - lastname
55
+ expected_result: Lead object with ID 12345 and specified properties
@@ -0,0 +1,49 @@
1
+ name: hubspot-get-line-item
2
+ version: '1.0.0'
3
+ description: Retrieve a specific line item by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot line item ID.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Array of property names to retrieve.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/line_items/{id}'
19
+ headers:
20
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
21
+ query_params:
22
+ properties: '{properties}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+
30
+ output_schema:
31
+ type: object
32
+ properties:
33
+ id:
34
+ type: string
35
+ properties:
36
+ type: object
37
+
38
+ error_handling:
39
+ retry: 2
40
+ backoff_type: exponential
41
+ initial_delay_ms: 500
42
+
43
+ requires_approval: false
44
+
45
+ examples:
46
+ - name: Get a line item
47
+ params:
48
+ id: "12345"
49
+ expected_result: Line item with ID 12345
@@ -0,0 +1,49 @@
1
+ name: hubspot-get-order
2
+ version: '1.0.0'
3
+ description: Retrieve a specific order by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot order ID.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Array of property names to retrieve.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/orders/{id}'
19
+ headers:
20
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
21
+ query_params:
22
+ properties: '{properties}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+
30
+ output_schema:
31
+ type: object
32
+ properties:
33
+ id:
34
+ type: string
35
+ properties:
36
+ type: object
37
+
38
+ error_handling:
39
+ retry: 2
40
+ backoff_type: exponential
41
+ initial_delay_ms: 500
42
+
43
+ requires_approval: false
44
+
45
+ examples:
46
+ - name: Get an order
47
+ params:
48
+ id: "12345"
49
+ expected_result: Order with ID 12345
@@ -0,0 +1,49 @@
1
+ name: hubspot-get-product
2
+ version: '1.0.0'
3
+ description: Retrieve a specific product by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot product ID.
10
+ properties:
11
+ type: array
12
+ required: false
13
+ description: Array of property names to retrieve.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/products/{id}'
19
+ headers:
20
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
21
+ query_params:
22
+ properties: '{properties}'
23
+ timeout: 30000
24
+
25
+ authentication:
26
+ type: bearer
27
+ location: header
28
+ name: Authorization
29
+
30
+ output_schema:
31
+ type: object
32
+ properties:
33
+ id:
34
+ type: string
35
+ properties:
36
+ type: object
37
+
38
+ error_handling:
39
+ retry: 2
40
+ backoff_type: exponential
41
+ initial_delay_ms: 500
42
+
43
+ requires_approval: false
44
+
45
+ examples:
46
+ - name: Get a product
47
+ params:
48
+ id: "12345"
49
+ expected_result: Product with ID 12345
@@ -0,0 +1,42 @@
1
+ name: hubspot-get-ticket
2
+ version: '1.0.0'
3
+ description: Retrieve a specific ticket by ID from HubSpot CRM.
4
+
5
+ parameters:
6
+ id:
7
+ type: string
8
+ required: true
9
+ description: The HubSpot ticket ID to retrieve.
10
+
11
+ execution:
12
+ type: http
13
+ method: GET
14
+ url: 'https://api.hubapi.com/crm/v3/objects/tickets/{id}'
15
+ headers:
16
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
17
+ timeout: 30000
18
+
19
+ authentication:
20
+ type: bearer
21
+ location: header
22
+ name: Authorization
23
+ notes:
24
+ env: MATIMO_HUBSPOT_API_KEY
25
+
26
+ output_schema:
27
+ type: object
28
+ properties:
29
+ id: { type: string }
30
+ properties: { type: object }
31
+ required: [id, properties]
32
+
33
+ error_handling:
34
+ retry: 2
35
+ backoff_type: exponential
36
+ initial_delay_ms: 500
37
+
38
+ examples:
39
+ - name: 'Get ticket by ID'
40
+ params:
41
+ id: '999'
42
+ expected_result: 'Ticket object with all properties.'
@@ -0,0 +1,49 @@
1
+ name: hubspot-list-companies
2
+ version: '1.0.0'
3
+ description: List all companies from HubSpot CRM with pagination.
4
+
5
+ parameters:
6
+ limit:
7
+ type: number
8
+ required: false
9
+ description: Maximum number of companies to return (default 10, max 100).
10
+ after:
11
+ type: string
12
+ required: false
13
+ description: Pagination cursor to get next batch of companies.
14
+
15
+ execution:
16
+ type: http
17
+ method: GET
18
+ url: 'https://api.hubapi.com/crm/v3/objects/companies'
19
+ query_params:
20
+ limit: '{limit}'
21
+ after: '{after}'
22
+ headers:
23
+ Authorization: 'Bearer {MATIMO_HUBSPOT_API_KEY}'
24
+ timeout: 30000
25
+
26
+ authentication:
27
+ type: bearer
28
+ location: header
29
+ name: Authorization
30
+ notes:
31
+ env: MATIMO_HUBSPOT_API_KEY
32
+
33
+ output_schema:
34
+ type: object
35
+ properties:
36
+ results: { type: array }
37
+ paging: { type: object }
38
+ required: [results]
39
+
40
+ error_handling:
41
+ retry: 2
42
+ backoff_type: exponential
43
+ initial_delay_ms: 500
44
+
45
+ examples:
46
+ - name: 'List first 10 companies'
47
+ params:
48
+ limit: 10
49
+ expected_result: 'Array of 10 companies.'