gohighlevel 0.0.1

data/lib/high_level/resources/affiliate_manager.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/affiliate-manager.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class AffiliateManager < Base
+      # List Affiliates
+      #
+      # Retrieve the list of affiliates for a location.
+      def list_affiliates(location_id:, query: nil, active: nil, campaign_id: nil, skip: nil, limit: nil, from_date: nil, to_date: nil, **_opts)
+        request(
+          method: :get,
+          path: "/affiliate-manager/#{location_id}/affiliates",
+          security: ["bearer"],
+          params: { "query" => query, "active" => active, "campaignId" => campaign_id, "skip" => skip, "limit" => limit, "fromDate" => from_date, "toDate" => to_date }.compact
+        )
+      end
+
+      # Get Affiliate
+      #
+      # Retrieve a single affiliate by id for a location.
+      def get_affiliate(location_id:, affiliate_id:, **_opts)
+        request(
+          method: :get,
+          path: "/affiliate-manager/#{location_id}/affiliates/#{affiliate_id}",
+          security: ["bearer"]
+        )
+      end
+
+      # List Payouts
+      #
+      # Retrieve the list of payouts for a location.
+      def list_payouts(location_id:, status: nil, query: nil, affiliate_id: nil, campaign_id: nil, skip: nil, limit: nil, start: nil, end_: nil, **_opts)
+        request(
+          method: :get,
+          path: "/affiliate-manager/#{location_id}/payouts",
+          security: ["bearer"],
+          params: { "status" => status, "query" => query, "affiliateId" => affiliate_id, "campaignId" => campaign_id, "skip" => skip, "limit" => limit, "start" => start, "end" => end_ }.compact
+        )
+      end
+
+      # List Commissions
+      #
+      # Retrieve the list of commissions for a location.
+      def list_commissions(location_id:, campaign_id: nil, affiliate_id: nil, status: nil, query: nil, skip: nil, limit: nil, from_date: nil, to_date: nil, **_opts)
+        request(
+          method: :get,
+          path: "/affiliate-manager/#{location_id}/commissions",
+          security: ["bearer"],
+          params: { "campaignId" => campaign_id, "affiliateId" => affiliate_id, "status" => status, "query" => query, "skip" => skip, "limit" => limit, "fromDate" => from_date, "toDate" => to_date }.compact
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/agent_studio.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/agent-studio.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class AgentStudio < Base
+      # List Agents
+      #
+      # Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published production version.
+      def get_agents(location_id: nil, is_published: nil, limit: nil, offset: nil, source: nil, **_opts)
+        request(
+          method: :get,
+          path: "/agent-studio/agent",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "isPublished" => is_published, "limit" => limit, "offset" => offset, "source" => source }.compact
+        )
+      end
+
+      # Create Agent
+      #
+      # Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production.
+      def create_agent(body:, source: nil, **_opts)
+        request(
+          method: :post,
+          path: "/agent-studio/agent",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+
+      # Update Agent
+      #
+      # Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration.
+      def update_agent_version(version_id:, body:, source: nil, **_opts)
+        request(
+          method: :patch,
+          path: "/agent-studio/agent/versions/#{version_id}",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+
+      # Get Agent
+      #
+      # Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active status.
+      def get_agent_by_id(agent_id:, location_id: nil, source: nil, **_opts)
+        request(
+          method: :get,
+          path: "/agent-studio/agent/#{agent_id}",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "source" => source }.compact
+        )
+      end
+
+      # Update Agent Metadata
+      #
+      # Updates agent metadata such as name, description, and status.
+      def update_agent_metadata(agent_id:, body:, source: nil, **_opts)
+        request(
+          method: :patch,
+          path: "/agent-studio/agent/#{agent_id}",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+
+      # Delete Agent
+      #
+      # Deletes an agent and all its versions.
+      def delete_agent(agent_id:, location_id: nil, source: nil, **_opts)
+        request(
+          method: :delete,
+          path: "/agent-studio/agent/#{agent_id}",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "source" => source }.compact
+        )
+      end
+
+      # Promote to Production
+      #
+      # Promotes a draft version to production.
+      def promote_and_publish(version_id:, body:, source: nil, **_opts)
+        request(
+          method: :post,
+          path: "/agent-studio/agent/versions/#{version_id}/publish",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+
+      # Execute Agent
+      #
+      # Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified location. locationId is required in the request body.
+      #
+      # **Session Management:**
+      # - For the first message in a new session, do not include the `executionId` in the request payload.
+      # - The API will return an `executionId` along with the agent response, which uniquely identifies this conversation session.
+      # - To continue the conversation within the same session, include the `executionId` from the previous response in subsequent requests. This allows the agent to maintain conversation context and history across multiple interactions.
+      def execute_agent(agent_id:, body:, source: nil, **_opts)
+        request(
+          method: :post,
+          path: "/agent-studio/agent/#{agent_id}/execute",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+
+      # List Agents (Deprecated)
+      #
+      # **Deprecated endpoint - use GET /agent instead.**
+      #
+      # Lists all active agents that have a published production version for the specified location. locationId is required parameter. Supports pagination using limit and offset.
+      def get_agents_deprecated(location_id: nil, limit: nil, offset: nil, source: nil, **_opts)
+        request(
+          method: :get,
+          path: "/agent-studio/public-api/agents",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "limit" => limit, "offset" => offset, "source" => source }.compact
+        )
+      end
+
+      # Get Agent (Deprecated)
+      #
+      # **Deprecated endpoint - use GET /agent/:agentId instead.**
+      #
+      # Gets a specific agent by its ID for the specified location with all its versions. locationId is required parameter. The agent must have active status.
+      def get_agent_by_id_deprecated(agent_id:, location_id: nil, source: nil, **_opts)
+        request(
+          method: :get,
+          path: "/agent-studio/public-api/agents/#{agent_id}",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "source" => source }.compact
+        )
+      end
+
+      # Execute Agent (Deprecated)
+      #
+      # **Deprecated endpoint - use POST /agent/:agentId/execute instead.**
+      #
+      # Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified location. locationId is required in the request body.
+      #
+      # **Session Management:**
+      # - For the first message in a new session, do not include the `executionId` in the request payload.
+      # - The API will return an `executionId` along with the agent response, which uniquely identifies this conversation session.
+      # - To continue the conversation within the same session, include the `executionId` from the previous response in subsequent requests.
+      def execute_agent_deprecated(agent_id:, body:, source: nil, **_opts)
+        request(
+          method: :post,
+          path: "/agent-studio/public-api/agents/#{agent_id}/execute",
+          security: ["Location-Access"],
+          params: { "source" => source }.compact,
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/associations.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/associations.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Associations < Base
+      # Create Relation for you associated entities.
+      #
+      # Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
+      def create_relation(body:, **_opts)
+        request(
+          method: :post,
+          path: "/associations/relations",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Get all relations By record Id
+      #
+      # Get all relations by record Id
+      def get_relations_by_record_id(record_id:, location_id: nil, skip: nil, limit: nil, association_ids: nil, **_opts)
+        request(
+          method: :get,
+          path: "/associations/relations/#{record_id}",
+          security: ["bearer"],
+          params: { "locationId" => location_id, "skip" => skip, "limit" => limit, "associationIds" => association_ids }.compact
+        )
+      end
+
+      # Delete Relation
+      def delete_relation(relation_id:, location_id: nil, **_opts)
+        request(
+          method: :delete,
+          path: "/associations/relations/#{relation_id}",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Get association key by key name
+      #
+      # Using this api you can get standard / user defined association by key
+      def get_association_key_by_key_name(key_name:, location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/associations/key/#{key_name}",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Get association by object keys
+      #
+      # Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
+      def get_association_by_object_keys(object_key:, location_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/associations/objectKey/#{object_key}",
+          security: ["bearer"],
+          params: { "locationId" => location_id }.compact
+        )
+      end
+
+      # Get association by ID
+      #
+      # Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
+      def get_association_by_id(association_id:, **_opts)
+        request(
+          method: :get,
+          path: "/associations/#{association_id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Update Association By Id
+      #
+      # Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
+      def update_association(association_id:, body:, **_opts)
+        request(
+          method: :put,
+          path: "/associations/#{association_id}",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Delete Association
+      #
+      # Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association
+      def delete_association(association_id:, **_opts)
+        request(
+          method: :delete,
+          path: "/associations/#{association_id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Get all associations for a sub-account / location
+      #
+      # Get all Associations
+      def find_associations(location_id: nil, skip: nil, limit: nil, **_opts)
+        request(
+          method: :get,
+          path: "/associations/",
+          security: ["bearer"],
+          params: { "locationId" => location_id, "skip" => skip, "limit" => limit }.compact
+        )
+      end
+
+      # Create Association
+      #
+      # Allow you to create contact - contact , contact - custom objects associations, will add more in the future.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
+      def create_association(body:, **_opts)
+        request(
+          method: :post,
+          path: "/associations/",
+          security: ["bearer"],
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module HighLevel
+  # Namespace for the generated API resource classes. Each
+  # +vendor/openapi/apps/<app>.json+ spec emits one
+  # +HighLevel::Resources::<App>+ class; +RESOURCE_REGISTRY+ maps them to
+  # +client.<app>+ accessors.
+  module Resources
+    # Base class every generated resource inherits from. Owns the single
+    # {#request} entry point that generated methods delegate to. All
+    # logic — auth resolution, error mapping, refresh-on-401 — lives in
+    # the middleware stack on +client.connection+; this class is glue.
+    class Base
+      # @param client [HighLevel::Client] the owning client
+      def initialize(client)
+        @client = client
+      end
+
+      protected
+
+      # Dispatches a single API request through +client.connection+,
+      # attaching the operation's security requirements to the request
+      # context so {Middleware::Authentication} can resolve the token.
+      #
+      # @param method [Symbol] the HTTP verb
+      # @param path [String] the request path
+      # @param security [Array<String>] the operation's security requirements
+      # @param params [Hash, nil] query parameters
+      # @param body [Object, nil] the request body
+      # @param headers [Hash, nil] extra request headers
+      # @return [Object] the parsed response body
+      def request(method:, path:, security:, params: nil, body: nil, headers: nil)
+        response = @client.connection.run_request(method, path, body, nil) do |req|
+          req.params.update(params) if params && !params.empty?
+          headers&.each { |k, v| req.headers[k] = v }
+          req.options.context = {
+            HighLevel::Middleware::Authentication::CONTEXT_KEY => {
+              security_requirements: Array(security)
+            }
+          }
+        end
+        response.body
+      end
+    end
+  end
+end

data/lib/high_level/resources/blogs.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/blogs.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Blogs < Base
+      # Check url slug
+      #
+      # The "Check url slug" API allows check the blog slug validation which is needed before publishing any blog post. Please use blogs/check-slug.readonly. you can find the POST ID from the post edit url.
+      def check_url_slug_exists(url_slug: nil, location_id: nil, post_id: nil, **_opts)
+        request(
+          method: :get,
+          path: "/blogs/posts/url-slug-exists",
+          security: ["Location-Access"],
+          params: { "urlSlug" => url_slug, "locationId" => location_id, "postId" => post_id }.compact
+        )
+      end
+
+      # Update Blog Post
+      #
+      # The "Update Blog Post" API allows you update blog post for any given blog site. Please use blogs/post-update.write
+      def update_blog_post(body:, **_opts)
+        request(
+          method: :put,
+          path: "/blogs/posts/#{post_id}",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Create Blog Post
+      #
+      # The "Create Blog Post" API allows you create blog post for any given blog site. Please use blogs/post.write
+      def create_blog_post(body:, **_opts)
+        request(
+          method: :post,
+          path: "/blogs/posts",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Get all authors
+      #
+      # The "Get all authors" Api return the blog authors for a given location ID. Please use "blogs/author.readonly"
+      def get_all_blog_authors_by_location(location_id: nil, limit: nil, offset: nil, **_opts)
+        request(
+          method: :get,
+          path: "/blogs/authors",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "limit" => limit, "offset" => offset }.compact
+        )
+      end
+
+      # Get all categories
+      #
+      # The "Get all categories" Api return the blog categoies for a given location ID. Please use "blogs/category.readonly"
+      def get_all_categories_by_location(location_id: nil, limit: nil, offset: nil, **_opts)
+        request(
+          method: :get,
+          path: "/blogs/categories",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "limit" => limit, "offset" => offset }.compact
+        )
+      end
+
+      # Get Blog posts by Blog ID
+      #
+      # The "Get Blog posts by Blog ID" API allows you get blog posts for any given blog site using blog ID.Please use blogs/posts.readonly
+      def get_blog_post(location_id: nil, blog_id: nil, limit: nil, offset: nil, search_term: nil, status: nil, **_opts)
+        request(
+          method: :get,
+          path: "/blogs/posts/all",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "blogId" => blog_id, "limit" => limit, "offset" => offset, "searchTerm" => search_term, "status" => status }.compact
+        )
+      end
+
+      # Get Blogs by Location ID
+      #
+      # The "Get Blogs by Location ID" API allows you get blogs using Location ID.Please use blogs/list.readonly
+      def get_blogs(location_id: nil, skip: nil, limit: nil, search_term: nil, **_opts)
+        request(
+          method: :get,
+          path: "/blogs/site/all",
+          security: ["Location-Access"],
+          params: { "locationId" => location_id, "skip" => skip, "limit" => limit, "searchTerm" => search_term }.compact
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/brand_boards.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/brand-boards.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class BrandBoards < Base
+      # Get Brand Boards
+      #
+      # Retrieves all Brand Boards for a specific location
+      def get_brand_boards_by_location(location_id:, limit: nil, offset: nil, search: nil, deleted: nil, **_opts)
+        request(
+          method: :get,
+          path: "/brand-boards/#{location_id}",
+          security: ["Location-Access"],
+          params: { "limit" => limit, "offset" => offset, "search" => search, "deleted" => deleted }.compact
+        )
+      end
+
+      # Get Brand Board
+      #
+      # Retrieves a specific Brand Board by its ID
+      def get_brand_board_by_id(location_id:, id:, **_opts)
+        request(
+          method: :get,
+          path: "/brand-boards/#{location_id}/#{id}",
+          security: ["Location-Access"]
+        )
+      end
+
+      # Update a Brand Board
+      #
+      # Updates an existing Brand Board
+      def update_brand_board(location_id:, id:, body:, **_opts)
+        request(
+          method: :patch,
+          path: "/brand-boards/#{location_id}/#{id}",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+
+      # Delete a Brand Board
+      #
+      # Deletes a Brand Board
+      def delete_brand_board(location_id:, id:, **_opts)
+        request(
+          method: :delete,
+          path: "/brand-boards/#{location_id}/#{id}",
+          security: ["Location-Access"]
+        )
+      end
+
+      # Create a new brand board
+      #
+      # Creates a new brand board with logos, colors, and fonts
+      def create_brand_board(body:, **_opts)
+        request(
+          method: :post,
+          path: "/brand-boards/",
+          security: ["Location-Access"],
+          body: body
+        )
+      end
+    end
+  end
+end

data/lib/high_level/resources/businesses.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# GENERATED FROM vendor/openapi/apps/businesses.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
+# DO NOT EDIT — regenerate via bin/generate.
+
+module HighLevel
+  module Resources
+    class Businesses < Base
+      # Get Business
+      def get_business(business_id:, **_opts)
+        request(
+          method: :get,
+          path: "/businesses/#{business_id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Update Business
+      def update_business(business_id:, body:, **_opts)
+        request(
+          method: :put,
+          path: "/businesses/#{business_id}",
+          security: ["bearer"],
+          body: body
+        )
+      end
+
+      # Delete Business
+      def delete_business(business_id:, **_opts)
+        request(
+          method: :delete,
+          path: "/businesses/#{business_id}",
+          security: ["bearer"]
+        )
+      end
+
+      # Get Businesses by Location
+      def get_businesses_by_location(location_id: nil, limit: nil, skip: nil, **_opts)
+        request(
+          method: :get,
+          path: "/businesses/",
+          security: ["bearer"],
+          params: { "locationId" => location_id, "limit" => limit, "skip" => skip }.compact
+        )
+      end
+
+      # Create Business
+      def create_business(body:, **_opts)
+        request(
+          method: :post,
+          path: "/businesses/",
+          security: ["bearer"],
+          body: body
+        )
+      end
+    end
+  end
+end