README

FlowHunt API

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/flowhunt-php-sdk.git"
    }
  ],
  "require": {
    "GIT_USER_ID/flowhunt-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/FlowHunt/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: HTTPBearer
$config = FlowHunt\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FlowHunt\Api\ApiKeysApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 'workspace_id_example'; // string
$api_key_create_request = new \FlowHunt\Model\ApiKeyCreateRequest(); // \FlowHunt\Model\ApiKeyCreateRequest

try {
    $result = $apiInstance->createApiKey($workspace_id, $api_key_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->createApiKey: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ApiKeysApi	createApiKey	POST /v2/api_keys/create	Create Api Key
ApiKeysApi	deleteApiKey	DELETE /v2/api_keys/{api_key_id}	Delete Api Key
ApiKeysApi	searchApiKey	POST /v2/api_keys/search	Search Api Key
ApiKeysApi	updateApiKey	PUT /v2/api_keys/{api_key_id}	Update Api Key
BillingApi	addAddonToSubscription	POST /v2/billing/addons/{product_id}/add	Add Addon To Subscription
BillingApi	confirmShopifySubscription	GET /v2/billing/shopify/confirm	Confirm Shopify Subscription
BillingApi	createChangePlanPortal	POST /v2/billing/portal/change-plan/create	Create Change Plan Portal
BillingApi	createCheckout	POST /v2/billing/checkout/create	Create Checkout
BillingApi	createUpdateInfoPortal	POST /v2/billing/portal/update-info/create	Create Update Info Portal
BillingApi	getPricingPlans	GET /v2/billing/plans	Get Pricing Plans
BillingApi	getUserPlan	GET /v2/billing/plans/me	Get User Plan
BillingApi	stripeWebhook	POST /v2/billing/webhook	Stripe Webhook
ChatbotsApi	createChatbot	POST /v2/chatbots/create	Create Chatbot
ChatbotsApi	deleteChatbot	DELETE /v2/chatbots/{chatbot_id}	Delete Chatbot
ChatbotsApi	getChatbot	GET /v2/chatbots/{chatbot_id}	Get Chatbot
ChatbotsApi	searchChatbots	POST /v2/chatbots/	Search Chatbots
ChatbotsApi	updateChatbot	PUT /v2/chatbots/{chatbot_id}	Update Chatbot
CreditsApi	getCreditBalance	GET /v2/credits/balance	Get Credit Balance
CreditsApi	getWorkspaceCreditBalance	GET /v2/credits/workspace_balance	Get Workspace Credit Balance
CreditsApi	searchCreditTransactions	POST /v2/credits/search	Search Credit Transactions
CreditsApi	searchDailyCreditTransactions	POST /v2/credits/search_daily	Search Daily Credit Transactions
DocumentsApi	createDocumentCategory	POST /v2/documents/categories/create	Create Document Category
DocumentsApi	createFaq	POST /v2/documents/faqs/create	Create Faq
DocumentsApi	deleteDocument	DELETE /v2/documents/{doc_id}	Delete Document
DocumentsApi	deleteDocumentCategory	DELETE /v2/documents/categories/{cat_id}	Delete Document Category
DocumentsApi	deleteFaq	DELETE /v2/documents/faqs/{faq_id}	Delete Faq
DocumentsApi	downloadBinaryDocument	GET /v2/documents/download/binary/{doc_id}	Download Binary Document
DocumentsApi	downloadTextDocument	GET /v2/documents/download/text/{doc_id}	Download Text Document
DocumentsApi	importFaq	POST /v2/documents/faqs/import	Import Faq
DocumentsApi	searchDocumentCategories	POST /v2/documents/categories/search	Search Document Categories
DocumentsApi	searchDocuments	POST /v2/documents/search	Search Documents
DocumentsApi	searchFaqs	POST /v2/documents/faqs/search	Search Faqs
DocumentsApi	updateDocument	PUT /v2/documents/{doc_id}	Update Document
DocumentsApi	updateDocumentCategory	PUT /v2/documents/categories/{cat_id}	Update Document Category
DocumentsApi	updateFaq	PUT /v2/documents/faqs/{faq_id}	Update Faq
DocumentsApi	uploadFromUrlDocument	POST /v2/documents/upload-from-url/{cat_id}	Upload From Url Document
DocumentsApi	uploadMemoryDocument	POST /v2/documents/upload/{cat_id}	Upload Memory Document
FineTuningsApi	createImageFt	POST /v2/photo_ai/images/	Create Image Ft
FineTuningsApi	deleteFileFt	DELETE /v2/photo_ai/files/{file_key}	Delete File Ft
FineTuningsApi	deleteImageFt	DELETE /v2/photo_ai/images/{ft_id}	Delete Image Ft
FineTuningsApi	generateImagePrompt	POST /v2/photo_ai/inference/images/generate-prompt	Generate Image Prompt
FineTuningsApi	generateImages	POST /v2/photo_ai/inference/images	Generate Images
FineTuningsApi	getFileFt	GET /v2/photo_ai/files/{file_key}	Get File Ft
FineTuningsApi	getInferenceResults	GET /v2/photo_ai/inference/results/{inference_id}	Get Inference Results
FineTuningsApi	handleReplicateWebhook	POST /v2/photo_ai/webhooks/replicate	Handle Replicate Webhook
FineTuningsApi	searchImageFts	POST /v2/photo_ai/images/search	Search Image Fts
FineTuningsApi	searchInferenceHistory	POST /v2/photo_ai/inference/history	Search Inference History
FineTuningsApi	updateImageFt	PUT /v2/photo_ai/images/{ft_id}	Update Image Ft
FineTuningsApi	uploadImageFt	POST /v2/photo_ai/files/{ft_type}/upload	Upload Image Ft
FlowAssistantApi	applyFlowAssistantChanges	POST /v2/flow_assistants/apply_changes	Apply Flow Assistant Changes
FlowAssistantApi	createFlowAssistantSession	POST /v2/flow_assistants/create	Create Flow Assistant Session
FlowAssistantApi	invokeFlowAssistantResponse	POST /v2/flow_assistants/{session_id}/invoke	Invoke Flow Assistant Response
FlowAssistantApi	pollFlowAssistantResponse	POST /v2/flow_assistants/{session_id}/invocation_response/{from_timestamp}	Poll Flow Assistant Response
FlowAssistantApi	rejectFlowAssistantChanges	POST /v2/flow_assistants/reject_changes	Reject Flow Assistant Changes
FlowMessagesApi	searchFlowMessages	POST /v2/chatbots/search/{session_id}	Search Flow Messages
FlowSessionsApi	deleteChatbotSessionView	DELETE /v2/chatbots/sessions/{session_id}	Delete Chatbot Session View
FlowSessionsApi	getChartFeedback	POST /v2/chatbots/sessions/charts	Get Chart Feedback
FlowSessionsApi	getChartSessionDuration	POST /v2/chatbots/sessions/chart_session_duration	Get Chart Session Duration
FlowSessionsApi	getChatbotSessionView	GET /v2/chatbots/sessions/{session_id}	Get Chatbot Session View
FlowSessionsApi	getToolCallsChartFeedback	POST /v2/chatbots/sessions/chart_tool_calls	Get Tool Calls Chart Feedback
FlowSessionsApi	searchChatbotSessionsView	POST /v2/chatbots/sessions/search	Search Chatbot Sessions View
FlowSessionsApi	updateChatbotSessionView	PUT /v2/chatbots/sessions/{session_id}	Update Chatbot Session View
FlowWebhooksApi	executeThirdPartyWebhook	POST /v2/flows/webhooks/third_party_integrations/{trigger_type}	Execute Third Party Webhook
FlowWebhooksApi	executeWebhook	POST /v2/flows/webhooks/{chatbot_id}	Execute Webhook
FlowWebhooksApi	executeWebhookFromFlow	POST /v2/flows/webhooks/from_flow/{flow_id}	Execute Webhook From Flow
FlowsApi	createChatbotSession	POST /v2/flows/sessions/create	Create Chatbot Session
FlowsApi	createFlow	POST /v2/flows/create	Create Flow
FlowsApi	createFlowCategory	POST /v2/flows/categories/create	Create Flow Category
FlowsApi	createFlowCron	POST /v2/flows/crons/create	Create Flow Cron
FlowsApi	createFlowSession	POST /v2/flows/sessions/from_flow/create	Create Flow Session
FlowsApi	createMessageFeedback	POST /v2/flows/sessions/{session_id}/feedback	Create Message Feedback
FlowsApi	deleteAttachment	DELETE /v2/flows/sessions/{session_id}/attachments/{file_id}	Delete Attachment
FlowsApi	deleteFlow	DELETE /v2/flows/{flow_id}	Delete Flow
FlowsApi	deleteFlowCategory	DELETE /v2/flows/categories/{cat_id}	Delete Flow Category
FlowsApi	deleteFlowCron	DELETE /v2/flows/crons/{flow_id}/{cron_id}	Delete Flow Cron
FlowsApi	executeFlowCron	POST /v2/flows/crons/{flow_id}/{cron_id}/execute	Execute Flow Cron
FlowsApi	generateCommitMessage	POST /v2/flows/{flow_id}/generate-commit-msg	Generate Commit Message
FlowsApi	get	GET /v2/flows/{flow_id}	Get
FlowsApi	getAllComponents	GET /v2/flows/components/all	Get All Components
FlowsApi	getAttachments	GET /v2/flows/sessions/{session_id}/attachments	Get Attachments
FlowsApi	getFlowVersions	GET /v2/flows/{flow_id}/version_history	Get Flow Versions
FlowsApi	getInvokedFlowResults	GET /v2/flows/{flow_id}/{task_id}	Get Invoked Flow Results
FlowsApi	getPublicFlow	GET /v2/flows/public/{flow_id}	Get Public Flow
FlowsApi	getTriggerTypes	POST /v2/flows/{flow_id}/triggers	Get Trigger Types
FlowsApi	invokeFlow	POST /v2/flows/{flow_id}/invoke	Invoke Flow
FlowsApi	invokeFlowResponse	POST /v2/flows/sessions/{session_id}/invoke	Invoke Flow Response
FlowsApi	invokeFlowSingleton	POST /v2/flows/{flow_id}/invoke_singleton	Invoke Flow Singleton
FlowsApi	pollFlowResponse	POST /v2/flows/sessions/{session_id}/invocation_response/{from_timestamp}	Poll Flow Response
FlowsApi	publishFlow	POST /v2/flows/{flow_id}/publish	Publish Flow
FlowsApi	restoreFlowVersion	POST /v2/flows/{flow_id}/version_history/{branch}/restore	Restore Flow Version
FlowsApi	search	POST /v2/flows/	Search
FlowsApi	searchAll	POST /v2/flows/all	Search All
FlowsApi	searchFlowCategories	POST /v2/flows/categories/search	Search Flow Categories
FlowsApi	searchFlowCrons	POST /v2/flows/crons/search	Search Flow Crons
FlowsApi	updateFlow	PUT /v2/flows/{flow_id}	Update Flow
FlowsApi	updateFlowCategory	PUT /v2/flows/categories/{cat_id}	Update Flow Category
FlowsApi	updateFlowCron	PUT /v2/flows/crons/{flow_id}/{cron_id}	Update Flow Cron
FlowsApi	uploadAttachments	POST /v2/flows/sessions/{session_id}/attachments	Upload Attachments
GoogleApi	getCalendars	GET /v2/integrations/google/calendar	Get Calendars
GoogleApi	getPickerToken	GET /v2/integrations/google/picker_token	Get Picker Token
GoogleApi	getSheets	GET /v2/integrations/google/sheets/{document_id}	Get Sheets
GoogleAdsApi	addKeywordToGroup	POST /v2/integrations/google_ads/keyword/add_to_group	Add Keyword To Group
GoogleAdsApi	analyzeNotAssignedKeywords	POST /v2/integrations/google_ads/analyze_not_assigned_keywords	Analyze Not Assigned Keywords
GoogleAdsApi	getGoogleAdsCampaigns	POST /v2/integrations/google_ads/campaigns	Get Google Ads Campaigns
GoogleAdsApi	getGoogleAdsCustomers	POST /v2/integrations/google_ads/customers	Get Google Ads Customers
GoogleAdsApi	getGoogleAdsGroups	POST /v2/integrations/google_ads/groups	Get Google Ads Groups
GoogleAdsApi	getRecommendations	POST /v2/integrations/google_ads/recommendations/	Get Recommendations
GoogleAdsApi	importGoogleAdsCampaigns	POST /v2/integrations/google_ads/campaigns/import	Import Google Ads Campaigns
GoogleAdsApi	importGoogleAdsCustomers	POST /v2/integrations/google_ads/customers/import	Import Google Ads Customers
GoogleAdsApi	importGoogleAdsGroups	POST /v2/integrations/google_ads/groups/import	Import Google Ads Groups
GoogleAdsApi	removeKeywordFromGroup	POST /v2/integrations/google_ads/keyword/remove_from_group	Remove Keyword From Group
GoogleAdsApi	updateGoogleAdsCampaign	PUT /v2/integrations/google_ads/campaigns/{customer_id}/{campaign_id}	Update Google Ads Campaign
GoogleAdsApi	updateGoogleAdsCustomerUpdate	PUT /v2/integrations/google_ads/customers/{customer_id}	Update Google Ads Customer Update
GoogleAdsApi	updateGoogleAdsGroup	PUT /v2/integrations/google_ads/groups/{customer_id}/{campaign_id}/{group_id}	Update Google Ads Group
HealthApi	health	GET /v2/monitoring/health/	Health
HubSpotApi	getActors	GET /v2/integrations/hubspot/actors/	Get Actors
ImagesApi	convertImage	POST /v2/images/convert	Convert Image
ImagesApi	getScreenshot	POST /v2/images/screenshot	Get Screenshot
ImagesApi	optimizeImage	POST /v2/images/optimize	Optimize Image
InstagramApi	getProfileInformation	GET /v2/integrations/instagram/profile_information	Get Profile Information
IntegrationsApi	createIntegration	POST /v2/integrations/{slug}/integrate	Create Integration
IntegrationsApi	customerDataRequest	POST /v2/integrations/shopify/webhooks/customers/data_request	Customer Data Request
IntegrationsApi	customerRedact	POST /v2/integrations/shopify/webhooks/customers/redact	Customer Redact
IntegrationsApi	deleteIntegration	DELETE /v2/integrations/{slug}/{integration_id}	Delete Integration
IntegrationsApi	getActors	GET /v2/integrations/hubspot/actors/	Get Actors
IntegrationsApi	getAllIntegrations	GET /v2/integrations/all	Get All Integrations
IntegrationsApi	getCalendars	GET /v2/integrations/google/calendar	Get Calendars
IntegrationsApi	getHubspotCustomChannelConnect	GET /v2/integrations/hubspot_custom_channel_connect	Get Hubspot Custom Channel Connect
IntegrationsApi	getIntegration	GET /v2/integrations/{slug}/{integration_id}	Get Integration
IntegrationsApi	getPickerToken	GET /v2/integrations/google/picker_token	Get Picker Token
IntegrationsApi	getProfileInformation	GET /v2/integrations/instagram/profile_information	Get Profile Information
IntegrationsApi	getSheets	GET /v2/integrations/google/sheets/{document_id}	Get Sheets
IntegrationsApi	getShopify	GET /v2/integrations/shopify/	Get Shopify
IntegrationsApi	getSlackChannels	GET /v2/integrations/slack/{slack_team_id}/channels	Get Slack Channels
IntegrationsApi	getSlackWorkspaces	GET /v2/integrations/slack/	Get Slack Workspaces
IntegrationsApi	getWordpressPostCategories	GET /v2/integrations/wordpress/{integration_id}/categories	Get Wordpress Post Categories
IntegrationsApi	getWordpressPostTags	GET /v2/integrations/wordpress/{integration_id}/tags	Get Wordpress Post Tags
IntegrationsApi	getWordpressSites	GET /v2/integrations/wordpress/sites	Get Wordpress Sites
IntegrationsApi	integrationCallback	GET /v2/integrations/{slug}/callback	Integration Callback
IntegrationsApi	searchIntegrations	POST /v2/integrations/{slug}	Search Integrations
IntegrationsApi	shopRedact	POST /v2/integrations/shopify/webhooks/shop/redact	Shop Redact
IntegrationsApi	subscriptionCancel	POST /v2/integrations/shopify/webhooks/billing/subscription_cancel	Subscription Cancel
IntegrationsApi	subscriptionUpdate	POST /v2/integrations/shopify/webhooks/billing/subscription_update	Subscription Update
IntegrationsApi	updateAdminConsent	POST /v2/integrations/microsoft_entra_id/admin_consent	Update Admin Consent
LogsApi	searchLogs	POST /v2/logs/search	Search logs
MCPServersApi	createMcpServer	POST /v2/mcp_servers/create	Create Mcp Server
MCPServersApi	deleteMcpServer	DELETE /v2/mcp_servers/{mcp_server_id}	Delete Mcp Server
MCPServersApi	getAllMcpSubservers	GET /v2/mcp_servers/all	Get All Mcp Subservers
MCPServersApi	getMcpServer	GET /v2/mcp_servers/{mcp_server_id}	Get Mcp Server
MCPServersApi	searchMcpServers	POST /v2/mcp_servers/	Search Mcp Servers
MCPServersApi	updateMcpServer	PUT /v2/mcp_servers/{mcp_server_id}	Update Mcp Server
MeApi	getUserSettings	GET /v2/users/me/settings	Get User Settings
MeApi	updateUserSettings	PUT /v2/users/me/settings	Update User Settings
MediaApi	getTranscript	POST /v2/media/transcript	Get Transcript
MediaApi	getTranscriptResult	POST /v2/media/transcript_status	Get Transcript Result
MediaApi	getYoutubeTranscript	POST /v2/media/youtube/transcript	Get Youtube Transcript
MemoryApi	createNode	POST /v2/memory/node/create	Create Node
MemoryApi	deleteNode	DELETE /v2/memory/node/{node_id}	Delete Node
MemoryApi	getNode	POST /v2/memory/node/{node_id}	Get Node
MemoryApi	processDocuments	POST /v2/memory/process-documents	Process Documents
MemoryApi	searchMemoryCategories	POST /v2/memory/search	Search Memory Categories
MemoryApi	searchMemoryNodeName	POST /v2/memory/search_node_name	Search Memory Node Name
MemoryApi	searchMemoryNodePath	POST /v2/memory/search_node_path	Search Memory Node Path
MemoryApi	updateNode	PUT /v2/memory/node/{node_id}	Update Node
MemoryApi	uploadDocument	POST /v2/memory/upload/{cat_id}	Upload Document
MicrosoftOutlookApi	updateAdminConsent	POST /v2/integrations/microsoft_entra_id/admin_consent	Update Admin Consent
OAuthApi	oauthAuthorize	GET /v2/auth/oauth/authorize	Oauth Authorize
OAuthApi	oauthAuthorizePost	POST /v2/auth/oauth/authorize	Oauth Authorize Post
OAuthApi	oauthCallback	GET /v2/auth/oauth/callback	Oauth Callback
OAuthApi	oauthLogin	GET /v2/auth/oauth/login	Oauth Login
OAuthApi	oauthLoginGithub	GET /v2/auth/oauth/login/github	Oauth Login Github
OAuthApi	oauthLoginGoogle	GET /v2/auth/oauth/login/google	Oauth Login Google
OAuthApi	oauthLoginPost	POST /v2/auth/oauth/login	Oauth Login Post
OAuthApi	oauthLoginShopify	GET /v2/auth/oauth/login/shopify	Oauth Login Shopify
OAuthApi	oauthLogout	GET /v2/auth/oauth/logout	Oauth Logout
OAuthApi	oauthRevoke	POST /v2/auth/oauth/revoke	Oauth Revoke
OAuthApi	oauthToken	POST /v2/auth/oauth/token	Oauth Token
OAuthApi	oauthUserinfo	GET /v2/auth/oauth/userinfo	Oauth Userinfo
OAuthApi	samlCallback	POST /v2/auth/oauth/callback/saml/{random_id}	Saml Callback
ObservabilityDriverApi	activateLangfuseObservabilityDriver	POST /v2/observability_driver/langfuse	Activate Langfuse Observability Driver
ObservabilityDriverApi	activatePowerBiObservabilityDriver	POST /v2/observability_driver/power_bi	Activate Power Bi Observability Driver
ObservabilityDriverApi	createPowerBiPushDataset	POST /v2/observability_driver/power_bi/push_dataset	Create Power Bi Push Dataset
ObservabilityDriverApi	deleteObservabilityDriver	DELETE /v2/observability_driver/{driver_type}	Delete Observability Driver
ObservabilityDriverApi	getObservabilityDriver	GET /v2/observability_driver/{driver_type}	Get Observability Driver
ObservabilityDriverApi	getObservabilityDriverWorkspace	POST /v2/observability_driver/	Get Observability Driver Workspace
ObservabilityDriverApi	listPowerBiDatasets	POST /v2/observability_driver/power_bi/datasets	List Power Bi Datasets
ObservabilityDriverApi	listPowerBiTables	POST /v2/observability_driver/power_bi/tables	List Power Bi Tables
ObservabilityDriverApi	listPowerBiWorkspaces	GET /v2/observability_driver/power_bi/workspaces	List Power Bi Workspaces
ObservabilityDriverApi	updateLangfuseObservabilityDriver	PUT /v2/observability_driver/langfuse	Update Langfuse Observability Driver
ObservabilityDriverApi	updatePowerBiObservabilityDriver	PUT /v2/observability_driver/power_bi	Update Power Bi Observability Driver
ObservabilityDriverApi	validatePushDatasetTable	POST /v2/observability_driver/power_bi/validate_push_dataset	Validate Push Dataset Table
PhotoAIApi	explore	GET /v2/photo_ai/public/explore	Explore
PhotoAIApi	getEffects	GET /v2/photo_ai/public/effects	Get Effects
PhotoAIApi	getStyles	GET /v2/photo_ai/public/styles	Get Styles
PhotoAIApi	getTemplates	GET /v2/photo_ai/public/templates	Get Templates
PromptsApi	createPrompt	POST /v2/prompts/create	Create Prompt
PromptsApi	createPromptCategory	POST /v2/prompts/categories/create	Create Prompt Category
PromptsApi	deletePrompt	DELETE /v2/prompts/{prompt_id}	Delete Prompt
PromptsApi	deletePromptCategory	DELETE /v2/prompts/categories/{cat_id}	Delete Prompt Category
PromptsApi	searchPromptCategories	POST /v2/prompts/categories/search	Search Prompt Categories
PromptsApi	searchPrompts	POST /v2/prompts/search	Search Prompts
PromptsApi	updatePrompt	PUT /v2/prompts/{prompt_id}	Update Prompt
PromptsApi	updatePromptCategory	PUT /v2/prompts/categories/{cat_id}	Update Prompt Category
ReindexApi	getReindexStatus	GET /v2/reindex/status	Get Reindex Status
ReindexApi	triggerReindex	POST /v2/reindex/	Trigger Reindex
SERPApi	searchClusterQuery	POST /v2/serp/clusters/keywords	Search Cluster Query
SERPApi	serpClusterAddQueries	POST /v2/serp/clusters/{customer_id}/{campaign_id}/{group_id}/add_keywords	Serp Cluster Add Queries
SERPApi	serpClusterDeleteCampaign	DELETE /v2/serp/clusters/{customer_id}/{campaign_id}	Serp Cluster Delete Campaign
SERPApi	serpClusterDeleteCustomer	DELETE /v2/serp/clusters/{customer_id}	Serp Cluster Delete Customer
SERPApi	serpClusterDeleteGroup	DELETE /v2/serp/clusters/{customer_id}/{campaign_id}/{group_id}	Serp Cluster Delete Group
SERPApi	serpClusterDeleteGroupQueries	DELETE /v2/serp/clusters/{customer_id}/{campaign_id}/{group_id}/delete_queries	Serp Cluster Delete Group Queries
SERPApi	serpClusterGetGraphNodes	POST /v2/serp/clusters/graph_nodes	Serp Cluster Get Graph Nodes
SERPApi	serpClusterGetMatchingGroupsToQuery	POST /v2/serp/clusters/recommended_groups	Serp Cluster Get Matching Groups To Query
SERPApi	serpClusterGetRelatedKeywordsToQuery	POST /v2/serp/clusters/related_keywords	Serp Cluster Get Related Keywords To Query
SERPApi	serpClusterSplitToSubClusters	POST /v2/serp/clusters/split_sub_clusters	Serp Cluster Split To Sub Clusters
SERPApi	serpSearch	POST /v2/serp/serp/search	Serp Search
SERPApi	serpVolumes	POST /v2/serp/serp/volumes	Serp Volumes
SERPApi	serpVolumesPingback	GET /v2/serp/serp/volumes/pingback/{id}/{tag}	Serp Volumes Pingback
SchedulesApi	createSchedules	POST /v2/schedules/create	Create Schedules
SchedulesApi	deleteSchedule	DELETE /v2/schedules/{schedule_id}	Delete Schedule
SchedulesApi	getSchedule	GET /v2/schedules/{schedule_id}	Get Schedule
SchedulesApi	getScheduleUrlDetails	GET /v2/schedules/{schedule_id}/urls/{domain_id}/{url_id}	Get Schedule Url Details
SchedulesApi	getSchedules	POST /v2/schedules/	Get Schedules
SchedulesApi	runSchedule	POST /v2/schedules/run/{schedule_id}	Run Schedule
SchedulesApi	searchScheduleUrls	POST /v2/schedules/urls/	Search Schedule Urls
SchedulesApi	updateSchedule	PUT /v2/schedules/{schedule_id}	Update Schedule
SecretsApi	createSecret	POST /v2/secrets/create	Create Secret
SecretsApi	deleteSecret	DELETE /v2/secrets/{secret_id}	Delete Secret
SecretsApi	getSecret	GET /v2/secrets/{secret_id}	Get Secret
SecretsApi	searchSecret	POST /v2/secrets/search	Search Secret
SecretsApi	updateSecret	PUT /v2/secrets/{secret_id}	Update Secret
SemanticSearchApi	getSimilarDocsByDocId	POST /v2/similarities/document/live	Get Similar Docs By Doc Id
SemanticSearchApi	getSimilarDocsByQuery	POST /v2/similarities/query/live	Get Similar Docs By Query
SemanticSearchApi	scheduleSimilarDocsByDocId	POST /v2/similarities/document	Schedule Similar Docs By Doc Id
SemanticSearchApi	scheduleSimilarDocsByQuery	POST /v2/similarities/query	Schedule Similar Docs By Query
ShopifyApi	customerDataRequest	POST /v2/integrations/shopify/webhooks/customers/data_request	Customer Data Request
ShopifyApi	customerRedact	POST /v2/integrations/shopify/webhooks/customers/redact	Customer Redact
ShopifyApi	getShopify	GET /v2/integrations/shopify/	Get Shopify
ShopifyApi	shopRedact	POST /v2/integrations/shopify/webhooks/shop/redact	Shop Redact
ShopifyApi	subscriptionCancel	POST /v2/integrations/shopify/webhooks/billing/subscription_cancel	Subscription Cancel
ShopifyApi	subscriptionUpdate	POST /v2/integrations/shopify/webhooks/billing/subscription_update	Subscription Update
SlackApi	getSlackChannels	GET /v2/integrations/slack/{slack_team_id}/channels	Get Slack Channels
SlackApi	getSlackWorkspaces	GET /v2/integrations/slack/	Get Slack Workspaces
TagsApi	createTag	POST /v2/tags/create	Create Tag
TagsApi	deleteTag	DELETE /v2/tags/{tag_id}	Delete Tag
TagsApi	searchTags	POST /v2/tags/search	Search Tags
TagsApi	updateTag	PUT /v2/tags/{tag_id}	Update Tag
TrackingApi	searchEvents	POST /v2/tracking/events	Search Events
TrackingApi	searchLinks	POST /v2/tracking/links	Search Links
TrackingApi	searchSources	POST /v2/tracking/sources	Search Sources
TrackingApi	trackClick	POST /v2/tracking/clk	Track Click
TrackingApi	trackEvent	POST /v2/tracking/evnt	Track Event
TrackingApi	trackLink	POST /v2/tracking/lnk	Track Link
WebAuthApi	activateAccount	GET /v2/auth/activate	Activate Account
WebAuthApi	getUser	GET /v2/auth/me	Get User
WebAuthApi	passwordRecoveryPage	GET /v2/auth/recover-password	Password Recovery Page
WebAuthApi	passwordRecoverySubmit	POST /v2/auth/recover-password	Password Recovery Submit
WebAuthApi	registerPage	GET /v2/auth/register	Register Page
WebAuthApi	registerSubmit	POST /v2/auth/register	Register Submit
WebAuthApi	resetPasswordPage	GET /v2/auth/reset-password	Reset Password Page
WebAuthApi	resetPasswordSubmit	POST /v2/auth/reset-password	Reset Password Submit
WebAuthApi	ssoLoginPage	GET /v2/auth/oauth/sso	Sso Login Page
WebAuthApi	ssoLoginSubmit	POST /v2/auth/oauth/sso	Sso Login Submit
WordPressApi	getWordpressPostCategories	GET /v2/integrations/wordpress/{integration_id}/categories	Get Wordpress Post Categories
WordPressApi	getWordpressPostTags	GET /v2/integrations/wordpress/{integration_id}/tags	Get Wordpress Post Tags
WordPressApi	getWordpressSites	GET /v2/integrations/wordpress/sites	Get Wordpress Sites
WorkspacesApi	addWorkspaceUser	POST /v2/workspaces/{workspace_id}/add-member	Add Workspace User
WorkspacesApi	createWorkspace	POST /v2/workspaces/create	Create Workspace
WorkspacesApi	deleteWorkspace	DELETE /v2/workspaces/{workspace_id}	Delete Workspace
WorkspacesApi	deleteWorkspaceUser	DELETE /v2/workspaces/{workspace_id}/{user_id}	Delete Workspace User
WorkspacesApi	getWorkspace	POST /v2/workspaces/{workspace_id}	Get Workspace
WorkspacesApi	searchMyWorkspaces	POST /v2/workspaces/me/my_workspaces	Search My Workspaces
WorkspacesApi	searchWorkspaceUsers	POST /v2/workspaces/{workspace_id}/users	Search Workspace Users
WorkspacesApi	updateWorkspace	PUT /v2/workspaces/{workspace_id}	Update Workspace
WorkspacesApi	updateWorkspaceUser	PUT /v2/workspaces/{workspace_id}/{user_id}	Update Workspace User
WorkspacesSSOApi	createWorkspaceSsoSettings	POST /v2/workspaces/{workspace_id}/sso	Create Workspace Sso Settings
WorkspacesSSOApi	deleteWorkspaceSsoSettings	DELETE /v2/workspaces/{workspace_id}/sso/{provider}	Delete Workspace Sso Settings
WorkspacesSSOApi	getWorkspaceSsoSettings	GET /v2/workspaces/{workspace_id}/sso/{provider}	Get Workspace Sso Settings
WorkspacesSSOApi	listWorkspaceSsoSettings	GET /v2/workspaces/{workspace_id}/sso	List Workspace Sso Settings
WorkspacesSSOApi	updateWorkspaceSsoSettings	PUT /v2/workspaces/{workspace_id}/sso/{provider}	Update Workspace Sso Settings
WorkspacesSSODomainVerificationApi	createDomainVerification	POST /v2/workspaces/{workspace_id}/sso/domain-verification	Create Domain Verification
WorkspacesSSODomainVerificationApi	deleteDomainVerification	DELETE /v2/workspaces/{workspace_id}/sso/domain-verification	Delete Domain Verification
WorkspacesSSODomainVerificationApi	listDomainVerifications	GET /v2/workspaces/{workspace_id}/sso/domain-verification	List Domain Verifications
WorkspacesSSODomainVerificationApi	verifyDomain	POST /v2/workspaces/{workspace_id}/sso/domain-verification/verify	Verify Domain

Models

Authorization

Authentication schemes defined for the API:

APIKeyHeader

Type: API key
API key parameter name: Api-Key
Location: HTTP header

HTTPBearer

Type: Bearer authentication

sudo_api_key_header

Type: API key
API key parameter name: Sudo-Api-Key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.0.0
- Package version: 3.15.1
- Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

flowhunt / flowhunt-php-sdk

Maintainers

Details