leash-integration-hubspot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f1f22f1000519781f257486fe1a1b6198bc443e7f3b61b877876159d564b82f
+  data.tar.gz: 225bb97d657016df47867e326df62cc0932bd15daeec2f831b8cdc3122684f14
+SHA512:
+  metadata.gz: b4c14120669cf8c82a98f08f1e3341f735e69ab3556d58a76ff2733be2c650e2ce5ecbd117d7a3d386060e560c330d36e0a5c98a3e439fcb933eb1d77609b57c
+  data.tar.gz: f737b07c1a85875159d9afa2ab74bede268e9eb93b0c3e3dd9d7a71e5a7dbad4ba87ef0acd09ffdcd1b6e704db5aea0e16db3c0e7c8755702fbea06094aa54e2

data/lib/leash/integration/hubspot.rb

@@ -0,0 +1,360 @@
+# frozen_string_literal: true
+
+# Auto-generated by leash-codegen — do not edit manually
+
+module Leash
+  module Integration
+    class HubspotClient
+      # Create a new HubSpot integration client.
+      #
+      # @param leash [Leash::Client] the Leash SDK client
+      def initialize(leash)
+        @leash = leash
+      end
+
+      # 🎯 Purpose 1. Authenticates and analyzes the current HubSpot access token, providing context about the user's permissions and account details. 🧭 Usage Guidance: 1. This tool must be used before pe...
+      #
+      # @return [Object]
+      def hubspot_get_user_details
+        params = {}
+        @leash.call('hubspot', 'hubspot-get-user-details', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves a paginated list of objects of a specified type from HubSpot. 📦 Returns: 1. Collection of objects with their properties and metadata, plus pagination information. 🧭 Usage...
+      #
+      # @param objecttype [String] The type of HubSpot object to list. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param limit [Integer, nil] The maximum number of results to display per page (max: 500).
+      # @param after [String, nil] The paging cursor token of the last successfully read resource.
+      # @param properties [Array, nil] A list of the properties to be returned in the response.
+      # @param associations [Array, nil] A list of object types to retrieve associated IDs for (e.g., appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users).
+      # @param archived [Boolean, nil] Whether to return only results that have been archived.
+      # @return [Object]
+      def hubspot_list_objects(objecttype, limit: nil, after: nil, properties: nil, associations: nil, archived: nil)
+        params = {
+          'objectType' => objecttype,
+          'limit' => limit,
+          'after' => after,
+          'properties' => properties,
+          'associations' => associations,
+          'archived' => archived
+        }.compact
+        @leash.call('hubspot', 'hubspot-list-objects', params)
+      end
+
+      # 🎯 Purpose: 1. Performs advanced filtered searches across HubSpot object types using complex criteria. 📋 Prerequisites: 1. Use the hubspot-list-objects tool to sample existing objects for the obje...
+      #
+      # @param objecttype [String] The type of HubSpot object to search. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param query [String, nil] Text to search across default searchable properties of the specified object type. Each object type has different searchable properties. For example: contacts (firstname, lastname, email, phone, company), companies (name, website, domain, phone), deals (dealname, pipeline, dealstage, description, dealtype), etc
+      # @param limit [Integer, nil] The maximum number of results to display per page (max: 100).
+      # @param after [String, nil] The paging cursor token of the last successfully read resource.
+      # @param properties [Array, nil] A list of the properties to be returned in the response.
+      # @param sorts [Array, nil] A list of sort criteria to apply to the results.
+      # @param filtergroups [Array, nil] Groups of filters to apply (combined with OR).
+      # @return [Object]
+      def hubspot_search_objects(objecttype, query: nil, limit: nil, after: nil, properties: nil, sorts: nil, filtergroups: nil)
+        params = {
+          'objectType' => objecttype,
+          'query' => query,
+          'limit' => limit,
+          'after' => after,
+          'properties' => properties,
+          'sorts' => sorts,
+          'filterGroups' => filtergroups
+        }.compact
+        @leash.call('hubspot', 'hubspot-search-objects', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Establishes relationships between...
+      #
+      # @param fromobjecttype [String] The type of HubSpot object to create association from. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param toobjecttype [String] The type of HubSpot object to create association to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param types [Array] The types of associations to create
+      # @param inputs [Array] List of association inputs defining the relationships to create. (max 100 associations per batch)
+      # @return [Object]
+      def hubspot_batch_create_associations(fromobjecttype, toobjecttype, types, inputs)
+        params = {
+          'fromObjectType' => fromobjecttype,
+          'toObjectType' => toobjecttype,
+          'types' => types,
+          'inputs' => inputs
+        }.compact
+        @leash.call('hubspot', 'hubspot-batch-create-associations', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves valid association types between specific HubSpot object types. 📦 Returns: 1. Array of valid association definitions with type IDs, labels, and categories. 🧭 Usage Guidanc...
+      #
+      # @param fromobjecttype [String] The type of HubSpot object to get association from. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param toobjecttype [String] The type of HubSpot object to get association to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @return [Object]
+      def hubspot_get_association_definitions(fromobjecttype, toobjecttype)
+        params = {
+          'fromObjectType' => fromobjecttype,
+          'toObjectType' => toobjecttype
+        }.compact
+        @leash.call('hubspot', 'hubspot-get-association-definitions', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves existing relationships between a specific object and other objects of a particular type. 2. For example, you can find all companies that a contact is associated with, all d...
+      #
+      # @param objecttype [String] The type of HubSpot object to get associations from. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param objectid [String] The ID of the HubSpot object to get associations from
+      # @param toobjecttype [String] The type of HubSpot object to get associations to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param after [String, nil] Paging cursor token for retrieving the next page of results
+      # @return [Object]
+      def hubspot_list_associations(objecttype, objectid, toobjecttype, after: nil)
+        params = {
+          'objectType' => objecttype,
+          'objectId' => objectid,
+          'toObjectType' => toobjecttype,
+          'after' => after
+        }.compact
+        @leash.call('hubspot', 'hubspot-list-associations', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Creates multiple HubSpot objects o...
+      #
+      # @param objecttype [String] The type of HubSpot object to create. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param inputs [Array] Array of objects to create (maximum 100 per batch)
+      # @return [Object]
+      def hubspot_batch_create_objects(objecttype, inputs)
+        params = {
+          'objectType' => objecttype,
+          'inputs' => inputs
+        }.compact
+        @leash.call('hubspot', 'hubspot-batch-create-objects', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Updates multiple existing HubSpot...
+      #
+      # @param objecttype [String] The type of HubSpot object to update. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param inputs [Array] Array of objects to update (maximum 100 per batch)
+      # @return [Object]
+      def hubspot_batch_update_objects(objecttype, inputs)
+        params = {
+          'objectType' => objecttype,
+          'inputs' => inputs
+        }.compact
+        @leash.call('hubspot', 'hubspot-batch-update-objects', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves multiple HubSpot objects of the same object type by their IDs in a single batch operation. 🧭 Usage Guidance: 1. Use this tool to retrieve objects when the object IDs are k...
+      #
+      # @param objecttype [String] The type of HubSpot object to read. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param inputs [Array] Array of object IDs to read (maximum 100 per batch)
+      # @param properties [Array, nil] Optional list of property names to include in the results
+      # @param propertieswithhistory [Array, nil] Optional list of property names to include with history
+      # @return [Object]
+      def hubspot_batch_read_objects(objecttype, inputs, properties: nil, propertieswithhistory: nil)
+        params = {
+          'objectType' => objecttype,
+          'inputs' => inputs,
+          'properties' => properties,
+          'propertiesWithHistory' => propertieswithhistory
+        }.compact
+        @leash.call('hubspot', 'hubspot-batch-read-objects', params)
+      end
+
+      # 🎯 Purpose: 1. This tool retrieves a complete catalog of properties for any HubSpot object type. 🧭 Usage Guidance: 1. This API has a large response that can consume a lot of tokens. Use the hubspo...
+      #
+      # @param objecttype [String] The type of HubSpot object to get properties for. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param archived [Boolean, nil] Whether to return only properties that have been archived.
+      # @param includehidden [Boolean, nil] Whether to include hidden properties in the response.
+      # @return [Object]
+      def hubspot_list_properties(objecttype, archived: nil, includehidden: nil)
+        params = {
+          'objectType' => objecttype,
+          'archived' => archived,
+          'includeHidden' => includehidden
+        }.compact
+        @leash.call('hubspot', 'hubspot-list-properties', params)
+      end
+
+      # 🎯 Purpose: 1. This tool retrieves detailed information about a specific property for a HubSpot object type. 2. You can use this to get all metadata related to a property, including its type, optio...
+      #
+      # @param objecttype [String] The type of HubSpot object the property belongs to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param propertyname [String] The name of the property to retrieve
+      # @return [Object]
+      def hubspot_get_property(objecttype, propertyname)
+        params = {
+          'objectType' => objecttype,
+          'propertyName' => propertyname
+        }.compact
+        @leash.call('hubspot', 'hubspot-get-property', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Creates new custom properties for...
+      #
+      # @param objecttype [String] The type of HubSpot object to create the property for. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param name [String] The internal property name, which must be used when referencing the property via the API
+      # @param label [String] A human-readable property label that will be shown in HubSpot
+      # @param description [String, nil] A description of the property that will be shown as help text
+      # @param groupname [String] The name of the property group the property belongs to
+      # @param type [String, nil] The data type of the property
+      # @param fieldtype [String, nil] Controls how the property appears in HubSpot
+      # @param options [Array, nil] A list of valid options for enumeration properties
+      # @param formfield [Boolean, nil] Whether the property can be used in forms
+      # @param hidden [Boolean, nil] Whether the property should be hidden in HubSpot
+      # @param displayorder [Integer, nil] The order for displaying the property (lower numbers displayed first)
+      # @param hasuniquevalue [Boolean, nil] Whether the property's value must be unique
+      # @param calculationformula [String, nil] A formula that is used to compute a calculated property
+      # @param externaloptions [Boolean, nil] Only for enumeration type properties. Should be set to true in conjunction with a referencedObjectType
+      # @return [Object]
+      def hubspot_create_property(objecttype, name, label, groupname, description: nil, type: nil, fieldtype: nil, options: nil, formfield: nil, hidden: nil, displayorder: nil, hasuniquevalue: nil, calculationformula: nil, externaloptions: nil)
+        params = {
+          'objectType' => objecttype,
+          'name' => name,
+          'label' => label,
+          'description' => description,
+          'groupName' => groupname,
+          'type' => type,
+          'fieldType' => fieldtype,
+          'options' => options,
+          'formField' => formfield,
+          'hidden' => hidden,
+          'displayOrder' => displayorder,
+          'hasUniqueValue' => hasuniquevalue,
+          'calculationFormula' => calculationformula,
+          'externalOptions' => externaloptions
+        }.compact
+        @leash.call('hubspot', 'hubspot-create-property', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Updates existing custom properties...
+      #
+      # @param objecttype [String] The type of HubSpot object the property belongs to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType.
+      # @param propertyname [String] The name of the property to update
+      # @param label [String, nil] A human-readable property label that will be shown in HubSpot
+      # @param description [String, nil] A description of the property that will be shown as help text
+      # @param groupname [String, nil] The name of the property group the property belongs to
+      # @param type [String, nil] The data type of the property
+      # @param fieldtype [String, nil] Controls how the property appears in HubSpot
+      # @param options [Array, nil] A list of valid options for enumeration properties
+      # @param formfield [Boolean, nil] Whether the property can be used in forms
+      # @param hidden [Boolean, nil] Whether the property should be hidden in HubSpot
+      # @param displayorder [Integer, nil] The order for displaying the property (lower numbers displayed first)
+      # @param calculationformula [String, nil] A formula that is used to compute a calculated property
+      # @return [Object]
+      def hubspot_update_property(objecttype, propertyname, label: nil, description: nil, groupname: nil, type: nil, fieldtype: nil, options: nil, formfield: nil, hidden: nil, displayorder: nil, calculationformula: nil)
+        params = {
+          'objectType' => objecttype,
+          'propertyName' => propertyname,
+          'label' => label,
+          'description' => description,
+          'groupName' => groupname,
+          'type' => type,
+          'fieldType' => fieldtype,
+          'options' => options,
+          'formField' => formfield,
+          'hidden' => hidden,
+          'displayOrder' => displayorder,
+          'calculationFormula' => calculationformula
+        }.compact
+        @leash.call('hubspot', 'hubspot-update-property', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Creates a HubSpot engagement (Note...
+      #
+      # @param type [String] The type of engagement to create (NOTE or TASK)
+      # @param ownerid [Integer] The ID of the owner of this engagement
+      # @param timestamp [Integer, nil] Timestamp for the engagement (milliseconds since epoch). Defaults to current time if not provided.
+      # @param associations [Hash] Associated records for this engagement
+      # @param metadata [Hash] Metadata specific to the engagement type
+      # @return [Object]
+      def hubspot_create_engagement(type, ownerid, associations, metadata, timestamp: nil)
+        params = {
+          'type' => type,
+          'ownerId' => ownerid,
+          'timestamp' => timestamp,
+          'associations' => associations,
+          'metadata' => metadata
+        }.compact
+        @leash.call('hubspot', 'hubspot-create-engagement', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves a HubSpot engagement by ID.
+      #
+      # @param engagementid [Integer] The ID of the engagement to retrieve
+      # @return [Object]
+      def hubspot_get_engagement(engagementid)
+        params = {
+          'engagementId' => engagementid
+        }.compact
+        @leash.call('hubspot', 'hubspot-get-engagement', params)
+      end
+
+      # 🛡️ Guardrails: 1. Data Modification Warning: This tool modifies HubSpot data. Only use when the user has explicitly requested to update their CRM. 🎯 Purpose: 1. Updates an existing HubSpot engage...
+      #
+      # @param engagementid [Integer] The ID of the engagement to update
+      # @param ownerid [Integer, nil] The ID of the owner of this engagement
+      # @param timestamp [Integer, nil] Timestamp for the engagement (milliseconds since epoch).
+      # @param metadata [Hash] Metadata specific to the engagement type (Note or Task)
+      # @param associations [Hash] Associated records for this engagement
+      # @return [Object]
+      def hubspot_update_engagement(engagementid, metadata, associations, ownerid: nil, timestamp: nil)
+        params = {
+          'engagementId' => engagementid,
+          'ownerId' => ownerid,
+          'timestamp' => timestamp,
+          'metadata' => metadata,
+          'associations' => associations
+        }.compact
+        @leash.call('hubspot', 'hubspot-update-engagement', params)
+      end
+
+      # 🎯 Purpose: 1. Use this tool when the user wants to submit feedback about HubSpot MCP tool. 2. Use this tool proactively when the other HubSpot MCP tools are unable to solve the user's tasks effect...
+      #
+      # @return [Object]
+      def hubspot_generate_feedback_link
+        params = {}
+        @leash.call('hubspot', 'hubspot-generate-feedback-link', params)
+      end
+
+      # 🎯 Purpose: 1. Retrieves all custom object schemas defined in the HubSpot account. 🧭 Usage Guidance: 1. Before working with custom objects to understand available object types, their properties, a...
+      #
+      # @return [Object]
+      def hubspot_get_schemas
+        params = {}
+        @leash.call('hubspot', 'hubspot-get-schemas', params)
+      end
+
+      # 🎯 Purpose: 1. Generates HubSpot UI links for different pages based on object types and IDs. 2. Supports both index pages (lists of objects) and record pages (specific object details). 📋 Prerequis...
+      #
+      # @param portalid [String] The HubSpot portal/account ID
+      # @param uidomain [String] The HubSpot UI domain(e.g., 'app.hubspot.com')
+      # @param pagerequests [Array] Array of page link requests to generate
+      # @return [Object]
+      def hubspot_get_link(portalid, uidomain, pagerequests)
+        params = {
+          'portalId' => portalid,
+          'uiDomain' => uidomain,
+          'pageRequests' => pagerequests
+        }.compact
+        @leash.call('hubspot', 'hubspot-get-link', params)
+      end
+
+      # 🎯 Purpose: 1. This tool retrieves a paginated list of workflows from the HubSpot account. 🧭 Usage Guidance: 1. Use the "limit" parameter to control the number of results returned per page. 2. For...
+      #
+      # @param limit [Float, nil] The maximum number of workflows to return per page (1-100).
+      # @param after [String, nil] Cursor token to fetch the next page of results. Use the paging.next.after value from the previous response.
+      # @return [Object]
+      def hubspot_list_workflows(limit: nil, after: nil)
+        params = {
+          'limit' => limit,
+          'after' => after
+        }.compact
+        @leash.call('hubspot', 'hubspot-list-workflows', params)
+      end
+
+      # 🎯 Purpose: 1. This tool retrieves detailed information about a specific workflow from the HubSpot account. 🧭 Usage Guidance: 1. Use the "flowId" parameter to specify which workflow to retrieve. 2...
+      #
+      # @param flowid [String] The ID of the workflow to retrieve
+      # @return [Object]
+      def hubspot_get_workflow(flowid)
+        params = {
+          'flowId' => flowid
+        }.compact
+        @leash.call('hubspot', 'hubspot-get-workflow', params)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: leash-integration-hubspot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: leash-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Auto-generated typed client for the HubSpot integration on Leash.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/leash/integration/hubspot.rb
+homepage: https://github.com/leash-build/leash-codegen
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Typed HubSpot integration for Leash
+test_files: []