Module: TheCompaniesAPI::Generated::OperationsMap

Defined in:

lib/thecompaniesapi/generated/operations_map.rb

Overview

Operations map auto-generated from OpenAPI schema

Constant Summary

OPERATIONS =

{"fetchApiHealth"=>{"path"=>"/", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get the health status of the API.", "parameters"=>[], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get the health status of the API.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"healthy"=>{"type"=>"boolean"}, "nodeName"=>{"type"=>"string"}, "report"=>{"type"=>"object", "additionalProperties"=>{"type"=>"object", "properties"=>{"displayName"=>{"type"=>"string"}, "health"=>{"type"=>"object", "properties"=>{"healthy"=>{"type"=>"boolean"}}, "required"=>["healthy"]}}, "required"=>["displayName", "health"]}}}, "required"=>["healthy", "nodeName", "report"]}}}}}}, "fetchOpenApi"=>{"path"=>"/v2/openapi", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get the current OpenAPI specification.", "parameters"=>[], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get the current OpenAPI specification.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{}}}}}}}, "fetchActions"=>{"path"=>"/v2/actions", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get and filter your actions.", "parameters"=>[{"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"full", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"number"}}, "required"=>false, "name"=>"ids", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"listId", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["active", "completed", "failed", "pending"]}, "required"=>false, "name"=>"status", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"teamId", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["jobs:request", "companies:added"]}, "required"=>false, "name"=>"type", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get and filter your actions.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actions"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/Action"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["actions", "meta"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["invalidListId"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "requestAction"=>{"path"=>"/v2/actions", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Request or estimate a new action.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"domains"=>{"type"=>"array", "items"=>{"type"=>"string"}, "maxItems"=>100000}, "estimate"=>{"type"=>"boolean"}, "fields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"description"=>{"type"=>"string"}, "key"=>{"type"=>"string"}, "type"=>{"type"=>"string", "enum"=>["array|boolean", "array|number", "array|string", "boolean", "number", "string"]}, "values"=>{"type"=>"array", "items"=>{"type"=>"string"}}}, "required"=>["key", "type"]}}, "job"=>{"type"=>"string", "enum"=>["ask-domain", "ask-list", "enrich-companies", "enrich-list", "cleanup-list"]}, "listId"=>{"type"=>"number"}, "names"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "promptId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "question"=>{"type"=>"string"}, "type"=>{"type"=>"string", "enum"=>["jobs:request", "companies:added"]}}, "required"=>["type"]}}}}, "responses"=>{"200"=>{"description"=>"Request or estimate a new action.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actions"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/Action"}}}, "required"=>["actions"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["invalidListId", "typeMissing"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["invalidPromptId"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "retryAction"=>{"path"=>"/v2/actions/{actionId}/retry", "method"=>"POST", "path_params"=>["actionId"], "summary"=>"", "description"=>"Ask for a retry of failed action.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"actionId", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{}}}}}, "responses"=>{"200"=>{"description"=>"Ask for a retry of failed action.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"action"=>{"$ref"=>"#/components/schemas/Action"}}, "required"=>["action"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["invalidActionId", "actionTypeInvalid"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCompanies"=>{"path"=>"/v2/companies", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search companies using a segmentation query.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"actionId", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"domainsToExclude", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"linkedinToExclude", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "required"=>false, "name"=>"query", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.name", "domain.domain"]}}, "required"=>false, "name"=>"searchFields", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "required"=>false, "name"=>"sortFields", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search companies using a segmentation query.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["companies", "meta", "query"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCompaniesPost"=>{"path"=>"/v2/companies", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Search companies using a segmentation query.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actionId"=>{"type"=>"number"}, "domainsToExclude"=>{"type"=>"string"}, "linkedinToExclude"=>{"type"=>"string"}, "page"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "search"=>{"type"=>"string"}, "searchFields"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.name", "domain.domain"]}}, "simplified"=>{"type"=>"boolean"}, "size"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "sortFields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "sortKey"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "sortOrder"=>{"type"=>"string", "enum"=>["asc", "desc"]}}}}}}, "responses"=>{"200"=>{"description"=>"Search companies using a segmentation query.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["companies", "meta", "query"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompany"=>{"path"=>"/v2/companies/{domain}", "method"=>"GET", "path_params"=>["domain"], "summary"=>"", "description"=>"Get a single company data by its domain.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"domain", "in"=>"path"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"refresh", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get a single company data by its domain.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/CompanyV2"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCompaniesByName"=>{"path"=>"/v2/companies/by-name", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search companies by name.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"countries", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"exactWordsMatch", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"listsToExclude", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"name", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.name", "domain.domain"]}}, "required"=>false, "name"=>"searchFields", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>25}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "required"=>false, "name"=>"sortFields", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search companies by name.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["companies", "meta"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNameEmpty"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCompaniesByPrompt"=>{"path"=>"/v2/companies/by-prompt", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search companies by prompt.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"listsToExclude", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"prompt", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>0, "maximum"=>2}, "required"=>false, "name"=>"similarity", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>50}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "required"=>false, "name"=>"sortFields", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search companies by prompt.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["companies", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchSimilarCompanies"=>{"path"=>"/v2/companies/similar", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get similar companies from one or many domains.", "parameters"=>[{"schema"=>{"type"=>"array", "items"=>{"type"=>"string"}, "maxItems"=>100}, "required"=>true, "name"=>"domains", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"proximityExact", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["close", "far", "near"]}, "required"=>false, "name"=>"proximityTerm", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "required"=>false, "name"=>"sortFields", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get similar companies from one or many domains.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["companies", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "countCompanies"=>{"path"=>"/v2/companies/count", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get the count of companies using a segmentation query.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"actionId", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "required"=>false, "name"=>"query", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.name", "domain.domain"]}}, "required"=>false, "name"=>"searchFields", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get the count of companies using a segmentation query.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"count"=>{"type"=>"number"}}, "required"=>["count"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "countCompaniesPost"=>{"path"=>"/v2/companies/count", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Get the count of companies using a segmentation body.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actionId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "search"=>{"type"=>"string"}, "searchFields"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.name", "domain.domain"]}}}}}}}, "responses"=>{"200"=>{"description"=>"Get the count of companies using a segmentation body.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"count"=>{"type"=>"number"}}, "required"=>["count"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompanyByEmail"=>{"path"=>"/v2/companies/by-email", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get a company data by email.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"email", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"refresh", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get a company data by email.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"company"=>{"$ref"=>"#/components/schemas/CompanyV2"}, "email"=>{"type"=>"object", "properties"=>{"address"=>{"type"=>"string"}, "domain"=>{"type"=>"string"}, "fullName"=>{"type"=>"object", "properties"=>{"first"=>{"type"=>"string"}, "last"=>{"type"=>"string"}, "middle"=>{"type"=>"string"}}}, "isDisposable"=>{"type"=>"boolean"}, "isFree"=>{"type"=>"boolean"}, "isSubaddress"=>{"type"=>"boolean"}, "isValid"=>{"type"=>"boolean"}, "isValidFormat"=>{"type"=>"boolean"}, "name"=>{"type"=>"string"}, "pattern"=>{"type"=>"string"}}, "required"=>["domain", "fullName", "isDisposable", "isFree", "isSubaddress", "isValid", "isValidFormat", "name"]}, "meta"=>{"type"=>"object", "properties"=>{"freeRequest"=>{"type"=>"boolean"}}}}, "required"=>["email"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompanyBySocial"=>{"path"=>"/v2/companies/by-social", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get a company data by social media.", "parameters"=>[{"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"angellist", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"dribbble", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"facebook", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"github", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"instagram", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"linkedin", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"pinterest", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"refresh", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"snapchat", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"souncloud", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"tiktok", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"twitter", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"wellfound", "in"=>"query"}, {"schema"=>{"type"=>"string", "format"=>"uri"}, "required"=>false, "name"=>"youtube", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get a company data by social media.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/CompanyV2"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompanyEmailPatterns"=>{"path"=>"/v2/companies/{domain}/email-patterns", "method"=>"GET", "path_params"=>["domain"], "summary"=>"", "description"=>"Get email patterns for a company by its domain.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"domain", "in"=>"path"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"emailsCount", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>0, "maximum"=>100}, "required"=>false, "name"=>"precision", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get email patterns for a company by its domain.", "content"=>{"application/json"=>{"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/EmailPattern"}}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "askCompany"=>{"path"=>"/v2/companies/{domain}/ask", "method"=>"POST", "path_params"=>["domain"], "summary"=>"", "description"=>"Ask a question about a company by its domain.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"domain", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"explain"=>{"type"=>"boolean"}, "fields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"description"=>{"type"=>"string"}, "key"=>{"type"=>"string"}, "type"=>{"type"=>"string", "enum"=>["array|boolean", "array|number", "array|string", "boolean", "number", "string"]}, "values"=>{"type"=>"array", "items"=>{"type"=>"string"}}}, "required"=>["key", "type"]}}, "listId"=>{"type"=>"number"}, "model"=>{"type"=>"string", "enum"=>["small", "large"]}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "question"=>{"type"=>"string"}}, "required"=>["question"]}}}}, "responses"=>{"200"=>{"description"=>"Ask a question about a company by its domain.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number"}, "model"=>{"type"=>"string", "enum"=>["small", "large"]}, "score"=>{"type"=>"number"}}, "required"=>["cost", "model"]}, "prompt"=>{"allOf"=>[{"$ref"=>"#/components/schemas/Prompt"}, {"type"=>"object", "properties"=>{"response"=>{"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "action"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number"}, "data"=>{"type"=>"object", "properties"=>{"answer"=>{"$ref"=>"#/components/schemas/LLMAnswer"}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "fields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"description"=>{"type"=>"string"}, "key"=>{"type"=>"string"}, "type"=>{"type"=>"string", "enum"=>["array|boolean", "array|number", "array|string", "boolean", "number", "string"]}, "values"=>{"type"=>"array", "items"=>{"type"=>"string"}}}, "required"=>["key", "type"]}}, "job"=>{"type"=>"string", "enum"=>["ask-list"]}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "question"=>{"type"=>"string"}}, "required"=>["answer", "fields", "job", "question"]}, "listId"=>{"type"=>"number"}, "promptId"=>{"type"=>"number"}, "status"=>{"type"=>"string", "enum"=>["pending"]}, "type"=>{"type"=>"string", "enum"=>["jobs:request"]}}, "required"=>["promptId", "status", "type"]}, "answer"=>{"type"=>"object", "properties"=>{"explanation"=>{"type"=>"string"}, "output"=>{"type"=>"object", "additionalProperties"=>{}}, "score"=>{"type"=>"number"}}, "required"=>["output", "score"]}}}}, "required"=>["response"]}], "description"=>"A natural language request made to the platform resolving to a specific action or search segment."}}, "required"=>["meta", "prompt"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompanyContext"=>{"path"=>"/v2/companies/{domain}/context", "method"=>"GET", "path_params"=>["domain"], "summary"=>"", "description"=>"Get the full context of a company by its domain.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"domain", "in"=>"path"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get the full context of a company by its domain.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"context"=>{"type"=>"object", "properties"=>{"company"=>{"$ref"=>"#/components/schemas/CompanyV2"}, "domain"=>{"type"=>"string"}, "ideated"=>{"$ref"=>"#/components/schemas/PageContentsIdeated"}, "sources"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/PageContentsPage"}}}, "required"=>["domain"]}, "meta"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number"}, "tokens"=>{"type"=>"number"}}, "required"=>["cost", "tokens"]}}, "required"=>["meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompaniesAnalytics"=>{"path"=>"/v2/companies/analytics", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Fetch analytics data for search segmentations and lists.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"actionId", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.tld", "finances.revenue", "finances.stockExchange", "locations.headquarters.city.code", "locations.headquarters.continent.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "technologies.categories"]}, "required"=>true, "name"=>"attribute", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"listId", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "required"=>false, "name"=>"query", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>10000}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sort", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Fetch analytics data for search segmentations and lists.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"data"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"count"=>{"type"=>"number"}, "name"=>{"type"=>"string"}, "percentageOfAll"=>{"type"=>"number"}, "percentageOfTotal"=>{"type"=>"number"}}, "required"=>["count", "name", "percentageOfAll", "percentageOfTotal"]}}, "meta"=>{"type"=>"object", "properties"=>{"listId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "totalDatapoints"=>{"type"=>"number"}, "totalDocuments"=>{"type"=>"number"}, "totalValues"=>{"type"=>"number"}}, "required"=>["query", "totalDatapoints", "totalDocuments", "totalValues"]}}, "required"=>["data", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "exportCompaniesAnalytics"=>{"path"=>"/v2/companies/analytics/export", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Export analytics data for search segmentations and lists.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actionId"=>{"type"=>"number"}, "attributes"=>{"type"=>"array", "items"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.tld", "finances.revenue", "finances.stockExchange", "locations.headquarters.city.code", "locations.headquarters.continent.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "technologies.categories"]}}, "format"=>{"type"=>"string", "enum"=>["csv", "json", "txt", "xls", "xml"]}, "full"=>{"type"=>"boolean"}, "listId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "size"=>{"type"=>"number", "minimum"=>1, "maximum"=>10000}, "sort"=>{"type"=>"string", "enum"=>["asc", "desc"]}}}}}}, "responses"=>{"200"=>{"description"=>"Export analytics data for search segmentations and lists.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"data"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"count"=>{"type"=>"number"}, "name"=>{"type"=>"string"}, "percentageOfAll"=>{"type"=>"number"}, "percentageOfTotal"=>{"type"=>"number"}}, "required"=>["count", "name", "percentageOfAll", "percentageOfTotal"]}}, "meta"=>{"type"=>"object", "properties"=>{"listId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "totalDatapoints"=>{"type"=>"number"}, "totalDocuments"=>{"type"=>"number"}, "totalValues"=>{"type"=>"number"}}, "required"=>["query", "totalDatapoints", "totalDocuments", "totalValues"]}}, "required"=>["data", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchIndustries"=>{"path"=>"/v2/industries", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search industries.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search industries.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"industries"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"companiesCount"=>{"type"=>["number", "null"]}, "name"=>{"type"=>"string"}, "slug"=>{}}, "required"=>["companiesCount", "name"]}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["industries", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchIndustriesSimilar"=>{"path"=>"/v2/industries/similar", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get similar industries from one or many industries.", "parameters"=>[{"schema"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "required"=>true, "name"=>"industries", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get similar industries from one or many industries.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"industries"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"companiesCount"=>{"type"=>["number", "null"]}, "name"=>{"type"=>"string"}, "slug"=>{}}, "required"=>["companiesCount", "name"]}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["industries", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchTechnologies"=>{"path"=>"/v2/technologies", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search technologies.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search technologies.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "technologies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/Technology"}}}, "required"=>["meta", "technologies"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCities"=>{"path"=>"/v2/locations/cities", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search cities.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"filters", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>20}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["counts.companies"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search cities.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"cities"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/NominatimCity"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["cities", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCounties"=>{"path"=>"/v2/locations/counties", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search counties.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>20}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["counts.companies"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search counties.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"counties"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/NominatimCounty"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["counties", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchCountries"=>{"path"=>"/v2/locations/countries", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search countries.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"filters", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>20}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["counts.companies"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search countries.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"countries"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/NominatimCountry"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["countries", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchStates"=>{"path"=>"/v2/locations/states", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search states.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>20}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["counts.companies"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search states.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "states"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/NominatimState"}}}, "required"=>["meta", "states"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "searchContinents"=>{"path"=>"/v2/locations/continents", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Search continents.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>20}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["counts.companies"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Search continents.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"continents"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/NominatimContinent"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["continents", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "enrichJobTitles"=>{"path"=>"/v2/job-titles/enrich", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Enrich job titles.", "parameters"=>[{"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"name", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Enrich job titles.", "content"=>{"application/json"=>{"schema"=>{"anyOf"=>[{"$ref"=>"#/components/schemas/JobTitle"}, {"type"=>"object", "additionalProperties"=>{}}]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchLists"=>{"path"=>"/v2/lists", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get and filter your lists.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>500}, "required"=>false, "name"=>"size", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get and filter your lists.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"lists"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/List"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}}, "required"=>["lists", "meta"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "createList"=>{"path"=>"/v2/lists", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Create a new list.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"dynamic"=>{"type"=>"boolean"}, "imported"=>{"type"=>"boolean"}, "mailFrequency"=>{"type"=>"string", "enum"=>["disabled", "daily", "weekly", "monthly"]}, "maxCompanies"=>{"type"=>"number"}, "name"=>{"type"=>"string", "maxLength"=>255}, "processInitialized"=>{"type"=>"boolean"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "similarDomains"=>{"type"=>"array", "items"=>{"type"=>"string"}}}, "required"=>["name"]}}}}, "responses"=>{"200"=>{"description"=>"Create a new list.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/List"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "updateList"=>{"path"=>"/v2/lists/{listId}", "method"=>"PATCH", "path_params"=>["listId"], "summary"=>"", "description"=>"Update a list.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"dynamic"=>{"type"=>"boolean"}, "lastSeen"=>{"type"=>"boolean"}, "mailFrequency"=>{"type"=>"string", "enum"=>["disabled", "daily", "weekly", "monthly"]}, "maxCompanies"=>{"type"=>["number", "null"], "minimum"=>0, "maximum"=>1000000}, "name"=>{"type"=>"string", "maxLength"=>255}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "resync"=>{"type"=>"boolean"}}}}}}, "responses"=>{"200"=>{"description"=>"Update a list.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/List"}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "deleteList"=>{"path"=>"/v2/lists/{listId}", "method"=>"DELETE", "path_params"=>["listId"], "summary"=>"", "description"=>"Delete a list.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Delete a list.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/List"}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompaniesInList"=>{"path"=>"/v2/lists/{listId}/companies", "method"=>"GET", "path_params"=>["listId"], "summary"=>"", "description"=>"Get companies in a list with a segmentation query.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"actionId", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "required"=>false, "name"=>"query", "in"=>"query"}, {"schema"=>{"type"=>"boolean"}, "required"=>false, "name"=>"simplified", "in"=>"query"}, {"schema"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "required"=>false, "name"=>"size", "in"=>"query"}, {"schema"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "required"=>false, "name"=>"sortFields", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "required"=>false, "name"=>"sortKey", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["asc", "desc"]}, "required"=>false, "name"=>"sortOrder", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get companies in a list with a segmentation query.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["companies", "meta"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompaniesInListPost"=>{"path"=>"/v2/lists/{listId}/companies", "method"=>"POST", "path_params"=>["listId"], "summary"=>"", "description"=>"Get companies in a list with a segmentation body.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"actionId"=>{"type"=>"number"}, "page"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "simplified"=>{"type"=>"boolean"}, "size"=>{"type"=>"number", "minimum"=>1, "maximum"=>100}, "sortFields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"key"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "missing"=>{"type"=>"string", "enum"=>["_first", "_last"]}, "order"=>{"type"=>"string", "enum"=>["asc", "desc"]}}, "required"=>["key", "order"]}}, "sortKey"=>{"type"=>"string", "enum"=>["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "locations.headquarters.city.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.score", "meta.syncedAt", "socials", "technologies.active", "urls"]}, "sortOrder"=>{"type"=>"string", "enum"=>["asc", "desc"]}}}}}}, "responses"=>{"200"=>{"description"=>"Get companies in a list with a segmentation body.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companies"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/CompanyV2"}}, "meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["companies", "meta"]}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchCompanyInList"=>{"path"=>"/v2/lists/{listId}/companies/{domain}", "method"=>"GET", "path_params"=>["listId", "domain"], "summary"=>"", "description"=>"Get a company in a list.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}, {"schema"=>{"type"=>"string"}, "required"=>true, "name"=>"domain", "in"=>"path"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get a company in a list.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/CompanyV2"}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "toggleCompaniesInList"=>{"path"=>"/v2/lists/{listId}/companies/toggle", "method"=>"PATCH", "path_params"=>["listId"], "summary"=>"", "description"=>"Toggle one or more companies in a list.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"listId", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"action"=>{"type"=>"string", "enum"=>["attach", "detach"]}, "companyIds"=>{"type"=>"array", "items"=>{"type"=>"number"}}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "refresh"=>{"type"=>"boolean"}}, "required"=>["action"]}}}}, "responses"=>{"200"=>{"description"=>"Toggle one or more companies in a list.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/List"}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["listNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["companyNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchTeam"=>{"path"=>"/v2/teams/{teamId}", "method"=>"GET", "path_params"=>["teamId"], "summary"=>"", "description"=>"Get team information.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"teamId", "in"=>"path"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get team information.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/Team"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userNotInTeam"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["teamNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "updateTeam"=>{"path"=>"/v2/teams/{teamId}", "method"=>"PATCH", "path_params"=>["teamId"], "summary"=>"", "description"=>"Update a team.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"teamId", "in"=>"path"}], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"country"=>{"type"=>"string", "maxLength"=>255}, "name"=>{"type"=>"string", "maxLength"=>255}, "websiteUrl"=>{"type"=>"string", "maxLength"=>255}}}}}}, "responses"=>{"200"=>{"description"=>"Update a team.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/Team"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userNotInTeam"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "404"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["teamNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchUser"=>{"path"=>"/v2/user", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Get current user information.", "parameters"=>[], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Get current user information.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/User"}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "fetchPrompts"=>{"path"=>"/v2/prompts", "method"=>"GET", "path_params"=>[], "summary"=>"", "description"=>"Fetch prompts history.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"companyId", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["analytics", "api", "companies", "company", "documentation", "enrichment", "landing", "list", "similarity"]}, "required"=>false, "name"=>"context", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["ask", "cleanup", "enrich", "product", "search", "similar"]}, "required"=>false, "name"=>"feature", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"limit", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"listId", "in"=>"query"}, {"schema"=>{"type"=>"string", "enum"=>["small", "large"]}, "required"=>false, "name"=>"model", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"page", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"prompt", "in"=>"query"}, {"schema"=>{"type"=>"string"}, "required"=>false, "name"=>"search", "in"=>"query"}, {"schema"=>{"type"=>"number"}, "required"=>false, "name"=>"size", "in"=>"query"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Fetch prompts history.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "prompts"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/Prompt"}}}, "required"=>["meta", "prompts"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "deletePrompt"=>{"path"=>"/v2/prompts/{promptId}", "method"=>"DELETE", "path_params"=>["promptId"], "summary"=>"", "description"=>"Delete a prompt.", "parameters"=>[{"schema"=>{"type"=>"number"}, "required"=>true, "name"=>"promptId", "in"=>"path"}], "request_body"=>nil, "responses"=>{"200"=>{"description"=>"Delete a prompt.", "content"=>{"application/json"=>{"schema"=>{"$ref"=>"#/components/schemas/Prompt"}}}}, "400"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["promptNotFound"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["userCurrentTeamIsNotInstanceOwner"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "productPrompt"=>{"path"=>"/v2/prompts/product", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Query the product prompt.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"companyId"=>{"type"=>"number"}, "context"=>{"type"=>"string", "enum"=>["analytics", "api", "companies", "company", "documentation", "enrichment", "landing", "list", "similarity"]}, "feature"=>{"type"=>"string", "enum"=>["ask", "cleanup", "enrich", "product", "search", "similar"]}, "force"=>{"type"=>"boolean"}, "listId"=>{"type"=>"number"}, "model"=>{"type"=>"string", "enum"=>["small", "large"]}, "prompt"=>{"type"=>"string"}}, "required"=>["prompt"]}}}}, "responses"=>{"200"=>{"description"=>"Query the product prompt.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "prompt"=>{"$ref"=>"#/components/schemas/Prompt"}, "response"=>{"anyOf"=>[{"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "action"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number"}, "data"=>{"type"=>"object", "properties"=>{"answer"=>{"$ref"=>"#/components/schemas/LLMAnswer"}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "fields"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"description"=>{"type"=>"string"}, "key"=>{"type"=>"string"}, "type"=>{"type"=>"string", "enum"=>["array|boolean", "array|number", "array|string", "boolean", "number", "string"]}, "values"=>{"type"=>"array", "items"=>{"type"=>"string"}}}, "required"=>["key", "type"]}}, "job"=>{"type"=>"string", "enum"=>["ask-list"]}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}, "question"=>{"type"=>"string"}}, "required"=>["answer", "fields", "job", "question"]}, "listId"=>{"type"=>"number"}, "promptId"=>{"type"=>"number"}, "status"=>{"type"=>"string", "enum"=>["pending"]}, "type"=>{"type"=>"string", "enum"=>["jobs:request"]}}, "required"=>["promptId", "status", "type"]}, "answer"=>{"type"=>"object", "properties"=>{"explanation"=>{"type"=>"string"}, "output"=>{"type"=>"object", "additionalProperties"=>{}}, "score"=>{"type"=>"number"}}, "required"=>["output", "score"]}}}, {"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "action"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number", "enum"=>[0]}, "data"=>{"type"=>"object", "properties"=>{"domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "job"=>{"type"=>"string", "enum"=>["cleanup-list"]}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["job"]}, "listId"=>{"type"=>"number"}, "promptId"=>{"type"=>"number"}, "status"=>{"type"=>"string", "enum"=>["pending"]}, "type"=>{"type"=>"string", "enum"=>["jobs:request"]}}, "required"=>["promptId", "status", "type"]}}}, {"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "action"=>{"type"=>"object", "properties"=>{"cost"=>{"type"=>"number"}, "data"=>{"type"=>"object", "properties"=>{"domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "job"=>{"type"=>"string", "enum"=>["enrich-companies", "enrich-list"]}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}, "required"=>["job"]}, "listId"=>{"type"=>"number"}, "promptId"=>{"type"=>"number"}, "status"=>{"type"=>"string", "enum"=>["pending"]}, "type"=>{"type"=>"string", "enum"=>["jobs:request"]}}, "required"=>["data", "promptId", "status", "type"]}}}, {"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "listId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}}, {"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}}}]}}, "required"=>["meta", "prompt", "response"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}, "403"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["noCreditsRemaining"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}, "promptToSegmentation"=>{"path"=>"/v2/prompts/segmentation", "method"=>"POST", "path_params"=>[], "summary"=>"", "description"=>"Convert a query to a segmentation.", "parameters"=>[], "request_body"=>{"content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"context"=>{"type"=>"string", "enum"=>["analytics", "api", "companies", "company", "documentation", "enrichment", "landing", "list", "similarity"]}, "force"=>{"type"=>"boolean"}, "listId"=>{"type"=>"number"}, "model"=>{"type"=>"string", "enum"=>["small", "large"]}, "prompt"=>{"type"=>"string"}}, "required"=>["prompt"]}}}}, "responses"=>{"200"=>{"description"=>"Convert a query to a segmentation.", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"meta"=>{"$ref"=>"#/components/schemas/PaginationMeta"}, "prompt"=>{"$ref"=>"#/components/schemas/Prompt"}, "response"=>{"type"=>"object", "properties"=>{"all"=>{"type"=>"boolean"}, "cost"=>{"type"=>"number"}, "count"=>{"type"=>"number"}, "domain"=>{"type"=>"string"}, "error"=>{"type"=>"string"}, "domains"=>{"type"=>"array", "items"=>{"type"=>"string"}}, "listId"=>{"type"=>"number"}, "query"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/SegmentationCondition"}}}}}, "required"=>["meta", "prompt", "response"]}}}}, "401"=>{"description"=>"The error message", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "properties"=>{"details"=>{}, "messages"=>{"type"=>"string", "enum"=>["tokenNotFound", "invalidApiSecret", "missingApiSecret", "userNotAuthenticated"]}, "status"=>{"type"=>"number", "minimum"=>400, "maximum"=>511}}, "required"=>["messages", "status"]}}}}}}}