Skip to content

Commit 169dff9

Browse files
byrrobyrro
authored
Fix dict args in Hubspot Events Api tools (#17)
Six tools had to be removed because our current strategies to handle complex object arguments aren't sufficient. It is technically possible to support those (uncommon) cases, but it will require non-trivial refactoring in Moar complex-objects handling logic. Decided to leave this for a future Moar enhancement.
1 parent 9a3d447 commit 169dff9

File tree

9 files changed

+46
-2711
lines changed

9 files changed

+46
-2711
lines changed

‎servers/hubspot_events_api/arcade_hubspot_events_api/moar/Hubspot_Events.json‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -29,108 +29,108 @@
2929
"wrapper_tool": {
3030
"name": "retrieve_event_completions",
3131
"description": {
32-
"tagline": "Retrieve instances of event completion data.",
33-
"detailed": "Use this tool to retrieve all event completions associated with a specific contact. Ideal for tracking event participation and analyzing engagement."
32+
"tagline": "Retrieve instances of event completion data for contacts.",
33+
"detailed": "Use this tool to obtain all event completions associated with a specific contact. Ideal for tracking event interactions or analyzing contact engagement."
3434
},
35-
"return_annotation": "Event completion data for contacts.",
35+
"return_annotation": "Instances of event completion data.",
3636
"arguments": [
3737
{
3838
"name": "crm_object_type",
3939
"alternative_names": [
40-
"crm_type",
41-
"object_filter_type"
40+
"object_type_filter",
41+
"crm_entity_type"
4242
],
43-
"description": "Specify the CRM object type to filter event instances (e.g., `contact`).",
43+
"description": "The CRM object type to filter event instances (e.g., 'contact'). Specify when retrieving data for a CRM record. Include 'object_id' if needed.",
4444
"endpoint_argument_name": "objectType"
4545
},
4646
{
4747
"name": "event_type_name",
4848
"alternative_names": [
49-
"event_name",
50-
"event_category"
49+
"event_name_type",
50+
"event_category_name"
5151
],
52-
"description": "The specific name of the event type to retrieve data for. Available event types can be found using the event types endpoint.",
52+
"description": "Specify the name of the event type to filter event completion instances.",
5353
"endpoint_argument_name": "eventType"
5454
},
5555
{
56-
"name": "paging_cursor_token",
56+
"name": "paging_cursor_after_token",
5757
"alternative_names": [
58-
"next_page_token",
59-
"continuation_token"
58+
"cursor_after",
59+
"after_token"
6060
],
61-
"description": "The token for the next page of results, returned as `paging.next.after` in the previous response.",
61+
"description": "The paging cursor token from the last read resource for paginated results.",
6262
"endpoint_argument_name": "after"
6363
},
6464
{
65-
"name": "paging_before_token",
65+
"name": "paging_before_cursor",
6666
"alternative_names": [
67-
"cursor_before",
68-
"previous_page_token"
67+
"paging_cursor_before",
68+
"cursor_before_paging"
6969
],
70-
"description": "The cursor token to fetch results occurring before this point when paginating results.",
70+
"description": "The cursor token for paginating backwards. Use this if you want to navigate to results displayed before the current page.",
7171
"endpoint_argument_name": "before"
7272
},
7373
{
74-
"name": "max_results_per_page",
74+
"name": "maximum_results_per_page",
7575
"alternative_names": [
76-
"results_per_page_limit",
76+
"results_limit",
7777
"page_size"
7878
],
79-
"description": "The maximum number of results to display per page.",
79+
"description": "The maximum number of results to display per page. Set this to control pagination.",
8080
"endpoint_argument_name": "limit"
8181
},
8282
{
83-
"name": "sort_direction",
83+
"name": "sort_by_timestamp_direction",
8484
"alternative_names": [
85-
"order_by_timestamp",
86-
"timestamp_sort"
85+
"timestamp_sort_order",
86+
"event_order"
8787
],
88-
"description": "Specify the sort direction for event instances based on the timestamp. Use `ASCENDING` or `DESCENDING`.",
88+
"description": "Specifies the sort direction based on the event instance timestamp. Acceptable values are `ASCENDING` or `DESCENDING`.",
8989
"endpoint_argument_name": "sort"
9090
},
9191
{
92-
"name": "filter_occurred_after_datetime",
92+
"name": "filter_after_datetime",
9393
"alternative_names": [
94-
"datetime_filter_after",
95-
"occurred_after"
94+
"after_datetime",
95+
"events_after_date"
9696
],
97-
"description": "Filter for event data occurring after a specific datetime, in ISO 8601 format (e.g., '2023-01-01T00:00:00Z').",
97+
"description": "Filter for event data that occurred after a specific datetime. Use ISO 8601 format (e.g., '2023-01-01T00:00:00Z').",
9898
"endpoint_argument_name": "occurredAfter"
9999
},
100100
{
101-
"name": "filter_events_occurred_before",
101+
"name": "filter_before_datetime",
102102
"alternative_names": [
103-
"event_filter_before_date",
104-
"before_date_filter"
103+
"before_datetime_filter",
104+
"end_datetime_filter"
105105
],
106-
"description": "Filter for events that occurred before a specific datetime. Accepts an ISO 8601 formatted date-time string.",
106+
"description": "Filter to retrieve event data that occurred before a specified datetime. Provide in ISO 8601 format (e.g., '2023-10-05T14:48:00Z').",
107107
"endpoint_argument_name": "occurredBefore"
108108
},
109109
{
110110
"name": "crm_object_id",
111111
"alternative_names": [
112-
"object_id",
113-
"crm_record_id"
112+
"crm_record_id",
113+
"object_id"
114114
],
115-
"description": "The ID of the CRM Object to filter event instances on. Must be used with `object_type`.",
115+
"description": "The ID of the CRM Object to filter event instances. Must be used with 'object_type'.",
116116
"endpoint_argument_name": "objectId"
117117
},
118118
{
119119
"name": "unique_identifier_property",
120120
"alternative_names": [
121-
"contact_email",
122-
"identifier_property"
121+
"identifier_property",
122+
"contact_identifier"
123123
],
124-
"description": "Specify a unique identifier for a CRM object. For contacts, use the email property (e.g., `[email protected]`).",
124+
"description": "Specify a unique identifier to retrieve event data for a CRM object. For contacts, use the `email` property, e.g., `unique_identifier_property.[email protected]`.",
125125
"endpoint_argument_name": "objectProperty.{propname}"
126126
},
127127
{
128128
"name": "event_property_filter",
129129
"alternative_names": [
130-
"event_property_criteria",
131-
"filter_by_event_property"
130+
"event_attribute_value",
131+
"completion_property_value"
132132
],
133-
"description": "Specify a key-value pair to filter event completions by a property (e.g., `hs_city=portland`). Use `%20` or `+` for spaces.",
133+
"description": "Specify a filter for event completions by an event property and its value (e.g., `hs_city=new+york`). Replace spaces with `%20` or `+`.",
134134
"endpoint_argument_name": "property.{propname}"
135135
},
136136
{
@@ -139,7 +139,7 @@
139139
"event_ids",
140140
"instance_ids"
141141
],
142-
"description": "List of event instance IDs. Each ID must uniquely match the event instance, and any additional filters must align with the event instance\u2019s attributes.",
142+
"description": "IDs of event instances to filter. Use an array to specify multiple IDs. Other filters must match the event values for results.",
143143
"endpoint_argument_name": "id"
144144
}
145145
]

0 commit comments

Comments
 (0)