thecompaniesapi

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2025 License: MIT Imports: 16 Imported by: 0

README

The Companies API SDK for Go

A fully-featured Go SDK for The Companies API, providing type-safe access to company data, locations, industries, technologies, job titles, lists, and more.

If you need more details about a specific endpoint, you can find the corresponding documentation in the API reference.

You can also contact us on our livechat if you have any questions.

🚀 Features

  • Expose all our 30+ endpoints and gives access to 50M+ companies from your codebase
  • Type-safe API client with full access to our OpenAPI schemas
  • Real-time company enrichment with both synchronous and asynchronous options
  • Powerful search capabilities with filters, sorting and pagination
  • Create and manage your company lists
  • Track and monitor enrichment actions and requests
  • Generate detailed analytics and insights for searches and lists
  • Natural language querying for structured company information
  • Lightweight with minimal dependencies

📦 Installation

go get github.com/thecompaniesapi/sdk-go

🔑 Prerequisites

🚀 Quick Start

package main

import (
    "context"
    "fmt"
    "log"
    
    tca "github.com/thecompaniesapi/sdk-go"
)

func main() {
    // Initialize the client
    client, err := tca.ApiClient("your-api-key-here")
    if err != nil {
        log.Fatal(err)
    }
    
    // Search for technology companies
    page := float32(1)
    size := float32(10)
    search := "technology"
    
    response, err := client.SearchCompanies(context.Background(), &tca.SearchCompaniesParams{
        Page:   &page,
        Size:   &size,
        Search: &search,
    })
    if err != nil {
        log.Fatal(err)
    }
    
    if response.JSON200 != nil {
        fmt.Printf("Found %d companies\n", response.JSON200.Meta.Total)
        for _, company := range response.JSON200.Companies {
            if company.About != nil && company.About.Name != nil {
                fmt.Printf("- %s\n", *company.About.Name)
            }
        }
    }
}

🏢 Companies

Search companies

📖 Documentation

// Search companies with basic filters
page := float32(1)
size := float32(10)
search := "artificial intelligence"

response, err := client.SearchCompanies(ctx, &tca.SearchCompaniesParams{
    Page:   &page,
    Size:   &size,
    Search: &search,
})

companies := response.JSON200.Companies // Companies that match the search
meta := response.JSON200.Meta          // Meta information (pagination, etc.)
// Advanced search with complex query conditions
response, err := client.SearchCompaniesPost(ctx, tca.SearchCompaniesPostJSONRequestBody{
    Query: &[]tca.QueryCondition{
        {
            Attribute: "about.industries",
            Operator:  "or",
            Sign:      "equals",
            Values:    []string{"artificial-intelligence", "machine-learning"},
        },
        {
            Attribute: "locations.headquarters.country.code",
            Operator:  "and",
            Sign:      "equals",
            Values:    []string{"us"},
        },
    },
    Page: tca.Float32Ptr(1),
    Size: tca.Float32Ptr(20),
})

companies := response.JSON200.Companies // Companies matching the query
meta := response.JSON200.Meta          // Meta information
Search companies by name

📖 Documentation

// Search companies by their name
name := "microsoft"
response, err := client.SearchCompaniesByName(ctx, &tca.SearchCompaniesByNameParams{
    Name: &name,
})

companies := response.JSON200.Companies // Companies with matching names
Search companies by prompt

📖 Documentation

// Use natural language to find companies
prompt := "Find me SaaS companies in San Francisco with more than 100 employees"
response, err := client.SearchCompaniesByPrompt(ctx, &tca.SearchCompaniesByPromptParams{
    Prompt: &prompt,
})

companies := response.JSON200.Companies // Companies matching the prompt
Find similar companies

📖 Documentation

// Find companies similar to given domains
domains := "apple.com,microsoft.com"
response, err := client.SearchSimilarCompanies(ctx, &tca.SearchSimilarCompaniesParams{
    Domains: &domains,
})

companies := response.JSON200.Companies // Similar companies
Count companies matching your query

📖 Documentation

// Count how many companies are in the computer-software industry
response, err := client.CountCompaniesPost(ctx, tca.CountCompaniesPostJSONRequestBody{
    Query: &[]tca.QueryCondition{
        {
            Attribute: "about.industries",
            Operator:  "or",
            Sign:      "equals",
            Values:    []string{"computer-software"},
        },
    },
})

count := response.JSON200 // Number of companies that match the query
Enrich a company from a domain name

📖 Documentation

// Fetch company data from our database without enrichment (faster response)
response, err := client.FetchCompany(ctx, "microsoft.com", &tca.FetchCompanyParams{})

company := response.JSON200 // The company profile
// Fetch company data and re-analyze it in real-time to get fresh, up-to-date information
refresh := true
response, err := client.FetchCompany(ctx, "microsoft.com", &tca.FetchCompanyParams{
    Refresh: &refresh,
})

company := response.JSON200 // The company profile (refreshed)
Enrich a company from an email

📖 Documentation

🕹️ Enrich your users at signup with the latest information about their company

// Fetch the company profile behind a professional email address
email := "jack@openai.com"
response, err := client.FetchCompanyByEmail(ctx, &tca.FetchCompanyByEmailParams{
    Email: &email,
})

company := response.JSON200 // The company profile
Enrich a company from a social network URL

📖 Documentation

// Fetch the company profile behind a social network URL
linkedin := "https://www.linkedin.com/company/apple"
response, err := client.FetchCompanyBySocial(ctx, &tca.FetchCompanyBySocialParams{
    Linkedin: &linkedin,
})

company := response.JSON200 // The company profile
Find a company email patterns

📖 Documentation

// Fetch the company email patterns for a specific domain
response, err := client.FetchCompanyEmailPatterns(ctx, "apple.com", &tca.FetchCompanyEmailPatternsParams{})

patterns := response.JSON200 // The company email patterns
Ask a question about a company

📖 Documentation

// Ask what products a company offers using its domain
response, err := client.AskCompany(ctx, "microsoft.com", tca.AskCompanyJSONRequestBody{
    Question: "What products does this company offer?",
    Model:    tca.StringPtr("large"), // 'small' is also available
    Fields: &[]tca.QuestionField{
        {
            Key:         "products",
            Type:        "array|string",
            Description: tca.StringPtr("The products that the company offers"),
        },
    },
})

answer := response.JSON200.Answer // Structured AI response
meta := response.JSON200.Meta     // Meta information
Fetch the context of a company

📖 Documentation

// Get AI-generated strategic insights about a company
response, err := client.FetchCompanyContext(ctx, "microsoft.com")

context := response.JSON200.Context // Includes market, model, differentiators, etc.
meta := response.JSON200.Meta       // Meta information
Fetch analytics data for a query or your lists

📖 Documentation

// Analyze company distribution by business type
attribute := "about.businessType"
response, err := client.FetchCompaniesAnalytics(ctx, &tca.FetchCompaniesAnalyticsParams{
    Attribute: &attribute,
    Query: &[]tca.QueryCondition{
        {
            Attribute: "locations.headquarters.country.code",
            Operator:  "or",
            Sign:      "equals",
            Values:    []string{"us", "gb", "fr"},
        },
    },
})

analytics := response.JSON200 // Aggregated values
meta := response.JSON200.Meta      // Meta information

📖 Documentation

// Export analytics to CSV
response, err := client.ExportCompaniesAnalytics(ctx, tca.ExportCompaniesAnalyticsJSONRequestBody{
    Format:     "csv",
    Attributes: []string{"about.industries", "about.totalEmployees"},
    Query: &[]tca.QueryCondition{
        {
            Attribute: "technologies.active",
            Operator:  "or",
            Sign:      "equals",
            Values:    []string{"shopify"},
        },
    },
})

analytics := response.JSON200 // Aggregated values
meta := response.JSON200.Meta      // Meta information

🎯 Actions

Request an action on one or more companies

📖 Documentation

// Request an enrichment job on multiple companies
estimate := false
response, err := client.RequestAction(ctx, tca.RequestActionJSONRequestBody{
    Domains:  []string{"microsoft.com", "apple.com"},
    Job:      "enrich-companies",
    Estimate: &estimate,
})

actions := response.JSON200.Actions // Track this via FetchActions
meta := response.JSON200.Meta       // Meta information
Fetch the actions for your actions

📖 Documentation

// Fetch recent actions
status := "completed"
page := float32(1)
size := float32(5)

response, err := client.FetchActions(ctx, &tca.FetchActionsParams{
    Status: &status,
    Page:   &page,
    Size:   &size,
})

actions := response.JSON200.Actions // Actions that match the query
meta := response.JSON200.Meta       // Meta information

🏭 Industries

Search industries

📖 Documentation

// Search industries by keyword
search := "software"
size := float32(10)

response, err := client.SearchIndustries(ctx, &tca.SearchIndustriesParams{
    Search: &search,
    Size:   &size,
})

industries := response.JSON200.Industries // Industries that match the keyword
meta := response.JSON200.Meta             // Meta information
Find similar industries

📖 Documentation

// Find industries similar to given ones
industries := "saas,fintech"
response, err := client.SearchIndustriesSimilar(ctx, &tca.SearchIndustriesSimilarParams{
    Industries: &industries,
})

similar := response.JSON200.Industries // Industries that are similar to the given ones
meta := response.JSON200.Meta          // Meta information

⚛️ Technologies

Search technologies

📖 Documentation

// Search technologies by keyword
search := "shopify"
size := float32(10)

response, err := client.SearchTechnologies(ctx, &tca.SearchTechnologiesParams{
    Search: &search,
    Size:   &size,
})

technologies := response.JSON200.Technologies // Technologies that match the keyword
meta := response.JSON200.Meta                 // Meta information

🌍 Locations

Search cities

📖 Documentation

// Search cities by name
search := "new york"
size := float32(5)

response, err := client.SearchCities(ctx, &tca.SearchCitiesParams{
    Search: &search,
    Size:   &size,
})

cities := response.JSON200.Cities // Cities that match the name
meta := response.JSON200.Meta     // Meta information
Search counties

📖 Documentation

// Search counties by name
search := "orange"
size := float32(5)

response, err := client.SearchCounties(ctx, &tca.SearchCountiesParams{
    Search: &search,
    Size:   &size,
})

counties := response.JSON200.Counties // Counties that match the name
meta := response.JSON200.Meta         // Meta information
Search states

📖 Documentation

// Search states by name
search := "california"
size := float32(5)

response, err := client.SearchStates(ctx, &tca.SearchStatesParams{
    Search: &search,
    Size:   &size,
})

states := response.JSON200.States // States that match the name
meta := response.JSON200.Meta     // Meta information
Search countries

📖 Documentation

// Search countries by name
search := "france"
size := float32(5)

response, err := client.SearchCountries(ctx, &tca.SearchCountriesParams{
    Search: &search,
    Size:   &size,
})

countries := response.JSON200.Countries // Countries that match the name
meta := response.JSON200.Meta           // Meta information
Search continents

📖 Documentation

// Search continents by name
search := "asia"
size := float32(5)

response, err := client.SearchContinents(ctx, &tca.SearchContinentsParams{
    Search: &search,
    Size:   &size,
})

continents := response.JSON200.Continents // Continents that match the name
meta := response.JSON200.Meta             // Meta information

💼 Job titles

Enrich a job title from its name

📖 Documentation

// Enrich "chief marketing officer"
name := "chief marketing officer"
response, err := client.EnrichJobTitles(ctx, &tca.EnrichJobTitlesParams{
    Name: &name,
})

jobTitle := response.JSON200 // Contains department, seniority, etc.

📋 Lists

Fetch your lists

📖 Documentation

// Fetch your lists
response, err := client.FetchLists(ctx, &tca.FetchListsParams{})

lists := response.JSON200.Lists // Lists that match the query
meta := response.JSON200.Meta   // Meta information
Create a list of companies

📖 Documentation

// Create a list of companies
response, err := client.CreateList(ctx, tca.CreateListJSONRequestBody{
    Name: "My SaaS List",
    Type: "companies",
})

newList := response.JSON200 // The new list
Fetch companies in your list

📖 Documentation

// Fetch companies in a list
listId := float32(1234)
response, err := client.FetchCompaniesInList(ctx, listId, &tca.FetchCompaniesInListParams{})

companies := response.JSON200.Companies // Companies that match the list
meta := response.JSON200.Meta           // Meta information
Add or remove companies in your list

📖 Documentation

// Add companies to a list
listId := float32(1234)
response, err := client.ToggleCompaniesInList(ctx, listId, tca.ToggleCompaniesInListJSONRequestBody{
    Companies: []string{"apple.com", "stripe.com"},
})

list := response.JSON200 // The updated list

👥 Teams

Fetch your team

📖 Documentation

// Fetch your team details
teamId := float32(1234)
response, err := client.FetchTeam(ctx, teamId)

team := response.JSON200 // Your team details

🔧 Utilities

Fetch the health of the API

📖 Documentation

// Check API health status
response, err := client.FetchApiHealth(ctx)

health := response.JSON200 // The health of the API
Fetch the OpenAPI schema

📖 Documentation

// Fetch OpenAPI schema
response, err := client.FetchOpenApi(ctx)

schema := response.JSON200 // The OpenAPI schema

📄 License

This SDK is released under the MIT License. See LICENSE for details.

Documentation

Overview

Package thecompaniesapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.

Example (BasicUsage)

Example_basicUsage demonstrates basic SDK usage

package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/thecompaniesapi/sdk-go"
)

// Example_basicUsage demonstrates basic SDK usage
func main() {
	// Initialize client
	client, err := thecompaniesapi.ApiClient("your-api-key",
		thecompaniesapi.WithVisitorID("demo-visitor-123"), // Analytics tracking
		thecompaniesapi.WithTimeout(60*time.Second),       // Custom timeout
	)
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	ctx := context.Background()

	// Example 1: Search companies with complex query
	searchExample(ctx, client)

	// Example 2: Count companies
	countExample(ctx, client)

	// Example 3: Fetch company by email
	emailExample(ctx, client)
}

func searchExample(ctx context.Context, client *thecompaniesapi.CompaniesAPIClient) {
	// Complex search with generated types
	page := float32(1)
	size := float32(25)
	search := "technology"
	simplified := true

	// Generate query conditions using generated types
	var techValueItem thecompaniesapi.SegmentationCondition_Values_Item
	err := techValueItem.FromSegmentationConditionValues0("technology")
	if err != nil {
		log.Printf("Failed to create tech union value: %v", err)
		return
	}

	var employeeValueItem thecompaniesapi.SegmentationCondition_Values_Item
	err = employeeValueItem.FromSegmentationConditionValues1(float32(100))
	if err != nil {
		log.Printf("Failed to create employee union value: %v", err)
		return
	}

	query := []thecompaniesapi.SegmentationCondition{
		{
			Attribute: thecompaniesapi.SegmentationConditionAttributeAboutIndustries,
			Operator:  thecompaniesapi.Or, // Add required operator field
			Sign:      thecompaniesapi.Equals,
			Values: []thecompaniesapi.SegmentationCondition_Values_Item{
				techValueItem,
			},
		},
		{
			Attribute: thecompaniesapi.SegmentationConditionAttributeAboutTotalEmployees,
			Operator:  thecompaniesapi.And, // Add required operator field
			Sign:      thecompaniesapi.Greater,
			Values: []thecompaniesapi.SegmentationCondition_Values_Item{
				employeeValueItem,
			},
		},
	}

	searchFields := []thecompaniesapi.SearchCompaniesParamsSearchFields{
		"about.name",
		"domain.domain",
	}

	params := &thecompaniesapi.SearchCompaniesParams{
		Page:         &page,
		Size:         &size,
		Search:       &search,
		Simplified:   &simplified,
		Query:        &query,
		SearchFields: &searchFields,
	}

	// Call with sophisticated query serialization
	response, err := client.SearchCompanies(ctx, params)
	if err != nil {
		log.Printf("Search failed: %v", err)
		return
	}

	// Use generated response types
	if response.JSON200 != nil {
		fmt.Printf("Found %f companies\n", response.JSON200.Meta.Total)

		for _, company := range response.JSON200.Companies {
			if company.About != nil && company.About.Name != nil {
				fmt.Printf("- %s", *company.About.Name)
				if company.Domain != nil {
					fmt.Printf(" (%s)", company.Domain.Domain)
				}
				fmt.Println()
			}
		}
	}
}

func countExample(ctx context.Context, client *thecompaniesapi.CompaniesAPIClient) {
	search := "saas"
	params := &thecompaniesapi.CountCompaniesParams{
		Search: &search,
	}

	response, err := client.CountCompanies(ctx, params)
	if err != nil {
		log.Printf("Count failed: %v", err)
		return
	}

	if response.JSON200 != nil {
		fmt.Printf("Total SaaS companies: %f\n", response.JSON200.Count)
	}
}

func emailExample(ctx context.Context, client *thecompaniesapi.CompaniesAPIClient) {
	params := &thecompaniesapi.FetchCompanyByEmailParams{
		Email: "contact@openai.com",
	}

	response, err := client.FetchCompanyByEmail(ctx, params)
	if err != nil {
		log.Printf("Email lookup failed: %v", err)
		return
	}

	if response.JSON200 != nil && response.JSON200.Company.About != nil {
		if response.JSON200.Company.About.Name != nil {
			fmt.Printf("Company from email: %s\n", *response.JSON200.Company.About.Name)
		}
	}
}

Index

Examples

Constants

View Source
const (
	// DefaultBaseURL is the default base URL for The Companies API
	DefaultBaseURL = "https://api.thecompaniesapi.com"
	// DefaultTimeout is the default timeout for HTTP requests
	DefaultTimeout = 300 * time.Second
)
View Source
const (
	ApiKeyScopes = "apiKey.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewAskCompanyRequest

func NewAskCompanyRequest(server string, domain string, body AskCompanyJSONRequestBody) (*http.Request, error)

NewAskCompanyRequest calls the generic AskCompany builder with application/json body

func NewAskCompanyRequestWithBody

func NewAskCompanyRequestWithBody(server string, domain string, contentType string, body io.Reader) (*http.Request, error)

NewAskCompanyRequestWithBody generates requests for AskCompany with any type of body

func NewCountCompaniesPostRequest

func NewCountCompaniesPostRequest(server string, body CountCompaniesPostJSONRequestBody) (*http.Request, error)

NewCountCompaniesPostRequest calls the generic CountCompaniesPost builder with application/json body

func NewCountCompaniesPostRequestWithBody

func NewCountCompaniesPostRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCountCompaniesPostRequestWithBody generates requests for CountCompaniesPost with any type of body

func NewCountCompaniesRequest

func NewCountCompaniesRequest(server string, params *CountCompaniesParams) (*http.Request, error)

NewCountCompaniesRequest generates requests for CountCompanies

func NewCreateListRequest

func NewCreateListRequest(server string, body CreateListJSONRequestBody) (*http.Request, error)

NewCreateListRequest calls the generic CreateList builder with application/json body

func NewCreateListRequestWithBody

func NewCreateListRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateListRequestWithBody generates requests for CreateList with any type of body

func NewDeleteListRequest

func NewDeleteListRequest(server string, listId float32) (*http.Request, error)

NewDeleteListRequest generates requests for DeleteList

func NewDeletePromptRequest

func NewDeletePromptRequest(server string, promptId float32) (*http.Request, error)

NewDeletePromptRequest generates requests for DeletePrompt

func NewEnrichJobTitlesRequest

func NewEnrichJobTitlesRequest(server string, params *EnrichJobTitlesParams) (*http.Request, error)

NewEnrichJobTitlesRequest generates requests for EnrichJobTitles

func NewExportCompaniesAnalyticsRequest

func NewExportCompaniesAnalyticsRequest(server string, body ExportCompaniesAnalyticsJSONRequestBody) (*http.Request, error)

NewExportCompaniesAnalyticsRequest calls the generic ExportCompaniesAnalytics builder with application/json body

func NewExportCompaniesAnalyticsRequestWithBody

func NewExportCompaniesAnalyticsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExportCompaniesAnalyticsRequestWithBody generates requests for ExportCompaniesAnalytics with any type of body

func NewFetchActionsRequest

func NewFetchActionsRequest(server string, params *FetchActionsParams) (*http.Request, error)

NewFetchActionsRequest generates requests for FetchActions

func NewFetchApiHealthRequest

func NewFetchApiHealthRequest(server string) (*http.Request, error)

NewFetchApiHealthRequest generates requests for FetchApiHealth

func NewFetchCompaniesAnalyticsRequest

func NewFetchCompaniesAnalyticsRequest(server string, params *FetchCompaniesAnalyticsParams) (*http.Request, error)

NewFetchCompaniesAnalyticsRequest generates requests for FetchCompaniesAnalytics

func NewFetchCompaniesInListPostRequest

func NewFetchCompaniesInListPostRequest(server string, listId float32, body FetchCompaniesInListPostJSONRequestBody) (*http.Request, error)

NewFetchCompaniesInListPostRequest calls the generic FetchCompaniesInListPost builder with application/json body

func NewFetchCompaniesInListPostRequestWithBody

func NewFetchCompaniesInListPostRequestWithBody(server string, listId float32, contentType string, body io.Reader) (*http.Request, error)

NewFetchCompaniesInListPostRequestWithBody generates requests for FetchCompaniesInListPost with any type of body

func NewFetchCompaniesInListRequest

func NewFetchCompaniesInListRequest(server string, listId float32, params *FetchCompaniesInListParams) (*http.Request, error)

NewFetchCompaniesInListRequest generates requests for FetchCompaniesInList

func NewFetchCompanyByEmailRequest

func NewFetchCompanyByEmailRequest(server string, params *FetchCompanyByEmailParams) (*http.Request, error)

NewFetchCompanyByEmailRequest generates requests for FetchCompanyByEmail

func NewFetchCompanyBySocialRequest

func NewFetchCompanyBySocialRequest(server string, params *FetchCompanyBySocialParams) (*http.Request, error)

NewFetchCompanyBySocialRequest generates requests for FetchCompanyBySocial

func NewFetchCompanyContextRequest

func NewFetchCompanyContextRequest(server string, domain string) (*http.Request, error)

NewFetchCompanyContextRequest generates requests for FetchCompanyContext

func NewFetchCompanyEmailPatternsRequest

func NewFetchCompanyEmailPatternsRequest(server string, domain string, params *FetchCompanyEmailPatternsParams) (*http.Request, error)

NewFetchCompanyEmailPatternsRequest generates requests for FetchCompanyEmailPatterns

func NewFetchCompanyInListRequest

func NewFetchCompanyInListRequest(server string, listId float32, domain string) (*http.Request, error)

NewFetchCompanyInListRequest generates requests for FetchCompanyInList

func NewFetchCompanyRequest

func NewFetchCompanyRequest(server string, domain string, params *FetchCompanyParams) (*http.Request, error)

NewFetchCompanyRequest generates requests for FetchCompany

func NewFetchListsRequest

func NewFetchListsRequest(server string, params *FetchListsParams) (*http.Request, error)

NewFetchListsRequest generates requests for FetchLists

func NewFetchOpenApiRequest

func NewFetchOpenApiRequest(server string) (*http.Request, error)

NewFetchOpenApiRequest generates requests for FetchOpenApi

func NewFetchPromptsRequest

func NewFetchPromptsRequest(server string, params *FetchPromptsParams) (*http.Request, error)

NewFetchPromptsRequest generates requests for FetchPrompts

func NewFetchTeamRequest

func NewFetchTeamRequest(server string, teamId float32) (*http.Request, error)

NewFetchTeamRequest generates requests for FetchTeam

func NewFetchUserRequest

func NewFetchUserRequest(server string) (*http.Request, error)

NewFetchUserRequest generates requests for FetchUser

func NewProductPromptRequest

func NewProductPromptRequest(server string, body ProductPromptJSONRequestBody) (*http.Request, error)

NewProductPromptRequest calls the generic ProductPrompt builder with application/json body

func NewProductPromptRequestWithBody

func NewProductPromptRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewProductPromptRequestWithBody generates requests for ProductPrompt with any type of body

func NewPromptToSegmentationRequest

func NewPromptToSegmentationRequest(server string, body PromptToSegmentationJSONRequestBody) (*http.Request, error)

NewPromptToSegmentationRequest calls the generic PromptToSegmentation builder with application/json body

func NewPromptToSegmentationRequestWithBody

func NewPromptToSegmentationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPromptToSegmentationRequestWithBody generates requests for PromptToSegmentation with any type of body

func NewRequestActionRequest

func NewRequestActionRequest(server string, body RequestActionJSONRequestBody) (*http.Request, error)

NewRequestActionRequest calls the generic RequestAction builder with application/json body

func NewRequestActionRequestWithBody

func NewRequestActionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRequestActionRequestWithBody generates requests for RequestAction with any type of body

func NewRetryActionRequest

func NewRetryActionRequest(server string, actionId float32, body RetryActionJSONRequestBody) (*http.Request, error)

NewRetryActionRequest calls the generic RetryAction builder with application/json body

func NewRetryActionRequestWithBody

func NewRetryActionRequestWithBody(server string, actionId float32, contentType string, body io.Reader) (*http.Request, error)

NewRetryActionRequestWithBody generates requests for RetryAction with any type of body

func NewSearchCitiesRequest

func NewSearchCitiesRequest(server string, params *SearchCitiesParams) (*http.Request, error)

NewSearchCitiesRequest generates requests for SearchCities

func NewSearchCompaniesByNameRequest

func NewSearchCompaniesByNameRequest(server string, params *SearchCompaniesByNameParams) (*http.Request, error)

NewSearchCompaniesByNameRequest generates requests for SearchCompaniesByName

func NewSearchCompaniesByPromptRequest

func NewSearchCompaniesByPromptRequest(server string, params *SearchCompaniesByPromptParams) (*http.Request, error)

NewSearchCompaniesByPromptRequest generates requests for SearchCompaniesByPrompt

func NewSearchCompaniesPostRequest

func NewSearchCompaniesPostRequest(server string, body SearchCompaniesPostJSONRequestBody) (*http.Request, error)

NewSearchCompaniesPostRequest calls the generic SearchCompaniesPost builder with application/json body

func NewSearchCompaniesPostRequestWithBody

func NewSearchCompaniesPostRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchCompaniesPostRequestWithBody generates requests for SearchCompaniesPost with any type of body

func NewSearchCompaniesRequest

func NewSearchCompaniesRequest(server string, params *SearchCompaniesParams) (*http.Request, error)

NewSearchCompaniesRequest generates requests for SearchCompanies

func NewSearchContinentsRequest

func NewSearchContinentsRequest(server string, params *SearchContinentsParams) (*http.Request, error)

NewSearchContinentsRequest generates requests for SearchContinents

func NewSearchCountiesRequest

func NewSearchCountiesRequest(server string, params *SearchCountiesParams) (*http.Request, error)

NewSearchCountiesRequest generates requests for SearchCounties

func NewSearchCountriesRequest

func NewSearchCountriesRequest(server string, params *SearchCountriesParams) (*http.Request, error)

NewSearchCountriesRequest generates requests for SearchCountries

func NewSearchIndustriesRequest

func NewSearchIndustriesRequest(server string, params *SearchIndustriesParams) (*http.Request, error)

NewSearchIndustriesRequest generates requests for SearchIndustries

func NewSearchIndustriesSimilarRequest

func NewSearchIndustriesSimilarRequest(server string, params *SearchIndustriesSimilarParams) (*http.Request, error)

NewSearchIndustriesSimilarRequest generates requests for SearchIndustriesSimilar

func NewSearchSimilarCompaniesRequest

func NewSearchSimilarCompaniesRequest(server string, params *SearchSimilarCompaniesParams) (*http.Request, error)

NewSearchSimilarCompaniesRequest generates requests for SearchSimilarCompanies

func NewSearchStatesRequest

func NewSearchStatesRequest(server string, params *SearchStatesParams) (*http.Request, error)

NewSearchStatesRequest generates requests for SearchStates

func NewSearchTechnologiesRequest

func NewSearchTechnologiesRequest(server string, params *SearchTechnologiesParams) (*http.Request, error)

NewSearchTechnologiesRequest generates requests for SearchTechnologies

func NewToggleCompaniesInListRequest

func NewToggleCompaniesInListRequest(server string, listId float32, body ToggleCompaniesInListJSONRequestBody) (*http.Request, error)

NewToggleCompaniesInListRequest calls the generic ToggleCompaniesInList builder with application/json body

func NewToggleCompaniesInListRequestWithBody

func NewToggleCompaniesInListRequestWithBody(server string, listId float32, contentType string, body io.Reader) (*http.Request, error)

NewToggleCompaniesInListRequestWithBody generates requests for ToggleCompaniesInList with any type of body

func NewUpdateListRequest

func NewUpdateListRequest(server string, listId float32, body UpdateListJSONRequestBody) (*http.Request, error)

NewUpdateListRequest calls the generic UpdateList builder with application/json body

func NewUpdateListRequestWithBody

func NewUpdateListRequestWithBody(server string, listId float32, contentType string, body io.Reader) (*http.Request, error)

NewUpdateListRequestWithBody generates requests for UpdateList with any type of body

func NewUpdateTeamRequest

func NewUpdateTeamRequest(server string, teamId float32, body UpdateTeamJSONRequestBody) (*http.Request, error)

NewUpdateTeamRequest calls the generic UpdateTeam builder with application/json body

func NewUpdateTeamRequestWithBody

func NewUpdateTeamRequestWithBody(server string, teamId float32, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTeamRequestWithBody generates requests for UpdateTeam with any type of body

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type Action

type Action struct {
	Attempts  *float32 `json:"attempts,omitempty"`
	Cost      *float32 `json:"cost"`
	CreatedAt *string  `json:"createdAt"`
	Data      *struct {
		CleanedUp              *float32    `json:"cleanedUp,omitempty"`
		Completed              *[]string   `json:"completed,omitempty"`
		CompletedDomains       *float32    `json:"completedDomains,omitempty"`
		CompletedDomainsSample *[]string   `json:"completedDomainsSample,omitempty"`
		Count                  *float32    `json:"count,omitempty"`
		Domains                *[]string   `json:"domains,omitempty"`
		DomainsSample          *[]string   `json:"domainsSample,omitempty"`
		ElasticQuery           interface{} `json:"elasticQuery,omitempty"`
		Failed                 *[]string   `json:"failed,omitempty"`
		FailedDomains          *float32    `json:"failedDomains,omitempty"`
		FailedDomainsSample    *[]string   `json:"failedDomainsSample,omitempty"`
		Fields                 *[]struct {
			Description *string              `json:"description,omitempty"`
			Key         string               `json:"key"`
			Type        ActionDataFieldsType `json:"type"`
			Values      *[]string            `json:"values,omitempty"`
		} `json:"fields,omitempty"`
		Grounded *bool                    `json:"grounded,omitempty"`
		Job      *ActionDataJob           `json:"job,omitempty"`
		Model    *ActionDataModel         `json:"model,omitempty"`
		Query    *[]SegmentationCondition `json:"query,omitempty"`
		Question *string                  `json:"question,omitempty"`

		// Team A collection of users that can access the same resources.
		Team         *Team    `json:"team,omitempty"`
		TotalDomains *float32 `json:"totalDomains,omitempty"`

		// User A user of the platform.
		User *User `json:"user,omitempty"`
	} `json:"data,omitempty"`
	Id       float32  `json:"id"`
	ListId   *float32 `json:"listId,omitempty"`
	PromptId *float32 `json:"promptId,omitempty"`
	Result   *struct {
		Answers   *[]LLMAnswer `json:"answers,omitempty"`
		CleanedUp *float32     `json:"cleanedUp,omitempty"`
		Domains   *[]string    `json:"domains,omitempty"`
	} `json:"result,omitempty"`
	Status    ActionStatus `json:"status"`
	TeamId    *float32     `json:"teamId,omitempty"`
	Type      *ActionType  `json:"type,omitempty"`
	UpdatedAt *string      `json:"updatedAt"`
}

Action An action tracks a request made to our job queue and its result.

type ActionDataFieldsType

type ActionDataFieldsType string

ActionDataFieldsType defines model for Action.Fields.Type.

const (
	ActionDataFieldsTypeArrayboolean ActionDataFieldsType = "array|boolean"
	ActionDataFieldsTypeArraynumber  ActionDataFieldsType = "array|number"
	ActionDataFieldsTypeArraystring  ActionDataFieldsType = "array|string"
	ActionDataFieldsTypeBoolean      ActionDataFieldsType = "boolean"
	ActionDataFieldsTypeNumber       ActionDataFieldsType = "number"
	ActionDataFieldsTypeString       ActionDataFieldsType = "string"
)

Defines values for ActionDataFieldsType.

type ActionDataJob

type ActionDataJob string

ActionDataJob defines model for Action.Job.

const (
	ActionDataJobAskDomain       ActionDataJob = "ask-domain"
	ActionDataJobAskList         ActionDataJob = "ask-list"
	ActionDataJobCleanupList     ActionDataJob = "cleanup-list"
	ActionDataJobEnrichCompanies ActionDataJob = "enrich-companies"
	ActionDataJobEnrichList      ActionDataJob = "enrich-list"
)

Defines values for ActionDataJob.

type ActionDataModel

type ActionDataModel string

ActionDataModel defines model for Action.Model.

const (
	Claude     ActionDataModel = "claude"
	ClaudeMini ActionDataModel = "claude-mini"
	Cousteau   ActionDataModel = "cousteau"
	Gpt        ActionDataModel = "gpt"
	GptMini    ActionDataModel = "gpt-mini"
	Groq       ActionDataModel = "groq"
	GroqMini   ActionDataModel = "groq-mini"
	Llama3     ActionDataModel = "llama3"
	Llama4     ActionDataModel = "llama4"
	Nllb       ActionDataModel = "nllb"
	Nuextract  ActionDataModel = "nuextract"
	Phi3       ActionDataModel = "phi3"
)

Defines values for ActionDataModel.

type ActionStatus

type ActionStatus string

ActionStatus defines model for Action.Status.

const (
	ActionStatusActive    ActionStatus = "active"
	ActionStatusCompleted ActionStatus = "completed"
	ActionStatusFailed    ActionStatus = "failed"
	ActionStatusPending   ActionStatus = "pending"
)

Defines values for ActionStatus.

type ActionType

type ActionType string

ActionType defines model for Action.Type.

const (
	ActionTypeCompaniesAdded ActionType = "companies:added"
	ActionTypeJobsRequest    ActionType = "jobs:request"
)

Defines values for ActionType.

type AskCompany200MetaModel

type AskCompany200MetaModel string

type AskCompany200PromptContext

type AskCompany200PromptContext string

type AskCompany200PromptDataFieldsType

type AskCompany200PromptDataFieldsType string

type AskCompany200PromptDataModel

type AskCompany200PromptDataModel string

type AskCompany200PromptFeature

type AskCompany200PromptFeature string

type AskCompany200PromptModel

type AskCompany200PromptModel string

type AskCompany200PromptResponseActionDataFieldsType

type AskCompany200PromptResponseActionDataFieldsType string

type AskCompany200PromptResponseActionDataJob

type AskCompany200PromptResponseActionDataJob string

type AskCompany200PromptResponseActionStatus

type AskCompany200PromptResponseActionStatus string

type AskCompany200PromptResponseActionType

type AskCompany200PromptResponseActionType string

type AskCompany401Messages

type AskCompany401Messages string

type AskCompany403Messages

type AskCompany403Messages string

type AskCompany404Messages

type AskCompany404Messages string

type AskCompanyJSONBody

type AskCompanyJSONBody struct {
	Explain *bool `json:"explain,omitempty"`
	Fields  *[]struct {
		Description *string                      `json:"description,omitempty"`
		Key         string                       `json:"key"`
		Type        AskCompanyJSONBodyFieldsType `json:"type"`
		Values      *[]string                    `json:"values,omitempty"`
	} `json:"fields,omitempty"`
	ListId   *float32                 `json:"listId,omitempty"`
	Model    *AskCompanyJSONBodyModel `json:"model,omitempty"`
	Query    *[]SegmentationCondition `json:"query,omitempty"`
	Question string                   `json:"question"`
}

AskCompanyJSONBody defines parameters for AskCompany.

type AskCompanyJSONBodyFieldsType

type AskCompanyJSONBodyFieldsType string

AskCompanyJSONBodyFieldsType defines parameters for AskCompany.

const (
	AskCompanyJSONBodyFieldsTypeArrayboolean AskCompanyJSONBodyFieldsType = "array|boolean"
	AskCompanyJSONBodyFieldsTypeArraynumber  AskCompanyJSONBodyFieldsType = "array|number"
	AskCompanyJSONBodyFieldsTypeArraystring  AskCompanyJSONBodyFieldsType = "array|string"
	AskCompanyJSONBodyFieldsTypeBoolean      AskCompanyJSONBodyFieldsType = "boolean"
	AskCompanyJSONBodyFieldsTypeNumber       AskCompanyJSONBodyFieldsType = "number"
	AskCompanyJSONBodyFieldsTypeString       AskCompanyJSONBodyFieldsType = "string"
)

Defines values for AskCompanyJSONBodyFieldsType.

type AskCompanyJSONBodyModel

type AskCompanyJSONBodyModel string

AskCompanyJSONBodyModel defines parameters for AskCompany.

const (
	AskCompanyJSONBodyModelLarge AskCompanyJSONBodyModel = "large"
	AskCompanyJSONBodyModelSmall AskCompanyJSONBodyModel = "small"
)

Defines values for AskCompanyJSONBodyModel.

type AskCompanyJSONRequestBody

type AskCompanyJSONRequestBody AskCompanyJSONBody

AskCompanyJSONRequestBody defines body for AskCompany for application/json ContentType.

type AskCompanyResponse

type AskCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Meta struct {
			Cost  float32                `json:"cost"`
			Model AskCompany200MetaModel `json:"model"`
			Score *float32               `json:"score,omitempty"`
		} `json:"meta"`

		// Prompt A natural language request made to the platform resolving to a specific action or search segment.
		Prompt struct {
			CompanyId *float32                   `json:"companyId,omitempty"`
			Context   AskCompany200PromptContext `json:"context"`
			CreatedAt *string                    `json:"createdAt,omitempty"`
			Data      *struct {
				All     *bool     `json:"all,omitempty"`
				Count   *float32  `json:"count,omitempty"`
				Domains *[]string `json:"domains,omitempty"`
				Explain *bool     `json:"explain,omitempty"`
				Fields  *[]struct {
					Description *string                           `json:"description,omitempty"`
					Key         string                            `json:"key"`
					Type        AskCompany200PromptDataFieldsType `json:"type"`
					Values      *[]string                         `json:"values,omitempty"`
				} `json:"fields,omitempty"`
				Model        *AskCompany200PromptDataModel `json:"model,omitempty"`
				Names        *[]string                     `json:"names,omitempty"`
				Query        *[]SegmentationCondition      `json:"query,omitempty"`
				Question     *string                       `json:"question,omitempty"`
				Segmentation *bool                         `json:"segmentation,omitempty"`
			} `json:"data,omitempty"`
			Feature   *AskCompany200PromptFeature `json:"feature,omitempty"`
			Hits      *float32                    `json:"hits,omitempty"`
			Id        float32                     `json:"id"`
			Model     *AskCompany200PromptModel   `json:"model,omitempty"`
			Prompt    string                      `json:"prompt"`
			PromptKey string                      `json:"promptKey"`
			Response  struct {
				Action *struct {
					Cost *float32 `json:"cost,omitempty"`
					Data *struct {
						// Answer An answer from a query made to the LLM.
						Answer  LLMAnswer `json:"answer"`
						Domains *[]string `json:"domains,omitempty"`
						Fields  []struct {
							Description *string                                         `json:"description,omitempty"`
							Key         string                                          `json:"key"`
							Type        AskCompany200PromptResponseActionDataFieldsType `json:"type"`
							Values      *[]string                                       `json:"values,omitempty"`
						} `json:"fields"`
						Job      AskCompany200PromptResponseActionDataJob `json:"job"`
						Query    *[]SegmentationCondition                 `json:"query,omitempty"`
						Question string                                   `json:"question"`
					} `json:"data,omitempty"`
					ListId   *float32                                `json:"listId,omitempty"`
					PromptId float32                                 `json:"promptId"`
					Status   AskCompany200PromptResponseActionStatus `json:"status"`
					Type     AskCompany200PromptResponseActionType   `json:"type"`
				} `json:"action,omitempty"`
				All    *bool `json:"all,omitempty"`
				Answer *struct {
					Explanation *string                `json:"explanation,omitempty"`
					Output      map[string]interface{} `json:"output"`
					Score       float32                `json:"score"`
				} `json:"answer,omitempty"`
				Cost   *float32 `json:"cost,omitempty"`
				Count  *float32 `json:"count,omitempty"`
				Domain *string  `json:"domain,omitempty"`
				Error  *string  `json:"error,omitempty"`
			} `json:"response"`
			UpdatedAt *string `json:"updatedAt,omitempty"`
		} `json:"prompt"`
	}
	JSON401 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages AskCompany401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages AskCompany403Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages AskCompany404Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseAskCompanyResponse

func ParseAskCompanyResponse(rsp *http.Response) (*AskCompanyResponse, error)

ParseAskCompanyResponse parses an HTTP response from a AskCompanyWithResponse call

func (AskCompanyResponse) Status

func (r AskCompanyResponse) Status() string

Status returns HTTPResponse.Status

func (AskCompanyResponse) StatusCode

func (r AskCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BaseClient

type BaseClient struct {
	// contains filtered or unexported fields
}

BaseClient represents The Companies API client foundation

func NewBaseClient

func NewBaseClient(apiKey string, options ...BaseClientOption) *BaseClient

NewBaseClient creates a new Companies API client

func (*BaseClient) BaseURL

func (c *BaseClient) BaseURL() string

BaseURL returns the configured base URL

func (*BaseClient) BuildQueryString

func (c *BaseClient) BuildQueryString(params map[string]interface{}) string

BuildQueryString serializes query parameters - Objects and arrays are JSON stringified then URL encoded - Primitives are converted to strings

func (*BaseClient) HTTPClient

func (c *BaseClient) HTTPClient() *http.Client

HTTPClient returns the underlying HTTP client

func (*BaseClient) MakeRequest

func (c *BaseClient) MakeRequest(ctx context.Context, method, path string, body any) ([]byte, error)

MakeRequest performs an HTTP request with authentication and returns the response body

func (*BaseClient) MakeRequestWithQuery

func (c *BaseClient) MakeRequestWithQuery(ctx context.Context, method, path string, queryParams map[string]interface{}, body any) ([]byte, error)

MakeRequestWithQuery performs an HTTP request with query parameters serialized

type BaseClientOption

type BaseClientOption func(*BaseClient)

BaseClientOption is a function type for configuring the client

func WithCustomBaseURL

func WithCustomBaseURL(baseURL string) BaseClientOption

WithCustomBaseURL sets a custom base URL for the client

func WithCustomHTTPClient

func WithCustomHTTPClient(httpClient *http.Client) BaseClientOption

WithCustomHTTPClient sets a custom HTTP client

func WithTimeout

func WithTimeout(timeout time.Duration) BaseClientOption

WithTimeout sets a custom timeout for HTTP requests

func WithVisitorID

func WithVisitorID(visitorID string) BaseClientOption

WithVisitorID sets a custom visitor ID for the client

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AskCompany

func (c *Client) AskCompany(ctx context.Context, domain string, body AskCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AskCompanyWithBody

func (c *Client) AskCompanyWithBody(ctx context.Context, domain string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CountCompanies

func (c *Client) CountCompanies(ctx context.Context, params *CountCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CountCompaniesPost

func (c *Client) CountCompaniesPost(ctx context.Context, body CountCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CountCompaniesPostWithBody

func (c *Client) CountCompaniesPostWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateList

func (c *Client) CreateList(ctx context.Context, body CreateListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateListWithBody

func (c *Client) CreateListWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteList

func (c *Client) DeleteList(ctx context.Context, listId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeletePrompt

func (c *Client) DeletePrompt(ctx context.Context, promptId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnrichJobTitles

func (c *Client) EnrichJobTitles(ctx context.Context, params *EnrichJobTitlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExportCompaniesAnalytics

func (c *Client) ExportCompaniesAnalytics(ctx context.Context, body ExportCompaniesAnalyticsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExportCompaniesAnalyticsWithBody

func (c *Client) ExportCompaniesAnalyticsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchActions

func (c *Client) FetchActions(ctx context.Context, params *FetchActionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchApiHealth

func (c *Client) FetchApiHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompaniesAnalytics

func (c *Client) FetchCompaniesAnalytics(ctx context.Context, params *FetchCompaniesAnalyticsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompaniesInList

func (c *Client) FetchCompaniesInList(ctx context.Context, listId float32, params *FetchCompaniesInListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompaniesInListPost

func (c *Client) FetchCompaniesInListPost(ctx context.Context, listId float32, body FetchCompaniesInListPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompaniesInListPostWithBody

func (c *Client) FetchCompaniesInListPostWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompany

func (c *Client) FetchCompany(ctx context.Context, domain string, params *FetchCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompanyByEmail

func (c *Client) FetchCompanyByEmail(ctx context.Context, params *FetchCompanyByEmailParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompanyBySocial

func (c *Client) FetchCompanyBySocial(ctx context.Context, params *FetchCompanyBySocialParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompanyContext

func (c *Client) FetchCompanyContext(ctx context.Context, domain string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompanyEmailPatterns

func (c *Client) FetchCompanyEmailPatterns(ctx context.Context, domain string, params *FetchCompanyEmailPatternsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchCompanyInList

func (c *Client) FetchCompanyInList(ctx context.Context, listId float32, domain string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchLists

func (c *Client) FetchLists(ctx context.Context, params *FetchListsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchOpenApi

func (c *Client) FetchOpenApi(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchPrompts

func (c *Client) FetchPrompts(ctx context.Context, params *FetchPromptsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchTeam

func (c *Client) FetchTeam(ctx context.Context, teamId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FetchUser

func (c *Client) FetchUser(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ProductPrompt

func (c *Client) ProductPrompt(ctx context.Context, body ProductPromptJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ProductPromptWithBody

func (c *Client) ProductPromptWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PromptToSegmentation

func (c *Client) PromptToSegmentation(ctx context.Context, body PromptToSegmentationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PromptToSegmentationWithBody

func (c *Client) PromptToSegmentationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RequestAction

func (c *Client) RequestAction(ctx context.Context, body RequestActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RequestActionWithBody

func (c *Client) RequestActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetryAction

func (c *Client) RetryAction(ctx context.Context, actionId float32, body RetryActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetryActionWithBody

func (c *Client) RetryActionWithBody(ctx context.Context, actionId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCities

func (c *Client) SearchCities(ctx context.Context, params *SearchCitiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCompanies

func (c *Client) SearchCompanies(ctx context.Context, params *SearchCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCompaniesByName

func (c *Client) SearchCompaniesByName(ctx context.Context, params *SearchCompaniesByNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCompaniesByPrompt

func (c *Client) SearchCompaniesByPrompt(ctx context.Context, params *SearchCompaniesByPromptParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCompaniesPost

func (c *Client) SearchCompaniesPost(ctx context.Context, body SearchCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCompaniesPostWithBody

func (c *Client) SearchCompaniesPostWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchContinents

func (c *Client) SearchContinents(ctx context.Context, params *SearchContinentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCounties

func (c *Client) SearchCounties(ctx context.Context, params *SearchCountiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchCountries

func (c *Client) SearchCountries(ctx context.Context, params *SearchCountriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchIndustries

func (c *Client) SearchIndustries(ctx context.Context, params *SearchIndustriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchIndustriesSimilar

func (c *Client) SearchIndustriesSimilar(ctx context.Context, params *SearchIndustriesSimilarParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchSimilarCompanies

func (c *Client) SearchSimilarCompanies(ctx context.Context, params *SearchSimilarCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchStates

func (c *Client) SearchStates(ctx context.Context, params *SearchStatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchTechnologies

func (c *Client) SearchTechnologies(ctx context.Context, params *SearchTechnologiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ToggleCompaniesInList

func (c *Client) ToggleCompaniesInList(ctx context.Context, listId float32, body ToggleCompaniesInListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ToggleCompaniesInListWithBody

func (c *Client) ToggleCompaniesInListWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateList

func (c *Client) UpdateList(ctx context.Context, listId float32, body UpdateListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateListWithBody

func (c *Client) UpdateListWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTeam

func (c *Client) UpdateTeam(ctx context.Context, teamId float32, body UpdateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTeamWithBody

func (c *Client) UpdateTeamWithBody(ctx context.Context, teamId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// FetchApiHealth request
	FetchApiHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchActions request
	FetchActions(ctx context.Context, params *FetchActionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RequestActionWithBody request with any body
	RequestActionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RequestAction(ctx context.Context, body RequestActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryActionWithBody request with any body
	RetryActionWithBody(ctx context.Context, actionId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RetryAction(ctx context.Context, actionId float32, body RetryActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCompanies request
	SearchCompanies(ctx context.Context, params *SearchCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCompaniesPostWithBody request with any body
	SearchCompaniesPostWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchCompaniesPost(ctx context.Context, body SearchCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompaniesAnalytics request
	FetchCompaniesAnalytics(ctx context.Context, params *FetchCompaniesAnalyticsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExportCompaniesAnalyticsWithBody request with any body
	ExportCompaniesAnalyticsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ExportCompaniesAnalytics(ctx context.Context, body ExportCompaniesAnalyticsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompanyByEmail request
	FetchCompanyByEmail(ctx context.Context, params *FetchCompanyByEmailParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCompaniesByName request
	SearchCompaniesByName(ctx context.Context, params *SearchCompaniesByNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCompaniesByPrompt request
	SearchCompaniesByPrompt(ctx context.Context, params *SearchCompaniesByPromptParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompanyBySocial request
	FetchCompanyBySocial(ctx context.Context, params *FetchCompanyBySocialParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CountCompanies request
	CountCompanies(ctx context.Context, params *CountCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CountCompaniesPostWithBody request with any body
	CountCompaniesPostWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CountCompaniesPost(ctx context.Context, body CountCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchSimilarCompanies request
	SearchSimilarCompanies(ctx context.Context, params *SearchSimilarCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompany request
	FetchCompany(ctx context.Context, domain string, params *FetchCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AskCompanyWithBody request with any body
	AskCompanyWithBody(ctx context.Context, domain string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AskCompany(ctx context.Context, domain string, body AskCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompanyContext request
	FetchCompanyContext(ctx context.Context, domain string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompanyEmailPatterns request
	FetchCompanyEmailPatterns(ctx context.Context, domain string, params *FetchCompanyEmailPatternsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchIndustries request
	SearchIndustries(ctx context.Context, params *SearchIndustriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchIndustriesSimilar request
	SearchIndustriesSimilar(ctx context.Context, params *SearchIndustriesSimilarParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnrichJobTitles request
	EnrichJobTitles(ctx context.Context, params *EnrichJobTitlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchLists request
	FetchLists(ctx context.Context, params *FetchListsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateListWithBody request with any body
	CreateListWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateList(ctx context.Context, body CreateListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteList request
	DeleteList(ctx context.Context, listId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateListWithBody request with any body
	UpdateListWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateList(ctx context.Context, listId float32, body UpdateListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompaniesInList request
	FetchCompaniesInList(ctx context.Context, listId float32, params *FetchCompaniesInListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompaniesInListPostWithBody request with any body
	FetchCompaniesInListPostWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	FetchCompaniesInListPost(ctx context.Context, listId float32, body FetchCompaniesInListPostJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ToggleCompaniesInListWithBody request with any body
	ToggleCompaniesInListWithBody(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ToggleCompaniesInList(ctx context.Context, listId float32, body ToggleCompaniesInListJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchCompanyInList request
	FetchCompanyInList(ctx context.Context, listId float32, domain string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCities request
	SearchCities(ctx context.Context, params *SearchCitiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchContinents request
	SearchContinents(ctx context.Context, params *SearchContinentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCounties request
	SearchCounties(ctx context.Context, params *SearchCountiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchCountries request
	SearchCountries(ctx context.Context, params *SearchCountriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchStates request
	SearchStates(ctx context.Context, params *SearchStatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchOpenApi request
	FetchOpenApi(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchPrompts request
	FetchPrompts(ctx context.Context, params *FetchPromptsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProductPromptWithBody request with any body
	ProductPromptWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ProductPrompt(ctx context.Context, body ProductPromptJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PromptToSegmentationWithBody request with any body
	PromptToSegmentationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PromptToSegmentation(ctx context.Context, body PromptToSegmentationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePrompt request
	DeletePrompt(ctx context.Context, promptId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchTeam request
	FetchTeam(ctx context.Context, teamId float32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTeamWithBody request with any body
	UpdateTeamWithBody(ctx context.Context, teamId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTeam(ctx context.Context, teamId float32, body UpdateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchTechnologies request
	SearchTechnologies(ctx context.Context, params *SearchTechnologiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FetchUser request
	FetchUser(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AskCompanyWithBodyWithResponse

func (c *ClientWithResponses) AskCompanyWithBodyWithResponse(ctx context.Context, domain string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AskCompanyResponse, error)

AskCompanyWithBodyWithResponse request with arbitrary body returning *AskCompanyResponse

func (*ClientWithResponses) AskCompanyWithResponse

func (c *ClientWithResponses) AskCompanyWithResponse(ctx context.Context, domain string, body AskCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*AskCompanyResponse, error)

func (*ClientWithResponses) CountCompaniesPostWithBodyWithResponse

func (c *ClientWithResponses) CountCompaniesPostWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CountCompaniesPostResponse, error)

CountCompaniesPostWithBodyWithResponse request with arbitrary body returning *CountCompaniesPostResponse

func (*ClientWithResponses) CountCompaniesPostWithResponse

func (c *ClientWithResponses) CountCompaniesPostWithResponse(ctx context.Context, body CountCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*CountCompaniesPostResponse, error)

func (*ClientWithResponses) CountCompaniesWithResponse

func (c *ClientWithResponses) CountCompaniesWithResponse(ctx context.Context, params *CountCompaniesParams, reqEditors ...RequestEditorFn) (*CountCompaniesResponse, error)

CountCompaniesWithResponse request returning *CountCompaniesResponse

func (*ClientWithResponses) CreateListWithBodyWithResponse

func (c *ClientWithResponses) CreateListWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateListResponse, error)

CreateListWithBodyWithResponse request with arbitrary body returning *CreateListResponse

func (*ClientWithResponses) CreateListWithResponse

func (c *ClientWithResponses) CreateListWithResponse(ctx context.Context, body CreateListJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateListResponse, error)

func (*ClientWithResponses) DeleteListWithResponse

func (c *ClientWithResponses) DeleteListWithResponse(ctx context.Context, listId float32, reqEditors ...RequestEditorFn) (*DeleteListResponse, error)

DeleteListWithResponse request returning *DeleteListResponse

func (*ClientWithResponses) DeletePromptWithResponse

func (c *ClientWithResponses) DeletePromptWithResponse(ctx context.Context, promptId float32, reqEditors ...RequestEditorFn) (*DeletePromptResponse, error)

DeletePromptWithResponse request returning *DeletePromptResponse

func (*ClientWithResponses) EnrichJobTitlesWithResponse

func (c *ClientWithResponses) EnrichJobTitlesWithResponse(ctx context.Context, params *EnrichJobTitlesParams, reqEditors ...RequestEditorFn) (*EnrichJobTitlesResponse, error)

EnrichJobTitlesWithResponse request returning *EnrichJobTitlesResponse

func (*ClientWithResponses) ExportCompaniesAnalyticsWithBodyWithResponse

func (c *ClientWithResponses) ExportCompaniesAnalyticsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExportCompaniesAnalyticsResponse, error)

ExportCompaniesAnalyticsWithBodyWithResponse request with arbitrary body returning *ExportCompaniesAnalyticsResponse

func (*ClientWithResponses) ExportCompaniesAnalyticsWithResponse

func (c *ClientWithResponses) ExportCompaniesAnalyticsWithResponse(ctx context.Context, body ExportCompaniesAnalyticsJSONRequestBody, reqEditors ...RequestEditorFn) (*ExportCompaniesAnalyticsResponse, error)

func (*ClientWithResponses) FetchActionsWithResponse

func (c *ClientWithResponses) FetchActionsWithResponse(ctx context.Context, params *FetchActionsParams, reqEditors ...RequestEditorFn) (*FetchActionsResponse, error)

FetchActionsWithResponse request returning *FetchActionsResponse

func (*ClientWithResponses) FetchApiHealthWithResponse

func (c *ClientWithResponses) FetchApiHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchApiHealthResponse, error)

FetchApiHealthWithResponse request returning *FetchApiHealthResponse

func (*ClientWithResponses) FetchCompaniesAnalyticsWithResponse

func (c *ClientWithResponses) FetchCompaniesAnalyticsWithResponse(ctx context.Context, params *FetchCompaniesAnalyticsParams, reqEditors ...RequestEditorFn) (*FetchCompaniesAnalyticsResponse, error)

FetchCompaniesAnalyticsWithResponse request returning *FetchCompaniesAnalyticsResponse

func (*ClientWithResponses) FetchCompaniesInListPostWithBodyWithResponse

func (c *ClientWithResponses) FetchCompaniesInListPostWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FetchCompaniesInListPostResponse, error)

FetchCompaniesInListPostWithBodyWithResponse request with arbitrary body returning *FetchCompaniesInListPostResponse

func (*ClientWithResponses) FetchCompaniesInListPostWithResponse

func (c *ClientWithResponses) FetchCompaniesInListPostWithResponse(ctx context.Context, listId float32, body FetchCompaniesInListPostJSONRequestBody, reqEditors ...RequestEditorFn) (*FetchCompaniesInListPostResponse, error)

func (*ClientWithResponses) FetchCompaniesInListWithResponse

func (c *ClientWithResponses) FetchCompaniesInListWithResponse(ctx context.Context, listId float32, params *FetchCompaniesInListParams, reqEditors ...RequestEditorFn) (*FetchCompaniesInListResponse, error)

FetchCompaniesInListWithResponse request returning *FetchCompaniesInListResponse

func (*ClientWithResponses) FetchCompanyByEmailWithResponse

func (c *ClientWithResponses) FetchCompanyByEmailWithResponse(ctx context.Context, params *FetchCompanyByEmailParams, reqEditors ...RequestEditorFn) (*FetchCompanyByEmailResponse, error)

FetchCompanyByEmailWithResponse request returning *FetchCompanyByEmailResponse

func (*ClientWithResponses) FetchCompanyBySocialWithResponse

func (c *ClientWithResponses) FetchCompanyBySocialWithResponse(ctx context.Context, params *FetchCompanyBySocialParams, reqEditors ...RequestEditorFn) (*FetchCompanyBySocialResponse, error)

FetchCompanyBySocialWithResponse request returning *FetchCompanyBySocialResponse

func (*ClientWithResponses) FetchCompanyContextWithResponse

func (c *ClientWithResponses) FetchCompanyContextWithResponse(ctx context.Context, domain string, reqEditors ...RequestEditorFn) (*FetchCompanyContextResponse, error)

FetchCompanyContextWithResponse request returning *FetchCompanyContextResponse

func (*ClientWithResponses) FetchCompanyEmailPatternsWithResponse

func (c *ClientWithResponses) FetchCompanyEmailPatternsWithResponse(ctx context.Context, domain string, params *FetchCompanyEmailPatternsParams, reqEditors ...RequestEditorFn) (*FetchCompanyEmailPatternsResponse, error)

FetchCompanyEmailPatternsWithResponse request returning *FetchCompanyEmailPatternsResponse

func (*ClientWithResponses) FetchCompanyInListWithResponse

func (c *ClientWithResponses) FetchCompanyInListWithResponse(ctx context.Context, listId float32, domain string, reqEditors ...RequestEditorFn) (*FetchCompanyInListResponse, error)

FetchCompanyInListWithResponse request returning *FetchCompanyInListResponse

func (*ClientWithResponses) FetchCompanyWithResponse

func (c *ClientWithResponses) FetchCompanyWithResponse(ctx context.Context, domain string, params *FetchCompanyParams, reqEditors ...RequestEditorFn) (*FetchCompanyResponse, error)

FetchCompanyWithResponse request returning *FetchCompanyResponse

func (*ClientWithResponses) FetchListsWithResponse

func (c *ClientWithResponses) FetchListsWithResponse(ctx context.Context, params *FetchListsParams, reqEditors ...RequestEditorFn) (*FetchListsResponse, error)

FetchListsWithResponse request returning *FetchListsResponse

func (*ClientWithResponses) FetchOpenApiWithResponse

func (c *ClientWithResponses) FetchOpenApiWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchOpenApiResponse, error)

FetchOpenApiWithResponse request returning *FetchOpenApiResponse

func (*ClientWithResponses) FetchPromptsWithResponse

func (c *ClientWithResponses) FetchPromptsWithResponse(ctx context.Context, params *FetchPromptsParams, reqEditors ...RequestEditorFn) (*FetchPromptsResponse, error)

FetchPromptsWithResponse request returning *FetchPromptsResponse

func (*ClientWithResponses) FetchTeamWithResponse

func (c *ClientWithResponses) FetchTeamWithResponse(ctx context.Context, teamId float32, reqEditors ...RequestEditorFn) (*FetchTeamResponse, error)

FetchTeamWithResponse request returning *FetchTeamResponse

func (*ClientWithResponses) FetchUserWithResponse

func (c *ClientWithResponses) FetchUserWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchUserResponse, error)

FetchUserWithResponse request returning *FetchUserResponse

func (*ClientWithResponses) ProductPromptWithBodyWithResponse

func (c *ClientWithResponses) ProductPromptWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProductPromptResponse, error)

ProductPromptWithBodyWithResponse request with arbitrary body returning *ProductPromptResponse

func (*ClientWithResponses) ProductPromptWithResponse

func (c *ClientWithResponses) ProductPromptWithResponse(ctx context.Context, body ProductPromptJSONRequestBody, reqEditors ...RequestEditorFn) (*ProductPromptResponse, error)

func (*ClientWithResponses) PromptToSegmentationWithBodyWithResponse

func (c *ClientWithResponses) PromptToSegmentationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PromptToSegmentationResponse, error)

PromptToSegmentationWithBodyWithResponse request with arbitrary body returning *PromptToSegmentationResponse

func (*ClientWithResponses) PromptToSegmentationWithResponse

func (c *ClientWithResponses) PromptToSegmentationWithResponse(ctx context.Context, body PromptToSegmentationJSONRequestBody, reqEditors ...RequestEditorFn) (*PromptToSegmentationResponse, error)

func (*ClientWithResponses) RequestActionWithBodyWithResponse

func (c *ClientWithResponses) RequestActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RequestActionResponse, error)

RequestActionWithBodyWithResponse request with arbitrary body returning *RequestActionResponse

func (*ClientWithResponses) RequestActionWithResponse

func (c *ClientWithResponses) RequestActionWithResponse(ctx context.Context, body RequestActionJSONRequestBody, reqEditors ...RequestEditorFn) (*RequestActionResponse, error)

func (*ClientWithResponses) RetryActionWithBodyWithResponse

func (c *ClientWithResponses) RetryActionWithBodyWithResponse(ctx context.Context, actionId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryActionResponse, error)

RetryActionWithBodyWithResponse request with arbitrary body returning *RetryActionResponse

func (*ClientWithResponses) RetryActionWithResponse

func (c *ClientWithResponses) RetryActionWithResponse(ctx context.Context, actionId float32, body RetryActionJSONRequestBody, reqEditors ...RequestEditorFn) (*RetryActionResponse, error)

func (*ClientWithResponses) SearchCitiesWithResponse

func (c *ClientWithResponses) SearchCitiesWithResponse(ctx context.Context, params *SearchCitiesParams, reqEditors ...RequestEditorFn) (*SearchCitiesResponse, error)

SearchCitiesWithResponse request returning *SearchCitiesResponse

func (*ClientWithResponses) SearchCompaniesByNameWithResponse

func (c *ClientWithResponses) SearchCompaniesByNameWithResponse(ctx context.Context, params *SearchCompaniesByNameParams, reqEditors ...RequestEditorFn) (*SearchCompaniesByNameResponse, error)

SearchCompaniesByNameWithResponse request returning *SearchCompaniesByNameResponse

func (*ClientWithResponses) SearchCompaniesByPromptWithResponse

func (c *ClientWithResponses) SearchCompaniesByPromptWithResponse(ctx context.Context, params *SearchCompaniesByPromptParams, reqEditors ...RequestEditorFn) (*SearchCompaniesByPromptResponse, error)

SearchCompaniesByPromptWithResponse request returning *SearchCompaniesByPromptResponse

func (*ClientWithResponses) SearchCompaniesPostWithBodyWithResponse

func (c *ClientWithResponses) SearchCompaniesPostWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchCompaniesPostResponse, error)

SearchCompaniesPostWithBodyWithResponse request with arbitrary body returning *SearchCompaniesPostResponse

func (*ClientWithResponses) SearchCompaniesPostWithResponse

func (c *ClientWithResponses) SearchCompaniesPostWithResponse(ctx context.Context, body SearchCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchCompaniesPostResponse, error)

func (*ClientWithResponses) SearchCompaniesWithResponse

func (c *ClientWithResponses) SearchCompaniesWithResponse(ctx context.Context, params *SearchCompaniesParams, reqEditors ...RequestEditorFn) (*SearchCompaniesResponse, error)

SearchCompaniesWithResponse request returning *SearchCompaniesResponse

func (*ClientWithResponses) SearchContinentsWithResponse

func (c *ClientWithResponses) SearchContinentsWithResponse(ctx context.Context, params *SearchContinentsParams, reqEditors ...RequestEditorFn) (*SearchContinentsResponse, error)

SearchContinentsWithResponse request returning *SearchContinentsResponse

func (*ClientWithResponses) SearchCountiesWithResponse

func (c *ClientWithResponses) SearchCountiesWithResponse(ctx context.Context, params *SearchCountiesParams, reqEditors ...RequestEditorFn) (*SearchCountiesResponse, error)

SearchCountiesWithResponse request returning *SearchCountiesResponse

func (*ClientWithResponses) SearchCountriesWithResponse

func (c *ClientWithResponses) SearchCountriesWithResponse(ctx context.Context, params *SearchCountriesParams, reqEditors ...RequestEditorFn) (*SearchCountriesResponse, error)

SearchCountriesWithResponse request returning *SearchCountriesResponse

func (*ClientWithResponses) SearchIndustriesSimilarWithResponse

func (c *ClientWithResponses) SearchIndustriesSimilarWithResponse(ctx context.Context, params *SearchIndustriesSimilarParams, reqEditors ...RequestEditorFn) (*SearchIndustriesSimilarResponse, error)

SearchIndustriesSimilarWithResponse request returning *SearchIndustriesSimilarResponse

func (*ClientWithResponses) SearchIndustriesWithResponse

func (c *ClientWithResponses) SearchIndustriesWithResponse(ctx context.Context, params *SearchIndustriesParams, reqEditors ...RequestEditorFn) (*SearchIndustriesResponse, error)

SearchIndustriesWithResponse request returning *SearchIndustriesResponse

func (*ClientWithResponses) SearchSimilarCompaniesWithResponse

func (c *ClientWithResponses) SearchSimilarCompaniesWithResponse(ctx context.Context, params *SearchSimilarCompaniesParams, reqEditors ...RequestEditorFn) (*SearchSimilarCompaniesResponse, error)

SearchSimilarCompaniesWithResponse request returning *SearchSimilarCompaniesResponse

func (*ClientWithResponses) SearchStatesWithResponse

func (c *ClientWithResponses) SearchStatesWithResponse(ctx context.Context, params *SearchStatesParams, reqEditors ...RequestEditorFn) (*SearchStatesResponse, error)

SearchStatesWithResponse request returning *SearchStatesResponse

func (*ClientWithResponses) SearchTechnologiesWithResponse

func (c *ClientWithResponses) SearchTechnologiesWithResponse(ctx context.Context, params *SearchTechnologiesParams, reqEditors ...RequestEditorFn) (*SearchTechnologiesResponse, error)

SearchTechnologiesWithResponse request returning *SearchTechnologiesResponse

func (*ClientWithResponses) ToggleCompaniesInListWithBodyWithResponse

func (c *ClientWithResponses) ToggleCompaniesInListWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ToggleCompaniesInListResponse, error)

ToggleCompaniesInListWithBodyWithResponse request with arbitrary body returning *ToggleCompaniesInListResponse

func (*ClientWithResponses) ToggleCompaniesInListWithResponse

func (c *ClientWithResponses) ToggleCompaniesInListWithResponse(ctx context.Context, listId float32, body ToggleCompaniesInListJSONRequestBody, reqEditors ...RequestEditorFn) (*ToggleCompaniesInListResponse, error)

func (*ClientWithResponses) UpdateListWithBodyWithResponse

func (c *ClientWithResponses) UpdateListWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateListResponse, error)

UpdateListWithBodyWithResponse request with arbitrary body returning *UpdateListResponse

func (*ClientWithResponses) UpdateListWithResponse

func (c *ClientWithResponses) UpdateListWithResponse(ctx context.Context, listId float32, body UpdateListJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateListResponse, error)

func (*ClientWithResponses) UpdateTeamWithBodyWithResponse

func (c *ClientWithResponses) UpdateTeamWithBodyWithResponse(ctx context.Context, teamId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTeamResponse, error)

UpdateTeamWithBodyWithResponse request with arbitrary body returning *UpdateTeamResponse

func (*ClientWithResponses) UpdateTeamWithResponse

func (c *ClientWithResponses) UpdateTeamWithResponse(ctx context.Context, teamId float32, body UpdateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTeamResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// FetchApiHealthWithResponse request
	FetchApiHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchApiHealthResponse, error)

	// FetchActionsWithResponse request
	FetchActionsWithResponse(ctx context.Context, params *FetchActionsParams, reqEditors ...RequestEditorFn) (*FetchActionsResponse, error)

	// RequestActionWithBodyWithResponse request with any body
	RequestActionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RequestActionResponse, error)

	RequestActionWithResponse(ctx context.Context, body RequestActionJSONRequestBody, reqEditors ...RequestEditorFn) (*RequestActionResponse, error)

	// RetryActionWithBodyWithResponse request with any body
	RetryActionWithBodyWithResponse(ctx context.Context, actionId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetryActionResponse, error)

	RetryActionWithResponse(ctx context.Context, actionId float32, body RetryActionJSONRequestBody, reqEditors ...RequestEditorFn) (*RetryActionResponse, error)

	// SearchCompaniesWithResponse request
	SearchCompaniesWithResponse(ctx context.Context, params *SearchCompaniesParams, reqEditors ...RequestEditorFn) (*SearchCompaniesResponse, error)

	// SearchCompaniesPostWithBodyWithResponse request with any body
	SearchCompaniesPostWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchCompaniesPostResponse, error)

	SearchCompaniesPostWithResponse(ctx context.Context, body SearchCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchCompaniesPostResponse, error)

	// FetchCompaniesAnalyticsWithResponse request
	FetchCompaniesAnalyticsWithResponse(ctx context.Context, params *FetchCompaniesAnalyticsParams, reqEditors ...RequestEditorFn) (*FetchCompaniesAnalyticsResponse, error)

	// ExportCompaniesAnalyticsWithBodyWithResponse request with any body
	ExportCompaniesAnalyticsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExportCompaniesAnalyticsResponse, error)

	ExportCompaniesAnalyticsWithResponse(ctx context.Context, body ExportCompaniesAnalyticsJSONRequestBody, reqEditors ...RequestEditorFn) (*ExportCompaniesAnalyticsResponse, error)

	// FetchCompanyByEmailWithResponse request
	FetchCompanyByEmailWithResponse(ctx context.Context, params *FetchCompanyByEmailParams, reqEditors ...RequestEditorFn) (*FetchCompanyByEmailResponse, error)

	// SearchCompaniesByNameWithResponse request
	SearchCompaniesByNameWithResponse(ctx context.Context, params *SearchCompaniesByNameParams, reqEditors ...RequestEditorFn) (*SearchCompaniesByNameResponse, error)

	// SearchCompaniesByPromptWithResponse request
	SearchCompaniesByPromptWithResponse(ctx context.Context, params *SearchCompaniesByPromptParams, reqEditors ...RequestEditorFn) (*SearchCompaniesByPromptResponse, error)

	// FetchCompanyBySocialWithResponse request
	FetchCompanyBySocialWithResponse(ctx context.Context, params *FetchCompanyBySocialParams, reqEditors ...RequestEditorFn) (*FetchCompanyBySocialResponse, error)

	// CountCompaniesWithResponse request
	CountCompaniesWithResponse(ctx context.Context, params *CountCompaniesParams, reqEditors ...RequestEditorFn) (*CountCompaniesResponse, error)

	// CountCompaniesPostWithBodyWithResponse request with any body
	CountCompaniesPostWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CountCompaniesPostResponse, error)

	CountCompaniesPostWithResponse(ctx context.Context, body CountCompaniesPostJSONRequestBody, reqEditors ...RequestEditorFn) (*CountCompaniesPostResponse, error)

	// SearchSimilarCompaniesWithResponse request
	SearchSimilarCompaniesWithResponse(ctx context.Context, params *SearchSimilarCompaniesParams, reqEditors ...RequestEditorFn) (*SearchSimilarCompaniesResponse, error)

	// FetchCompanyWithResponse request
	FetchCompanyWithResponse(ctx context.Context, domain string, params *FetchCompanyParams, reqEditors ...RequestEditorFn) (*FetchCompanyResponse, error)

	// AskCompanyWithBodyWithResponse request with any body
	AskCompanyWithBodyWithResponse(ctx context.Context, domain string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AskCompanyResponse, error)

	AskCompanyWithResponse(ctx context.Context, domain string, body AskCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*AskCompanyResponse, error)

	// FetchCompanyContextWithResponse request
	FetchCompanyContextWithResponse(ctx context.Context, domain string, reqEditors ...RequestEditorFn) (*FetchCompanyContextResponse, error)

	// FetchCompanyEmailPatternsWithResponse request
	FetchCompanyEmailPatternsWithResponse(ctx context.Context, domain string, params *FetchCompanyEmailPatternsParams, reqEditors ...RequestEditorFn) (*FetchCompanyEmailPatternsResponse, error)

	// SearchIndustriesWithResponse request
	SearchIndustriesWithResponse(ctx context.Context, params *SearchIndustriesParams, reqEditors ...RequestEditorFn) (*SearchIndustriesResponse, error)

	// SearchIndustriesSimilarWithResponse request
	SearchIndustriesSimilarWithResponse(ctx context.Context, params *SearchIndustriesSimilarParams, reqEditors ...RequestEditorFn) (*SearchIndustriesSimilarResponse, error)

	// EnrichJobTitlesWithResponse request
	EnrichJobTitlesWithResponse(ctx context.Context, params *EnrichJobTitlesParams, reqEditors ...RequestEditorFn) (*EnrichJobTitlesResponse, error)

	// FetchListsWithResponse request
	FetchListsWithResponse(ctx context.Context, params *FetchListsParams, reqEditors ...RequestEditorFn) (*FetchListsResponse, error)

	// CreateListWithBodyWithResponse request with any body
	CreateListWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateListResponse, error)

	CreateListWithResponse(ctx context.Context, body CreateListJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateListResponse, error)

	// DeleteListWithResponse request
	DeleteListWithResponse(ctx context.Context, listId float32, reqEditors ...RequestEditorFn) (*DeleteListResponse, error)

	// UpdateListWithBodyWithResponse request with any body
	UpdateListWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateListResponse, error)

	UpdateListWithResponse(ctx context.Context, listId float32, body UpdateListJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateListResponse, error)

	// FetchCompaniesInListWithResponse request
	FetchCompaniesInListWithResponse(ctx context.Context, listId float32, params *FetchCompaniesInListParams, reqEditors ...RequestEditorFn) (*FetchCompaniesInListResponse, error)

	// FetchCompaniesInListPostWithBodyWithResponse request with any body
	FetchCompaniesInListPostWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FetchCompaniesInListPostResponse, error)

	FetchCompaniesInListPostWithResponse(ctx context.Context, listId float32, body FetchCompaniesInListPostJSONRequestBody, reqEditors ...RequestEditorFn) (*FetchCompaniesInListPostResponse, error)

	// ToggleCompaniesInListWithBodyWithResponse request with any body
	ToggleCompaniesInListWithBodyWithResponse(ctx context.Context, listId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ToggleCompaniesInListResponse, error)

	ToggleCompaniesInListWithResponse(ctx context.Context, listId float32, body ToggleCompaniesInListJSONRequestBody, reqEditors ...RequestEditorFn) (*ToggleCompaniesInListResponse, error)

	// FetchCompanyInListWithResponse request
	FetchCompanyInListWithResponse(ctx context.Context, listId float32, domain string, reqEditors ...RequestEditorFn) (*FetchCompanyInListResponse, error)

	// SearchCitiesWithResponse request
	SearchCitiesWithResponse(ctx context.Context, params *SearchCitiesParams, reqEditors ...RequestEditorFn) (*SearchCitiesResponse, error)

	// SearchContinentsWithResponse request
	SearchContinentsWithResponse(ctx context.Context, params *SearchContinentsParams, reqEditors ...RequestEditorFn) (*SearchContinentsResponse, error)

	// SearchCountiesWithResponse request
	SearchCountiesWithResponse(ctx context.Context, params *SearchCountiesParams, reqEditors ...RequestEditorFn) (*SearchCountiesResponse, error)

	// SearchCountriesWithResponse request
	SearchCountriesWithResponse(ctx context.Context, params *SearchCountriesParams, reqEditors ...RequestEditorFn) (*SearchCountriesResponse, error)

	// SearchStatesWithResponse request
	SearchStatesWithResponse(ctx context.Context, params *SearchStatesParams, reqEditors ...RequestEditorFn) (*SearchStatesResponse, error)

	// FetchOpenApiWithResponse request
	FetchOpenApiWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchOpenApiResponse, error)

	// FetchPromptsWithResponse request
	FetchPromptsWithResponse(ctx context.Context, params *FetchPromptsParams, reqEditors ...RequestEditorFn) (*FetchPromptsResponse, error)

	// ProductPromptWithBodyWithResponse request with any body
	ProductPromptWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProductPromptResponse, error)

	ProductPromptWithResponse(ctx context.Context, body ProductPromptJSONRequestBody, reqEditors ...RequestEditorFn) (*ProductPromptResponse, error)

	// PromptToSegmentationWithBodyWithResponse request with any body
	PromptToSegmentationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PromptToSegmentationResponse, error)

	PromptToSegmentationWithResponse(ctx context.Context, body PromptToSegmentationJSONRequestBody, reqEditors ...RequestEditorFn) (*PromptToSegmentationResponse, error)

	// DeletePromptWithResponse request
	DeletePromptWithResponse(ctx context.Context, promptId float32, reqEditors ...RequestEditorFn) (*DeletePromptResponse, error)

	// FetchTeamWithResponse request
	FetchTeamWithResponse(ctx context.Context, teamId float32, reqEditors ...RequestEditorFn) (*FetchTeamResponse, error)

	// UpdateTeamWithBodyWithResponse request with any body
	UpdateTeamWithBodyWithResponse(ctx context.Context, teamId float32, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTeamResponse, error)

	UpdateTeamWithResponse(ctx context.Context, teamId float32, body UpdateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTeamResponse, error)

	// SearchTechnologiesWithResponse request
	SearchTechnologiesWithResponse(ctx context.Context, params *SearchTechnologiesParams, reqEditors ...RequestEditorFn) (*SearchTechnologiesResponse, error)

	// FetchUserWithResponse request
	FetchUserWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchUserResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CompaniesAPIClient

type CompaniesAPIClient struct {
	*ClientWithResponses // Generated operations with proper types
	// contains filtered or unexported fields
}

CompaniesAPIClient is the main client for interacting with The Companies API It provides access to all API operations with proper type safety and authentication

func ApiClient

func ApiClient(apiKey string, options ...BaseClientOption) (*CompaniesAPIClient, error)

New creates the main client for The Companies API This is the primary entry point that users should use

func (*CompaniesAPIClient) AskCompany

func (*CompaniesAPIClient) BaseURL

func (c *CompaniesAPIClient) BaseURL() string

BaseURL returns the base URL being used by the client This is useful for debugging and logging purposes

func (*CompaniesAPIClient) CountCompanies

func (*CompaniesAPIClient) CountCompaniesPost

func (*CompaniesAPIClient) CreateList

func (*CompaniesAPIClient) DeleteList

func (c *CompaniesAPIClient) DeleteList(ctx context.Context, listId float32) (*DeleteListResponse, error)

func (*CompaniesAPIClient) DeletePrompt

func (c *CompaniesAPIClient) DeletePrompt(ctx context.Context, promptId float32) (*DeletePromptResponse, error)

func (*CompaniesAPIClient) EnrichJobTitles

func (*CompaniesAPIClient) FetchActions

func (*CompaniesAPIClient) FetchApiHealth

func (c *CompaniesAPIClient) FetchApiHealth(ctx context.Context) (*FetchApiHealthResponse, error)

func (*CompaniesAPIClient) FetchCompaniesAnalytics

func (*CompaniesAPIClient) FetchCompaniesInList

func (*CompaniesAPIClient) FetchCompaniesInListPost

func (*CompaniesAPIClient) FetchCompany

func (c *CompaniesAPIClient) FetchCompany(ctx context.Context, domain string, params *FetchCompanyParams) (*FetchCompanyResponse, error)

func (*CompaniesAPIClient) FetchCompanyByEmail

func (*CompaniesAPIClient) FetchCompanyBySocial

func (*CompaniesAPIClient) FetchCompanyContext

func (c *CompaniesAPIClient) FetchCompanyContext(ctx context.Context, domain string) (*FetchCompanyContextResponse, error)

func (*CompaniesAPIClient) FetchCompanyEmailPatterns

func (*CompaniesAPIClient) FetchCompanyInList

func (c *CompaniesAPIClient) FetchCompanyInList(ctx context.Context, listId float32, domain string) (*FetchCompanyInListResponse, error)

func (*CompaniesAPIClient) FetchLists

func (*CompaniesAPIClient) FetchOpenApi

func (c *CompaniesAPIClient) FetchOpenApi(ctx context.Context) (*FetchOpenApiResponse, error)

func (*CompaniesAPIClient) FetchPrompts

func (*CompaniesAPIClient) FetchTeam

func (c *CompaniesAPIClient) FetchTeam(ctx context.Context, teamId float32) (*FetchTeamResponse, error)

func (*CompaniesAPIClient) FetchUser

func (*CompaniesAPIClient) ProductPrompt

func (*CompaniesAPIClient) PromptToSegmentation

func (*CompaniesAPIClient) RequestAction

func (*CompaniesAPIClient) RetryAction

func (*CompaniesAPIClient) SearchCities

func (*CompaniesAPIClient) SearchCompanies

func (*CompaniesAPIClient) SearchCompaniesByName

func (*CompaniesAPIClient) SearchCompaniesByPrompt

func (*CompaniesAPIClient) SearchCompaniesPost

func (*CompaniesAPIClient) SearchContinents

func (*CompaniesAPIClient) SearchCounties

func (*CompaniesAPIClient) SearchCountries

func (*CompaniesAPIClient) SearchIndustries

func (*CompaniesAPIClient) SearchIndustriesSimilar

func (*CompaniesAPIClient) SearchSimilarCompanies

func (*CompaniesAPIClient) SearchStates

func (*CompaniesAPIClient) SearchTechnologies

func (*CompaniesAPIClient) ToggleCompaniesInList

func (*CompaniesAPIClient) UpdateList

func (*CompaniesAPIClient) UpdateTeam

type CompanyV2

type CompanyV2 struct {
	About *struct {
		// BusinessType The type of business the company is.
		BusinessType *CompanyV2AboutBusinessType `json:"businessType,omitempty"`

		// Industries The industries the company is in.
		Industries *[]string `json:"industries,omitempty"`

		// Industry The main industry of the company.
		Industry *string `json:"industry,omitempty"`

		// Languages The languages the company supports.
		Languages *[]string `json:"languages,omitempty"`

		// Name The name of the company.
		Name *string `json:"name,omitempty"`

		// NameAlts The alternative names of the company.
		NameAlts *[]string `json:"nameAlts,omitempty"`

		// NameLegal The legal name of the company.
		NameLegal *string `json:"nameLegal,omitempty"`

		// TotalEmployees The total number of employees the company has.
		TotalEmployees *CompanyV2AboutTotalEmployees `json:"totalEmployees,omitempty"`

		// TotalEmployeesExact The exact total number of employees the company has.
		TotalEmployeesExact *float32 `json:"totalEmployeesExact,omitempty"`

		// YearEnded The year the company stopped its operations.
		YearEnded *float32 `json:"yearEnded,omitempty"`

		// YearFounded The year the company was founded.
		YearFounded *float32 `json:"yearFounded,omitempty"`

		// YearFoundedDate The date the company was founded.
		YearFoundedDate *string `json:"yearFoundedDate,omitempty"`

		// YearFoundedPlace The place the company was founded.
		YearFoundedPlace *string `json:"yearFoundedPlace,omitempty"`
	} `json:"about,omitempty"`

	// Action The action results for the company.
	Action *struct {
		// Answer The answer of the action.
		Answer *struct {
			// Explanation The explanation of the answer.
			Explanation *string `json:"explanation,omitempty"`

			// Output The output of the answer.
			Output *map[string]interface{} `json:"output,omitempty"`

			// Score The score of the answer.
			Score *float32 `json:"score,omitempty"`
		} `json:"answer,omitempty"`
	} `json:"action,omitempty"`
	Analytics *struct {
		// Lighthouse Lighthouse and Core Web Vitals analysis.
		Lighthouse *struct {
			// Accessibility The accessibility score (0-100).
			Accessibility *float32 `json:"accessibility,omitempty"`

			// BestPractices The best practices score (0-100).
			BestPractices *float32 `json:"bestPractices,omitempty"`

			// CumulativeLayoutShift The cumulative layout shift.
			CumulativeLayoutShift *struct {
				Count *float32 `json:"count,omitempty"`
				Score *float32 `json:"score,omitempty"`
			} `json:"cumulativeLayoutShift,omitempty"`

			// LargestContentfulPaint The largest contentful paint.
			LargestContentfulPaint *struct {
				Ms    *float32 `json:"ms,omitempty"`
				Score *float32 `json:"score,omitempty"`
			} `json:"largestContentfulPaint,omitempty"`

			// MaxServerLatency The maximum server latency.
			MaxServerLatency *float32 `json:"maxServerLatency,omitempty"`

			// NumFonts The number of fonts.
			NumFonts *float32 `json:"numFonts,omitempty"`

			// NumRequests The number of requests.
			NumRequests *float32 `json:"numRequests,omitempty"`

			// NumScripts The number of scripts.
			NumScripts *float32 `json:"numScripts,omitempty"`

			// NumStylesheets The number of stylesheets.
			NumStylesheets *float32 `json:"numStylesheets,omitempty"`

			// NumTasks The number of tasks.
			NumTasks *float32 `json:"numTasks,omitempty"`

			// Performance The performance score (0-100).
			Performance *float32 `json:"performance,omitempty"`

			// Seo The SEO score (0-100).
			Seo *float32 `json:"seo,omitempty"`

			// TimeToInteractive The time to interactive.
			TimeToInteractive *struct {
				Ms    *float32 `json:"ms,omitempty"`
				Score *float32 `json:"score,omitempty"`
			} `json:"timeToInteractive,omitempty"`

			// TotalBlockingTime The total blocking time.
			TotalBlockingTime *struct {
				Ms    *float32 `json:"ms,omitempty"`
				Score *float32 `json:"score,omitempty"`
			} `json:"totalBlockingTime,omitempty"`
		} `json:"lighthouse,omitempty"`

		// MonthlyVisitors The total number of monthly visitors the company has.
		MonthlyVisitors *CompanyV2AnalyticsMonthlyVisitors `json:"monthlyVisitors,omitempty"`
	} `json:"analytics,omitempty"`

	// Apps The apps the company owns.
	Apps *struct {
		Amazon *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsAmazonType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"amazon,omitempty"`
		Android *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsAndroidType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"android,omitempty"`
		Chrome *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsChromeType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"chrome,omitempty"`
		Ios *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsIosType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"ios,omitempty"`
		Mac *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsMacType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"mac,omitempty"`
		Meta *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsMetaType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"meta,omitempty"`
		Microsoft *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsMicrosoftType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"microsoft,omitempty"`
		Playstation *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsPlaystationType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"playstation,omitempty"`
		Xbox *[]struct {
			// Id The ID of the app.
			Id *string `json:"id,omitempty"`

			// Name The name of the app.
			Name *string `json:"name,omitempty"`

			// Rating The rating of the app.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the app has.
			Reviews *float32 `json:"reviews,omitempty"`

			// Type The type of app the company owns.
			Type *CompanyV2AppsXboxType `json:"type,omitempty"`

			// Url The URL to the app.
			Url *string `json:"url,omitempty"`
		} `json:"xbox,omitempty"`
	} `json:"apps,omitempty"`
	Assets *struct {
		// ColorPrimary The primary color of the company.
		ColorPrimary *string `json:"colorPrimary,omitempty"`

		// Cover The cover image of the company.
		Cover *struct {
			// Height The height of the image.
			Height *float32 `json:"height,omitempty"`

			// Src The source of the image.
			Src *string `json:"src,omitempty"`

			// Width The width of the image.
			Width *float32 `json:"width,omitempty"`
		} `json:"cover,omitempty"`

		// LogoSquare The square logo of the company.
		LogoSquare *struct {
			// Height The height of the image.
			Height *float32 `json:"height,omitempty"`

			// Src The source of the image.
			Src *string `json:"src,omitempty"`

			// Width The width of the image.
			Width *float32 `json:"width,omitempty"`
		} `json:"logoSquare,omitempty"`
	} `json:"assets,omitempty"`
	Codes *struct {
		// Naics The NAICS codes of the company.
		Naics *[]string `json:"naics,omitempty"`

		// Sic The SIC codes of the company.
		Sic *[]string `json:"sic,omitempty"`
	} `json:"codes,omitempty"`
	Companies *struct {
		// Acquisitions The acquisitions the company has.
		Acquisitions *[]struct {
			// Description The description of the acquisition.
			Description *string `json:"description,omitempty"`

			// Domain The domain of the acquisition.
			Domain *string `json:"domain,omitempty"`

			// Name The name of the acquisition.
			Name *string `json:"name,omitempty"`
		} `json:"acquisitions,omitempty"`

		// Parent The parent company of the company.
		Parent *struct {
			// Description The description of the parent company.
			Description *string `json:"description,omitempty"`

			// Domain The domain of the parent company.
			Domain *string `json:"domain,omitempty"`

			// Name The name of the parent company.
			Name *string `json:"name,omitempty"`
		} `json:"parent,omitempty"`

		// Subsidiaries The subsidiaries the company has.
		Subsidiaries *[]struct {
			// Description The description of the subsidiary.
			Description *string `json:"description,omitempty"`

			// Domain The domain of the subsidiary.
			Domain *string `json:"domain,omitempty"`

			// Name The name of the subsidiary.
			Name *string `json:"name,omitempty"`
		} `json:"subsidiaries,omitempty"`
	} `json:"companies,omitempty"`
	Contacts *struct {
		// Emails The emails the company has.
		Emails *[]struct {
			// Category The category of the contact.
			Category *CompanyV2ContactsEmailsCategory `json:"category,omitempty"`

			// Value The value of the contact.
			Value *string `json:"value,omitempty"`
		} `json:"emails,omitempty"`

		// Lines The lines the company has.
		Lines *[]struct {
			// Category The category of the contact.
			Category *CompanyV2ContactsLinesCategory `json:"category,omitempty"`

			// Value The value of the contact.
			Value *string `json:"value,omitempty"`
		} `json:"lines,omitempty"`

		// Phones The phones the company has.
		Phones *[]struct {
			// Category The category of the contact.
			Category *CompanyV2ContactsPhonesCategory `json:"category,omitempty"`

			// Value The value of the contact.
			Value *string `json:"value,omitempty"`
		} `json:"phones,omitempty"`

		// Whatsapps The WhatsApp contacts the company has.
		Whatsapps *[]struct {
			// Category The category of the contact.
			Category *CompanyV2ContactsWhatsappsCategory `json:"category,omitempty"`

			// Value The value of the contact.
			Value *string `json:"value,omitempty"`
		} `json:"whatsapps,omitempty"`
	} `json:"contacts,omitempty"`
	Contents *struct {
		// Podcasts The podcasts the company has.
		Podcasts *struct {
			// Apple The Apple podcasts the company has.
			Apple *[]struct {
				// Id The ID of the podcast.
				Id *string `json:"id,omitempty"`

				// Name The name of the podcast.
				Name *string `json:"name,omitempty"`

				// Rating The rating of the podcast.
				Rating *float32 `json:"rating,omitempty"`

				// Reviews The number of reviews the podcast has.
				Reviews *float32 `json:"reviews,omitempty"`

				// Url The URL to the podcast.
				Url *string `json:"url,omitempty"`
			} `json:"apple,omitempty"`

			// Spotify The Spotify podcasts the company has.
			Spotify *[]struct {
				// Id The ID of the podcast.
				Id *string `json:"id,omitempty"`

				// Name The name of the podcast.
				Name *string `json:"name,omitempty"`

				// Rating The rating of the podcast.
				Rating *float32 `json:"rating,omitempty"`

				// Reviews The number of reviews the podcast has.
				Reviews *float32 `json:"reviews,omitempty"`

				// Url The URL to the podcast.
				Url *string `json:"url,omitempty"`
			} `json:"spotify,omitempty"`
		} `json:"podcasts,omitempty"`
	} `json:"contents,omitempty"`
	Descriptions *struct {
		// KnowledgeGraph The knowledge graph of the company.
		KnowledgeGraph *string `json:"knowledgeGraph,omitempty"`

		// Linkedin The LinkedIn description of the company.
		Linkedin *string `json:"linkedin,omitempty"`

		// Primary The primary description of the company.
		Primary *string `json:"primary,omitempty"`

		// Tagline The tagline of the company.
		Tagline *string `json:"tagline,omitempty"`

		// Website The website description of the company.
		Website *string `json:"website,omitempty"`

		// Wikipedia The Wikipedia description of the company.
		Wikipedia *string `json:"wikipedia,omitempty"`
	} `json:"descriptions,omitempty"`
	Domain *struct {
		// Alias The alias used by the origin domain.
		Alias *string `json:"alias,omitempty"`

		// CreatedAt The date the domain was created.
		CreatedAt *string `json:"createdAt,omitempty"`
		Domain    string  `json:"domain"`

		// DomainAlts The alternative domains of the company.
		DomainAlts *[]string `json:"domainAlts,omitempty"`

		// DomainName The name of the domain.
		DomainName *string `json:"domainName,omitempty"`

		// ExpiredAt The date the domain expired.
		ExpiredAt *string `json:"expiredAt,omitempty"`

		// Nsfw The NSFW state of the domain.
		Nsfw *bool `json:"nsfw,omitempty"`

		// Redirection The redirection of the domain.
		Redirection *string `json:"redirection,omitempty"`

		// RegistrantCountry The country of the registrant.
		RegistrantCountry *string `json:"registrantCountry,omitempty"`

		// RegistrantPhone The phone of the registrant.
		RegistrantPhone *string `json:"registrantPhone,omitempty"`

		// Registrar The registrar of the domain.
		Registrar *string `json:"registrar,omitempty"`

		// Root The root domain of the company.
		Root *string `json:"root,omitempty"`

		// State The state of the domain.
		State *CompanyV2DomainState `json:"state,omitempty"`

		// Status The status of the domain.
		Status *float32 `json:"status,omitempty"`

		// Tld The TLD of the domain.
		Tld interface{} `json:"tld,omitempty"`

		// UpdatedAt The date the domain was updated.
		UpdatedAt *string `json:"updatedAt,omitempty"`
	} `json:"domain,omitempty"`
	Finances *struct {
		// Revenue The total revenue the company has.
		Revenue *CompanyV2FinancesRevenue `json:"revenue,omitempty"`

		// StockExchange The stock exchange the company has.
		StockExchange *string `json:"stockExchange,omitempty"`

		// StockSymbol The stock symbol the company has.
		StockSymbol *string `json:"stockSymbol,omitempty"`
	} `json:"finances,omitempty"`
	Id        *string `json:"id,omitempty"`
	Locations *struct {
		// Headquarters The headquarters of the company.
		Headquarters *struct {
			// Address The address of the location.
			Address *struct {
				// Geopoint The geopoint of the address.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Raw The raw complete address.
				Raw *string `json:"raw,omitempty"`
			} `json:"address,omitempty"`

			// City The city of the location.
			City *struct {
				// Code The code of the city.
				Code *string `json:"code,omitempty"`

				// Geopoint The geopoint of the city.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Name The name of the city.
				Name *string `json:"name,omitempty"`

				// Postcode The postcode of the city.
				Postcode *string `json:"postcode,omitempty"`
			} `json:"city,omitempty"`

			// Continent The continent of the location.
			Continent *struct {
				// Code The code of the continent.
				Code *string `json:"code,omitempty"`

				// Geopoint The geopoint of the continent.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Name The name of the continent.
				Name *string `json:"name,omitempty"`
			} `json:"continent,omitempty"`

			// Country The country of the location.
			Country *struct {
				// Code The code of the country.
				Code *string `json:"code,omitempty"`

				// Geopoint The geopoint of the country.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Name The name of the country.
				Name *string `json:"name,omitempty"`
			} `json:"country,omitempty"`

			// County The county of the location.
			County *struct {
				// Code The code of the county.
				Code *string `json:"code,omitempty"`

				// Geopoint The geopoint of the county.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Name The name of the county.
				Name *string `json:"name,omitempty"`
			} `json:"county,omitempty"`

			// State The state of the location.
			State *struct {
				// Code The code of the state.
				Code *string `json:"code,omitempty"`

				// Geopoint The geopoint of the state.
				Geopoint *struct {
					// Lat The latitude of the geopoint.
					Lat float32 `json:"lat"`

					// Lon The longitude of the geopoint.
					Lon float32 `json:"lon"`
				} `json:"geopoint,omitempty"`

				// Name The name of the state.
				Name *string `json:"name,omitempty"`
			} `json:"state,omitempty"`
		} `json:"headquarters,omitempty"`
	} `json:"locations,omitempty"`
	Meta *struct {
		// Cost The cost of the company (not persisted).
		Cost *float32 `json:"cost,omitempty"`

		// Credits The remaining credits of the team after requesting the company (not persisted).
		Credits *float32 `json:"credits,omitempty"`

		// FreeRequest If the company was requested for free (not persisted).
		FreeRequest *bool `json:"freeRequest,omitempty"`

		// Ideated If the company was ideated.
		Ideated *bool `json:"ideated,omitempty"`

		// ListIds The list ids the company is in.
		ListIds *[]float32 `json:"listIds,omitempty"`

		// MysqlId The MySQL ID of the company.
		MysqlId *float32 `json:"mysqlId,omitempty"`

		// New If the company is new (not persisted).
		New *bool `json:"new,omitempty"`

		// Score The data score of the company, generated from the total amount of data available.
		Score *float32 `json:"score,omitempty"`

		// SimilarAttributes The similar attributes between the companies (not persisted).
		SimilarAttributes *[]struct {
			// Attribute The similar attribute name between the companies.
			Attribute string `json:"attribute"`

			// Value The similar attribute value between the companies.
			Value string `json:"value"`
		} `json:"similarAttributes,omitempty"`

		// Similarity The similarity score between the company and the current query (not persisted).
		Similarity *float32 `json:"similarity,omitempty"`

		// Sources If the company has sources, if so how many sources.
		Sources *float32 `json:"sources,omitempty"`

		// SyncedAt The date the data was last synced.
		SyncedAt *string `json:"syncedAt,omitempty"`
	} `json:"meta,omitempty"`
	People      *map[string]interface{} `json:"people,omitempty"`
	Secondaries *struct {
		// EmailPatterns The email patterns the company has.
		EmailPatterns *[]struct {
			// EmailsCount The number of emails the pattern has.
			EmailsCount *float32 `json:"emailsCount,omitempty"`

			// Pattern The pattern of the email.
			Pattern *string `json:"pattern,omitempty"`

			// UsagePercentage The usage percentage of the pattern.
			UsagePercentage *float32 `json:"usagePercentage,omitempty"`
		} `json:"emailPatterns,omitempty"`
	} `json:"secondaries,omitempty"`

	// Socials The social media pages of the company.
	Socials *struct {
		Discord *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"discord,omitempty"`
		Dribbble *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"dribbble,omitempty"`
		Facebook *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"facebook,omitempty"`
		FacebookGroup *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"facebookGroup,omitempty"`
		Github *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"github,omitempty"`
		Instagram *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"instagram,omitempty"`
		Linkedin *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"linkedin,omitempty"`
		Mastodon *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"mastodon,omitempty"`
		Medium *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"medium,omitempty"`
		Patreon *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"patreon,omitempty"`
		Pinterest *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"pinterest,omitempty"`
		Reddit *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"reddit,omitempty"`
		Slack *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"slack,omitempty"`
		Snapchat *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"snapchat,omitempty"`
		Stackoverflow *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"stackoverflow,omitempty"`
		Steam *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"steam,omitempty"`
		Substack *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"substack,omitempty"`
		Threads *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"threads,omitempty"`
		Tiktok *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"tiktok,omitempty"`
		Tumblr *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"tumblr,omitempty"`
		Twitch *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"twitch,omitempty"`
		Twitter *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"twitter,omitempty"`
		Vimeo *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"vimeo,omitempty"`
		Vkontakte *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"vkontakte,omitempty"`
		Wellfound *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"wellfound,omitempty"`
		Xing *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"xing,omitempty"`
		Yelp *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"yelp,omitempty"`
		Youtube *struct {
			// Followers The number of followers the company has.
			Followers *float32 `json:"followers,omitempty"`

			// Following The number of following the company has.
			Following *float32 `json:"following,omitempty"`

			// Id The ID of the company.
			Id *string `json:"id,omitempty"`

			// IdNumeric The numeric ID of the company.
			IdNumeric *string `json:"idNumeric,omitempty"`

			// Likes The number of likes the company has.
			Likes *float32 `json:"likes,omitempty"`

			// Members The number of members the company has.
			Members *float32 `json:"members,omitempty"`

			// MonthlyViews The number of monthly views the company has.
			MonthlyViews *float32 `json:"monthlyViews,omitempty"`

			// Posts The number of posts the company has.
			Posts *float32 `json:"posts,omitempty"`

			// Rating The rating of the company.
			Rating *float32 `json:"rating,omitempty"`

			// Reviews The number of reviews the company has.
			Reviews *float32 `json:"reviews,omitempty"`

			// TalkingAbout The number of people talking about the company.
			TalkingAbout *float32 `json:"talkingAbout,omitempty"`

			// Url The URL to the social media page of the company.
			Url string `json:"url"`

			// Videos The number of videos the company has.
			Videos *float32 `json:"videos,omitempty"`

			// WereHere The number of people who were here.
			WereHere *float32 `json:"wereHere,omitempty"`
		} `json:"youtube,omitempty"`
	} `json:"socials,omitempty"`
	Technologies *struct {
		// Active The active company technologies.
		Active []string `json:"active"`

		// Categories The categories the company technologies are in.
		Categories []string `json:"categories"`

		// Details The details of the company technologies.
		Details []struct {
			// Categories The categories of the technology.
			Categories *[]string `json:"categories,omitempty"`

			// DetectedAt The date the technology was detected.
			DetectedAt string `json:"detectedAt"`

			// DetectionTypes The detection types the technology has.
			DetectionTypes []CompanyV2TechnologiesDetailsDetectionTypes `json:"detectionTypes"`

			// Slug The slug of the technology.
			Slug string `json:"slug"`

			// Version The version of the technology.
			Version *string `json:"version,omitempty"`
		} `json:"details"`
	} `json:"technologies,omitempty"`
	Urls *struct {
		// About The URL to the about page of the company.
		About *string `json:"about,omitempty"`

		// Blog The URL to the blog of the company.
		Blog *string `json:"blog,omitempty"`

		// Careers The URL to the careers page of the company.
		Careers *string `json:"careers,omitempty"`

		// Contact The URL to the contact page of the company.
		Contact *string `json:"contact,omitempty"`

		// Crunchbase The URL to the Crunchbase page of the company.
		Crunchbase *string `json:"crunchbase,omitempty"`

		// Developers The URL to the developers page of the company.
		Developers *string `json:"developers,omitempty"`

		// Docs The URL to the docs of the company.
		Docs *string `json:"docs,omitempty"`

		// Events The URL to the events of the company.
		Events *string `json:"events,omitempty"`

		// Glassdoor The URL to the Glassdoor page of the company.
		Glassdoor *string `json:"glassdoor,omitempty"`

		// Partnership The URL to the partnership page of the company.
		Partnership *string `json:"partnership,omitempty"`

		// Pricing The URL to the pricing page of the company.
		Pricing *string `json:"pricing,omitempty"`

		// Privacy The URL to the privacy policy of the company.
		Privacy *string `json:"privacy,omitempty"`

		// Registrar The URL to the registrar of the domain.
		Registrar *string `json:"registrar,omitempty"`

		// SalesNavigator The URL to the Sales Navigator page of the company.
		SalesNavigator *string `json:"salesNavigator,omitempty"`

		// Sitemap The URL to the sitemap of the company.
		Sitemap *string `json:"sitemap,omitempty"`

		// Status The URL to the status page of the company.
		Status *string `json:"status,omitempty"`

		// Terms The URL to the terms of service of the company.
		Terms *string `json:"terms,omitempty"`

		// Updates The URL to the updates of the company.
		Updates *string `json:"updates,omitempty"`

		// Website The URL to the website of the company.
		Website *string `json:"website,omitempty"`

		// Wellfound The URL to the Wellfound page of the company.
		Wellfound *string `json:"wellfound,omitempty"`

		// Wikidata The URL to the Wikidata page of the company.
		Wikidata *string `json:"wikidata,omitempty"`

		// Wikipedia The URL to the Wikipedia page of the company.
		Wikipedia *string `json:"wikipedia,omitempty"`
	} `json:"urls,omitempty"`
	Vectors *struct {
		// Global The global computed vector.
		Global *[]float32 `json:"global,omitempty"`
	} `json:"vectors,omitempty"`
}

CompanyV2 Our complete schema for company data.

type CompanyV2AboutBusinessType

type CompanyV2AboutBusinessType string

CompanyV2AboutBusinessType The type of business the company is.

const (
	EducationalInstitution CompanyV2AboutBusinessType = "educational-institution"
	GovernmentAgency       CompanyV2AboutBusinessType = "government-agency"
	Nonprofit              CompanyV2AboutBusinessType = "nonprofit"
	Partnership            CompanyV2AboutBusinessType = "partnership"
	PrivatelyHeld          CompanyV2AboutBusinessType = "privately-held"
	PublicCompany          CompanyV2AboutBusinessType = "public-company"
	SelfEmployed           CompanyV2AboutBusinessType = "self-employed"
	SoleProprietorship     CompanyV2AboutBusinessType = "sole-proprietorship"
)

Defines values for CompanyV2AboutBusinessType.

type CompanyV2AboutTotalEmployees

type CompanyV2AboutTotalEmployees string

CompanyV2AboutTotalEmployees The total number of employees the company has.

const (
	N1050   CompanyV2AboutTotalEmployees = "10-50"
	N110    CompanyV2AboutTotalEmployees = "1-10"
	N1k5k   CompanyV2AboutTotalEmployees = "1k-5k"
	N200500 CompanyV2AboutTotalEmployees = "200-500"
	N5001k  CompanyV2AboutTotalEmployees = "500-1k"
	N50200  CompanyV2AboutTotalEmployees = "50-200"
	N5k10k  CompanyV2AboutTotalEmployees = "5k-10k"
	Over10k CompanyV2AboutTotalEmployees = "over-10k"
)

Defines values for CompanyV2AboutTotalEmployees.

type CompanyV2AnalyticsMonthlyVisitors

type CompanyV2AnalyticsMonthlyVisitors string

CompanyV2AnalyticsMonthlyVisitors The total number of monthly visitors the company has.

const (
	CompanyV2AnalyticsMonthlyVisitorsN100k500k CompanyV2AnalyticsMonthlyVisitors = "100k-500k"
	CompanyV2AnalyticsMonthlyVisitorsN100m500m CompanyV2AnalyticsMonthlyVisitors = "100m-500m"
	CompanyV2AnalyticsMonthlyVisitorsN10k50k   CompanyV2AnalyticsMonthlyVisitors = "10k-50k"
	CompanyV2AnalyticsMonthlyVisitorsN10m50m   CompanyV2AnalyticsMonthlyVisitors = "10m-50m"
	CompanyV2AnalyticsMonthlyVisitorsN1m10m    CompanyV2AnalyticsMonthlyVisitors = "1m-10m"
	CompanyV2AnalyticsMonthlyVisitorsN500k1m   CompanyV2AnalyticsMonthlyVisitors = "500k-1m"
	CompanyV2AnalyticsMonthlyVisitorsN500m1b   CompanyV2AnalyticsMonthlyVisitors = "500m-1b"
	CompanyV2AnalyticsMonthlyVisitorsN50k100k  CompanyV2AnalyticsMonthlyVisitors = "50k-100k"
	CompanyV2AnalyticsMonthlyVisitorsN50m100m  CompanyV2AnalyticsMonthlyVisitors = "50m-100m"
	CompanyV2AnalyticsMonthlyVisitorsOver1b    CompanyV2AnalyticsMonthlyVisitors = "over-1b"
	CompanyV2AnalyticsMonthlyVisitorsUnder10k  CompanyV2AnalyticsMonthlyVisitors = "under-10k"
)

Defines values for CompanyV2AnalyticsMonthlyVisitors.

type CompanyV2AppsAmazonType

type CompanyV2AppsAmazonType string

CompanyV2AppsAmazonType The type of app the company owns.

const (
	CompanyV2AppsAmazonTypeApp       CompanyV2AppsAmazonType = "app"
	CompanyV2AppsAmazonTypeDeveloper CompanyV2AppsAmazonType = "developer"
	CompanyV2AppsAmazonTypeExtension CompanyV2AppsAmazonType = "extension"
)

Defines values for CompanyV2AppsAmazonType.

type CompanyV2AppsAndroidType

type CompanyV2AppsAndroidType string

CompanyV2AppsAndroidType The type of app the company owns.

const (
	CompanyV2AppsAndroidTypeApp       CompanyV2AppsAndroidType = "app"
	CompanyV2AppsAndroidTypeDeveloper CompanyV2AppsAndroidType = "developer"
	CompanyV2AppsAndroidTypeExtension CompanyV2AppsAndroidType = "extension"
)

Defines values for CompanyV2AppsAndroidType.

type CompanyV2AppsChromeType

type CompanyV2AppsChromeType string

CompanyV2AppsChromeType The type of app the company owns.

const (
	CompanyV2AppsChromeTypeApp       CompanyV2AppsChromeType = "app"
	CompanyV2AppsChromeTypeDeveloper CompanyV2AppsChromeType = "developer"
	CompanyV2AppsChromeTypeExtension CompanyV2AppsChromeType = "extension"
)

Defines values for CompanyV2AppsChromeType.

type CompanyV2AppsIosType

type CompanyV2AppsIosType string

CompanyV2AppsIosType The type of app the company owns.

const (
	CompanyV2AppsIosTypeApp       CompanyV2AppsIosType = "app"
	CompanyV2AppsIosTypeDeveloper CompanyV2AppsIosType = "developer"
	CompanyV2AppsIosTypeExtension CompanyV2AppsIosType = "extension"
)

Defines values for CompanyV2AppsIosType.

type CompanyV2AppsMacType

type CompanyV2AppsMacType string

CompanyV2AppsMacType The type of app the company owns.

const (
	CompanyV2AppsMacTypeApp       CompanyV2AppsMacType = "app"
	CompanyV2AppsMacTypeDeveloper CompanyV2AppsMacType = "developer"
	CompanyV2AppsMacTypeExtension CompanyV2AppsMacType = "extension"
)

Defines values for CompanyV2AppsMacType.

type CompanyV2AppsMetaType

type CompanyV2AppsMetaType string

CompanyV2AppsMetaType The type of app the company owns.

const (
	CompanyV2AppsMetaTypeApp       CompanyV2AppsMetaType = "app"
	CompanyV2AppsMetaTypeDeveloper CompanyV2AppsMetaType = "developer"
	CompanyV2AppsMetaTypeExtension CompanyV2AppsMetaType = "extension"
)

Defines values for CompanyV2AppsMetaType.

type CompanyV2AppsMicrosoftType

type CompanyV2AppsMicrosoftType string

CompanyV2AppsMicrosoftType The type of app the company owns.

const (
	CompanyV2AppsMicrosoftTypeApp       CompanyV2AppsMicrosoftType = "app"
	CompanyV2AppsMicrosoftTypeDeveloper CompanyV2AppsMicrosoftType = "developer"
	CompanyV2AppsMicrosoftTypeExtension CompanyV2AppsMicrosoftType = "extension"
)

Defines values for CompanyV2AppsMicrosoftType.

type CompanyV2AppsPlaystationType

type CompanyV2AppsPlaystationType string

CompanyV2AppsPlaystationType The type of app the company owns.

const (
	CompanyV2AppsPlaystationTypeApp       CompanyV2AppsPlaystationType = "app"
	CompanyV2AppsPlaystationTypeDeveloper CompanyV2AppsPlaystationType = "developer"
	CompanyV2AppsPlaystationTypeExtension CompanyV2AppsPlaystationType = "extension"
)

Defines values for CompanyV2AppsPlaystationType.

type CompanyV2AppsXboxType

type CompanyV2AppsXboxType string

CompanyV2AppsXboxType The type of app the company owns.

const (
	App       CompanyV2AppsXboxType = "app"
	Developer CompanyV2AppsXboxType = "developer"
	Extension CompanyV2AppsXboxType = "extension"
)

Defines values for CompanyV2AppsXboxType.

type CompanyV2ContactsEmailsCategory

type CompanyV2ContactsEmailsCategory string

CompanyV2ContactsEmailsCategory The category of the contact.

const (
	CompanyV2ContactsEmailsCategoryAccounts     CompanyV2ContactsEmailsCategory = "accounts"
	CompanyV2ContactsEmailsCategoryChannels     CompanyV2ContactsEmailsCategory = "channels"
	CompanyV2ContactsEmailsCategoryGeneral      CompanyV2ContactsEmailsCategory = "general"
	CompanyV2ContactsEmailsCategoryMarketing    CompanyV2ContactsEmailsCategory = "marketing"
	CompanyV2ContactsEmailsCategoryReservations CompanyV2ContactsEmailsCategory = "reservations"
	CompanyV2ContactsEmailsCategorySales        CompanyV2ContactsEmailsCategory = "sales"
	CompanyV2ContactsEmailsCategoryTechnical    CompanyV2ContactsEmailsCategory = "technical"
)

Defines values for CompanyV2ContactsEmailsCategory.

type CompanyV2ContactsLinesCategory

type CompanyV2ContactsLinesCategory string

CompanyV2ContactsLinesCategory The category of the contact.

const (
	CompanyV2ContactsLinesCategoryAccounts     CompanyV2ContactsLinesCategory = "accounts"
	CompanyV2ContactsLinesCategoryChannels     CompanyV2ContactsLinesCategory = "channels"
	CompanyV2ContactsLinesCategoryGeneral      CompanyV2ContactsLinesCategory = "general"
	CompanyV2ContactsLinesCategoryMarketing    CompanyV2ContactsLinesCategory = "marketing"
	CompanyV2ContactsLinesCategoryReservations CompanyV2ContactsLinesCategory = "reservations"
	CompanyV2ContactsLinesCategorySales        CompanyV2ContactsLinesCategory = "sales"
	CompanyV2ContactsLinesCategoryTechnical    CompanyV2ContactsLinesCategory = "technical"
)

Defines values for CompanyV2ContactsLinesCategory.

type CompanyV2ContactsPhonesCategory

type CompanyV2ContactsPhonesCategory string

CompanyV2ContactsPhonesCategory The category of the contact.

const (
	CompanyV2ContactsPhonesCategoryAccounts     CompanyV2ContactsPhonesCategory = "accounts"
	CompanyV2ContactsPhonesCategoryChannels     CompanyV2ContactsPhonesCategory = "channels"
	CompanyV2ContactsPhonesCategoryGeneral      CompanyV2ContactsPhonesCategory = "general"
	CompanyV2ContactsPhonesCategoryMarketing    CompanyV2ContactsPhonesCategory = "marketing"
	CompanyV2ContactsPhonesCategoryReservations CompanyV2ContactsPhonesCategory = "reservations"
	CompanyV2ContactsPhonesCategorySales        CompanyV2ContactsPhonesCategory = "sales"
	CompanyV2ContactsPhonesCategoryTechnical    CompanyV2ContactsPhonesCategory = "technical"
)

Defines values for CompanyV2ContactsPhonesCategory.

type CompanyV2ContactsWhatsappsCategory

type CompanyV2ContactsWhatsappsCategory string

CompanyV2ContactsWhatsappsCategory The category of the contact.

const (
	CompanyV2ContactsWhatsappsCategoryAccounts     CompanyV2ContactsWhatsappsCategory = "accounts"
	CompanyV2ContactsWhatsappsCategoryChannels     CompanyV2ContactsWhatsappsCategory = "channels"
	CompanyV2ContactsWhatsappsCategoryGeneral      CompanyV2ContactsWhatsappsCategory = "general"
	CompanyV2ContactsWhatsappsCategoryMarketing    CompanyV2ContactsWhatsappsCategory = "marketing"
	CompanyV2ContactsWhatsappsCategoryReservations CompanyV2ContactsWhatsappsCategory = "reservations"
	CompanyV2ContactsWhatsappsCategorySales        CompanyV2ContactsWhatsappsCategory = "sales"
	CompanyV2ContactsWhatsappsCategoryTechnical    CompanyV2ContactsWhatsappsCategory = "technical"
)

Defines values for CompanyV2ContactsWhatsappsCategory.

type CompanyV2DomainState

type CompanyV2DomainState string

CompanyV2DomainState The state of the domain.

const (
	Broken     CompanyV2DomainState = "broken"
	ForSale    CompanyV2DomainState = "for-sale"
	Operating  CompanyV2DomainState = "operating"
	Redirected CompanyV2DomainState = "redirected"
)

Defines values for CompanyV2DomainState.

type CompanyV2FinancesRevenue

type CompanyV2FinancesRevenue string

CompanyV2FinancesRevenue The total revenue the company has.

const (
	CompanyV2FinancesRevenueN100m200m CompanyV2FinancesRevenue = "100m-200m"
	CompanyV2FinancesRevenueN10m50m   CompanyV2FinancesRevenue = "10m-50m"
	CompanyV2FinancesRevenueN1m10m    CompanyV2FinancesRevenue = "1m-10m"
	CompanyV2FinancesRevenueN200m1b   CompanyV2FinancesRevenue = "200m-1b"
	CompanyV2FinancesRevenueN50m100m  CompanyV2FinancesRevenue = "50m-100m"
	CompanyV2FinancesRevenueOver1b    CompanyV2FinancesRevenue = "over-1b"
	CompanyV2FinancesRevenueUnder1m   CompanyV2FinancesRevenue = "under-1m"
)

Defines values for CompanyV2FinancesRevenue.

type CompanyV2TechnologiesDetailsDetectionTypes

type CompanyV2TechnologiesDetailsDetectionTypes string

CompanyV2TechnologiesDetailsDetectionTypes The type of detection the company technology has.

const (
	CompanyV2TechnologiesDetailsDetectionTypesCookies         CompanyV2TechnologiesDetailsDetectionTypes = "cookies"
	CompanyV2TechnologiesDetailsDetectionTypesDns             CompanyV2TechnologiesDetailsDetectionTypes = "dns"
	CompanyV2TechnologiesDetailsDetectionTypesEvaluate        CompanyV2TechnologiesDetailsDetectionTypes = "evaluate"
	CompanyV2TechnologiesDetailsDetectionTypesEvaluateBundle  CompanyV2TechnologiesDetailsDetectionTypes = "evaluate-bundle"
	CompanyV2TechnologiesDetailsDetectionTypesEvaluateVersion CompanyV2TechnologiesDetailsDetectionTypes = "evaluate-version"
	CompanyV2TechnologiesDetailsDetectionTypesHeaders         CompanyV2TechnologiesDetailsDetectionTypes = "headers"
	CompanyV2TechnologiesDetailsDetectionTypesMetas           CompanyV2TechnologiesDetailsDetectionTypes = "metas"
	CompanyV2TechnologiesDetailsDetectionTypesScripts         CompanyV2TechnologiesDetailsDetectionTypes = "scripts"
	CompanyV2TechnologiesDetailsDetectionTypesTags            CompanyV2TechnologiesDetailsDetectionTypes = "tags"
	CompanyV2TechnologiesDetailsDetectionTypesUrls            CompanyV2TechnologiesDetailsDetectionTypes = "urls"
	CompanyV2TechnologiesDetailsDetectionTypesVariables       CompanyV2TechnologiesDetailsDetectionTypes = "variables"
)

Defines values for CompanyV2TechnologiesDetailsDetectionTypes.

type CountCompanies401Messages

type CountCompanies401Messages string

type CountCompanies403Messages

type CountCompanies403Messages string

type CountCompaniesParams

type CountCompaniesParams struct {
	ActionId     *float32                            `form:"actionId,omitempty" json:"actionId,omitempty"`
	Query        *[]SegmentationCondition            `form:"query,omitempty" json:"query,omitempty"`
	Search       *string                             `form:"search,omitempty" json:"search,omitempty"`
	SearchFields *[]CountCompaniesParamsSearchFields `form:"searchFields,omitempty" json:"searchFields,omitempty"`
}

CountCompaniesParams defines parameters for CountCompanies.

type CountCompaniesParamsSearchFields

type CountCompaniesParamsSearchFields string

CountCompaniesParamsSearchFields defines parameters for CountCompanies.

const (
	CountCompaniesParamsSearchFieldsAboutName    CountCompaniesParamsSearchFields = "about.name"
	CountCompaniesParamsSearchFieldsDomainDomain CountCompaniesParamsSearchFields = "domain.domain"
)

Defines values for CountCompaniesParamsSearchFields.

type CountCompaniesPost401Messages

type CountCompaniesPost401Messages string

type CountCompaniesPost403Messages

type CountCompaniesPost403Messages string

type CountCompaniesPostJSONBody

type CountCompaniesPostJSONBody struct {
	ActionId     *float32                                  `json:"actionId,omitempty"`
	Query        *[]SegmentationCondition                  `json:"query,omitempty"`
	Search       *string                                   `json:"search,omitempty"`
	SearchFields *[]CountCompaniesPostJSONBodySearchFields `json:"searchFields,omitempty"`
}

CountCompaniesPostJSONBody defines parameters for CountCompaniesPost.

type CountCompaniesPostJSONBodySearchFields

type CountCompaniesPostJSONBodySearchFields string

CountCompaniesPostJSONBodySearchFields defines parameters for CountCompaniesPost.

const (
	CountCompaniesPostJSONBodySearchFieldsAboutName    CountCompaniesPostJSONBodySearchFields = "about.name"
	CountCompaniesPostJSONBodySearchFieldsDomainDomain CountCompaniesPostJSONBodySearchFields = "domain.domain"
)

Defines values for CountCompaniesPostJSONBodySearchFields.

type CountCompaniesPostJSONRequestBody

type CountCompaniesPostJSONRequestBody CountCompaniesPostJSONBody

CountCompaniesPostJSONRequestBody defines body for CountCompaniesPost for application/json ContentType.

type CountCompaniesPostResponse

type CountCompaniesPostResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Count float32 `json:"count"`
	}
	JSON401 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages CountCompaniesPost401Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages CountCompaniesPost403Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
}

func ParseCountCompaniesPostResponse

func ParseCountCompaniesPostResponse(rsp *http.Response) (*CountCompaniesPostResponse, error)

ParseCountCompaniesPostResponse parses an HTTP response from a CountCompaniesPostWithResponse call

func (CountCompaniesPostResponse) Status

Status returns HTTPResponse.Status

func (CountCompaniesPostResponse) StatusCode

func (r CountCompaniesPostResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CountCompaniesResponse

type CountCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Count float32 `json:"count"`
	}
	JSON401 *struct {
		Details  interface{}               `json:"details,omitempty"`
		Messages CountCompanies401Messages `json:"messages"`
		Status   float32                   `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}               `json:"details,omitempty"`
		Messages CountCompanies403Messages `json:"messages"`
		Status   float32                   `json:"status"`
	}
}

func ParseCountCompaniesResponse

func ParseCountCompaniesResponse(rsp *http.Response) (*CountCompaniesResponse, error)

ParseCountCompaniesResponse parses an HTTP response from a CountCompaniesWithResponse call

func (CountCompaniesResponse) Status

func (r CountCompaniesResponse) Status() string

Status returns HTTPResponse.Status

func (CountCompaniesResponse) StatusCode

func (r CountCompaniesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateList401Messages

type CreateList401Messages string

type CreateListJSONBody

type CreateListJSONBody struct {
	Dynamic            *bool                            `json:"dynamic,omitempty"`
	Imported           *bool                            `json:"imported,omitempty"`
	MailFrequency      *CreateListJSONBodyMailFrequency `json:"mailFrequency,omitempty"`
	MaxCompanies       *float32                         `json:"maxCompanies,omitempty"`
	Name               string                           `json:"name"`
	ProcessInitialized *bool                            `json:"processInitialized,omitempty"`
	Query              *[]SegmentationCondition         `json:"query,omitempty"`
	SimilarDomains     *[]string                        `json:"similarDomains,omitempty"`
}

CreateListJSONBody defines parameters for CreateList.

type CreateListJSONBodyMailFrequency

type CreateListJSONBodyMailFrequency string

CreateListJSONBodyMailFrequency defines parameters for CreateList.

const (
	CreateListJSONBodyMailFrequencyDaily    CreateListJSONBodyMailFrequency = "daily"
	CreateListJSONBodyMailFrequencyDisabled CreateListJSONBodyMailFrequency = "disabled"
	CreateListJSONBodyMailFrequencyMonthly  CreateListJSONBodyMailFrequency = "monthly"
	CreateListJSONBodyMailFrequencyWeekly   CreateListJSONBodyMailFrequency = "weekly"
)

Defines values for CreateListJSONBodyMailFrequency.

type CreateListJSONRequestBody

type CreateListJSONRequestBody CreateListJSONBody

CreateListJSONRequestBody defines body for CreateList for application/json ContentType.

type CreateListResponse

type CreateListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *List
	JSON401      *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages CreateList401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseCreateListResponse

func ParseCreateListResponse(rsp *http.Response) (*CreateListResponse, error)

ParseCreateListResponse parses an HTTP response from a CreateListWithResponse call

func (CreateListResponse) Status

func (r CreateListResponse) Status() string

Status returns HTTPResponse.Status

func (CreateListResponse) StatusCode

func (r CreateListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteList400Messages

type DeleteList400Messages string

type DeleteList401Messages

type DeleteList401Messages string

type DeleteList403Messages

type DeleteList403Messages string

type DeleteListResponse

type DeleteListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *List
	JSON400      *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages DeleteList400Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages DeleteList401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages DeleteList403Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseDeleteListResponse

func ParseDeleteListResponse(rsp *http.Response) (*DeleteListResponse, error)

ParseDeleteListResponse parses an HTTP response from a DeleteListWithResponse call

func (DeleteListResponse) Status

func (r DeleteListResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteListResponse) StatusCode

func (r DeleteListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletePrompt400Messages

type DeletePrompt400Messages string

type DeletePrompt401Messages

type DeletePrompt401Messages string

type DeletePrompt403Messages

type DeletePrompt403Messages string

type DeletePromptResponse

type DeletePromptResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Prompt
	JSON400      *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages DeletePrompt400Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages DeletePrompt401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages DeletePrompt403Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseDeletePromptResponse

func ParseDeletePromptResponse(rsp *http.Response) (*DeletePromptResponse, error)

ParseDeletePromptResponse parses an HTTP response from a DeletePromptWithResponse call

func (DeletePromptResponse) Status

func (r DeletePromptResponse) Status() string

Status returns HTTPResponse.Status

func (DeletePromptResponse) StatusCode

func (r DeletePromptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EmailPattern

type EmailPattern struct {
	EmailsCount     *float32 `json:"emailsCount"`
	Id              float32  `json:"id"`
	Pattern         string   `json:"pattern"`
	UsagePercentage *float32 `json:"usagePercentage"`
}

EmailPattern An email pattern and its related informations.

type EnrichJobTitles401Messages

type EnrichJobTitles401Messages string

type EnrichJobTitles2001

type EnrichJobTitles2001 map[string]interface{}

type EnrichJobTitlesParams

type EnrichJobTitlesParams struct {
	Name *string `form:"name,omitempty" json:"name,omitempty"`
}

EnrichJobTitlesParams defines parameters for EnrichJobTitles.

type EnrichJobTitlesResponse

type EnrichJobTitlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// contains filtered or unexported fields
	}
	JSON401 *struct {
		Details  interface{}                `json:"details,omitempty"`
		Messages EnrichJobTitles401Messages `json:"messages"`
		Status   float32                    `json:"status"`
	}
}

func ParseEnrichJobTitlesResponse

func ParseEnrichJobTitlesResponse(rsp *http.Response) (*EnrichJobTitlesResponse, error)

ParseEnrichJobTitlesResponse parses an HTTP response from a EnrichJobTitlesWithResponse call

func (EnrichJobTitlesResponse) Status

func (r EnrichJobTitlesResponse) Status() string

Status returns HTTPResponse.Status

func (EnrichJobTitlesResponse) StatusCode

func (r EnrichJobTitlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
	Details string `json:"details,omitempty"`
}

Error represents an API error response

func (*Error) Error

func (e *Error) Error() string

type ExportCompaniesAnalytics401Messages

type ExportCompaniesAnalytics401Messages string

type ExportCompaniesAnalyticsJSONBody

type ExportCompaniesAnalyticsJSONBody struct {
	ActionId   *float32                                      `json:"actionId,omitempty"`
	Attributes *[]ExportCompaniesAnalyticsJSONBodyAttributes `json:"attributes,omitempty"`
	Format     *ExportCompaniesAnalyticsJSONBodyFormat       `json:"format,omitempty"`
	Full       *bool                                         `json:"full,omitempty"`
	ListId     *float32                                      `json:"listId,omitempty"`
	Query      *[]SegmentationCondition                      `json:"query,omitempty"`
	Size       *float32                                      `json:"size,omitempty"`
	Sort       *ExportCompaniesAnalyticsJSONBodySort         `json:"sort,omitempty"`
}

ExportCompaniesAnalyticsJSONBody defines parameters for ExportCompaniesAnalytics.

type ExportCompaniesAnalyticsJSONBodyAttributes

type ExportCompaniesAnalyticsJSONBodyAttributes string

ExportCompaniesAnalyticsJSONBodyAttributes defines parameters for ExportCompaniesAnalytics.

const (
	ExportCompaniesAnalyticsJSONBodyAttributesAboutBusinessType                  ExportCompaniesAnalyticsJSONBodyAttributes = "about.businessType"
	ExportCompaniesAnalyticsJSONBodyAttributesAboutIndustries                    ExportCompaniesAnalyticsJSONBodyAttributes = "about.industries"
	ExportCompaniesAnalyticsJSONBodyAttributesAboutIndustry                      ExportCompaniesAnalyticsJSONBodyAttributes = "about.industry"
	ExportCompaniesAnalyticsJSONBodyAttributesAboutTotalEmployees                ExportCompaniesAnalyticsJSONBodyAttributes = "about.totalEmployees"
	ExportCompaniesAnalyticsJSONBodyAttributesAboutYearFounded                   ExportCompaniesAnalyticsJSONBodyAttributes = "about.yearFounded"
	ExportCompaniesAnalyticsJSONBodyAttributesAnalyticsMonthlyVisitors           ExportCompaniesAnalyticsJSONBodyAttributes = "analytics.monthlyVisitors"
	ExportCompaniesAnalyticsJSONBodyAttributesApps                               ExportCompaniesAnalyticsJSONBodyAttributes = "apps"
	ExportCompaniesAnalyticsJSONBodyAttributesCodesNaics                         ExportCompaniesAnalyticsJSONBodyAttributes = "codes.naics"
	ExportCompaniesAnalyticsJSONBodyAttributesCodesSic                           ExportCompaniesAnalyticsJSONBodyAttributes = "codes.sic"
	ExportCompaniesAnalyticsJSONBodyAttributesContacts                           ExportCompaniesAnalyticsJSONBodyAttributes = "contacts"
	ExportCompaniesAnalyticsJSONBodyAttributesDomainTld                          ExportCompaniesAnalyticsJSONBodyAttributes = "domain.tld"
	ExportCompaniesAnalyticsJSONBodyAttributesFinancesRevenue                    ExportCompaniesAnalyticsJSONBodyAttributes = "finances.revenue"
	ExportCompaniesAnalyticsJSONBodyAttributesFinancesStockExchange              ExportCompaniesAnalyticsJSONBodyAttributes = "finances.stockExchange"
	ExportCompaniesAnalyticsJSONBodyAttributesLocationsHeadquartersCityCode      ExportCompaniesAnalyticsJSONBodyAttributes = "locations.headquarters.city.code"
	ExportCompaniesAnalyticsJSONBodyAttributesLocationsHeadquartersContinentCode ExportCompaniesAnalyticsJSONBodyAttributes = "locations.headquarters.continent.code"
	ExportCompaniesAnalyticsJSONBodyAttributesLocationsHeadquartersCountryCode   ExportCompaniesAnalyticsJSONBodyAttributes = "locations.headquarters.country.code"
	ExportCompaniesAnalyticsJSONBodyAttributesLocationsHeadquartersCountyCode    ExportCompaniesAnalyticsJSONBodyAttributes = "locations.headquarters.county.code"
	ExportCompaniesAnalyticsJSONBodyAttributesLocationsHeadquartersStateCode     ExportCompaniesAnalyticsJSONBodyAttributes = "locations.headquarters.state.code"
	ExportCompaniesAnalyticsJSONBodyAttributesMetaScore                          ExportCompaniesAnalyticsJSONBodyAttributes = "meta.score"
	ExportCompaniesAnalyticsJSONBodyAttributesMetaSyncedAt                       ExportCompaniesAnalyticsJSONBodyAttributes = "meta.syncedAt"
	ExportCompaniesAnalyticsJSONBodyAttributesSocials                            ExportCompaniesAnalyticsJSONBodyAttributes = "socials"
	ExportCompaniesAnalyticsJSONBodyAttributesTechnologiesActive                 ExportCompaniesAnalyticsJSONBodyAttributes = "technologies.active"
	ExportCompaniesAnalyticsJSONBodyAttributesTechnologiesCategories             ExportCompaniesAnalyticsJSONBodyAttributes = "technologies.categories"
)

Defines values for ExportCompaniesAnalyticsJSONBodyAttributes.

type ExportCompaniesAnalyticsJSONBodyFormat

type ExportCompaniesAnalyticsJSONBodyFormat string

ExportCompaniesAnalyticsJSONBodyFormat defines parameters for ExportCompaniesAnalytics.

Defines values for ExportCompaniesAnalyticsJSONBodyFormat.

type ExportCompaniesAnalyticsJSONBodySort

type ExportCompaniesAnalyticsJSONBodySort string

ExportCompaniesAnalyticsJSONBodySort defines parameters for ExportCompaniesAnalytics.

const (
	ExportCompaniesAnalyticsJSONBodySortAsc  ExportCompaniesAnalyticsJSONBodySort = "asc"
	ExportCompaniesAnalyticsJSONBodySortDesc ExportCompaniesAnalyticsJSONBodySort = "desc"
)

Defines values for ExportCompaniesAnalyticsJSONBodySort.

type ExportCompaniesAnalyticsJSONRequestBody

type ExportCompaniesAnalyticsJSONRequestBody ExportCompaniesAnalyticsJSONBody

ExportCompaniesAnalyticsJSONRequestBody defines body for ExportCompaniesAnalytics for application/json ContentType.

type ExportCompaniesAnalyticsResponse

type ExportCompaniesAnalyticsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []struct {
			Count             float32 `json:"count"`
			Name              string  `json:"name"`
			PercentageOfAll   float32 `json:"percentageOfAll"`
			PercentageOfTotal float32 `json:"percentageOfTotal"`
		} `json:"data"`
		Meta struct {
			ListId          *float32                `json:"listId,omitempty"`
			Query           []SegmentationCondition `json:"query"`
			TotalDatapoints float32                 `json:"totalDatapoints"`
			TotalDocuments  float32                 `json:"totalDocuments"`
			TotalValues     float32                 `json:"totalValues"`
		} `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                         `json:"details,omitempty"`
		Messages ExportCompaniesAnalytics401Messages `json:"messages"`
		Status   float32                             `json:"status"`
	}
}

func ParseExportCompaniesAnalyticsResponse

func ParseExportCompaniesAnalyticsResponse(rsp *http.Response) (*ExportCompaniesAnalyticsResponse, error)

ParseExportCompaniesAnalyticsResponse parses an HTTP response from a ExportCompaniesAnalyticsWithResponse call

func (ExportCompaniesAnalyticsResponse) Status

Status returns HTTPResponse.Status

func (ExportCompaniesAnalyticsResponse) StatusCode

func (r ExportCompaniesAnalyticsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchActions400Messages

type FetchActions400Messages string

type FetchActions401Messages

type FetchActions401Messages string

type FetchActionsParams

type FetchActionsParams struct {
	Full   *bool                     `form:"full,omitempty" json:"full,omitempty"`
	Ids    *[]float32                `form:"ids,omitempty" json:"ids,omitempty"`
	ListId *float32                  `form:"listId,omitempty" json:"listId,omitempty"`
	Page   *float32                  `form:"page,omitempty" json:"page,omitempty"`
	Search *string                   `form:"search,omitempty" json:"search,omitempty"`
	Size   *float32                  `form:"size,omitempty" json:"size,omitempty"`
	Status *FetchActionsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
	TeamId *float32                  `form:"teamId,omitempty" json:"teamId,omitempty"`
	Type   *FetchActionsParamsType   `form:"type,omitempty" json:"type,omitempty"`
}

FetchActionsParams defines parameters for FetchActions.

type FetchActionsParamsStatus

type FetchActionsParamsStatus string

FetchActionsParamsStatus defines parameters for FetchActions.

const (
	Active    FetchActionsParamsStatus = "active"
	Completed FetchActionsParamsStatus = "completed"
	Failed    FetchActionsParamsStatus = "failed"
	Pending   FetchActionsParamsStatus = "pending"
)

Defines values for FetchActionsParamsStatus.

type FetchActionsParamsType

type FetchActionsParamsType string

FetchActionsParamsType defines parameters for FetchActions.

const (
	FetchActionsParamsTypeCompaniesAdded FetchActionsParamsType = "companies:added"
	FetchActionsParamsTypeJobsRequest    FetchActionsParamsType = "jobs:request"
)

Defines values for FetchActionsParamsType.

type FetchActionsResponse

type FetchActionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Actions []Action `json:"actions"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON400 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchActions400Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchActions401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseFetchActionsResponse

func ParseFetchActionsResponse(rsp *http.Response) (*FetchActionsResponse, error)

ParseFetchActionsResponse parses an HTTP response from a FetchActionsWithResponse call

func (FetchActionsResponse) Status

func (r FetchActionsResponse) Status() string

Status returns HTTPResponse.Status

func (FetchActionsResponse) StatusCode

func (r FetchActionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchApiHealthResponse

type FetchApiHealthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Healthy  bool   `json:"healthy"`
		NodeName string `json:"nodeName"`
		Report   map[string]struct {
			DisplayName string `json:"displayName"`
			Health      struct {
				Healthy bool `json:"healthy"`
			} `json:"health"`
		} `json:"report"`
	}
}

func ParseFetchApiHealthResponse

func ParseFetchApiHealthResponse(rsp *http.Response) (*FetchApiHealthResponse, error)

ParseFetchApiHealthResponse parses an HTTP response from a FetchApiHealthWithResponse call

func (FetchApiHealthResponse) Status

func (r FetchApiHealthResponse) Status() string

Status returns HTTPResponse.Status

func (FetchApiHealthResponse) StatusCode

func (r FetchApiHealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompaniesAnalytics401Messages

type FetchCompaniesAnalytics401Messages string

type FetchCompaniesAnalyticsParams

type FetchCompaniesAnalyticsParams struct {
	ActionId  *float32                               `form:"actionId,omitempty" json:"actionId,omitempty"`
	Attribute FetchCompaniesAnalyticsParamsAttribute `form:"attribute" json:"attribute"`
	ListId    *float32                               `form:"listId,omitempty" json:"listId,omitempty"`
	Query     *[]SegmentationCondition               `form:"query,omitempty" json:"query,omitempty"`
	Size      *float32                               `form:"size,omitempty" json:"size,omitempty"`
	Sort      *FetchCompaniesAnalyticsParamsSort     `form:"sort,omitempty" json:"sort,omitempty"`
}

FetchCompaniesAnalyticsParams defines parameters for FetchCompaniesAnalytics.

type FetchCompaniesAnalyticsParamsAttribute

type FetchCompaniesAnalyticsParamsAttribute string

FetchCompaniesAnalyticsParamsAttribute defines parameters for FetchCompaniesAnalytics.

const (
	FetchCompaniesAnalyticsParamsAttributeAboutBusinessType                  FetchCompaniesAnalyticsParamsAttribute = "about.businessType"
	FetchCompaniesAnalyticsParamsAttributeAboutIndustries                    FetchCompaniesAnalyticsParamsAttribute = "about.industries"
	FetchCompaniesAnalyticsParamsAttributeAboutIndustry                      FetchCompaniesAnalyticsParamsAttribute = "about.industry"
	FetchCompaniesAnalyticsParamsAttributeAboutTotalEmployees                FetchCompaniesAnalyticsParamsAttribute = "about.totalEmployees"
	FetchCompaniesAnalyticsParamsAttributeAboutYearFounded                   FetchCompaniesAnalyticsParamsAttribute = "about.yearFounded"
	FetchCompaniesAnalyticsParamsAttributeAnalyticsMonthlyVisitors           FetchCompaniesAnalyticsParamsAttribute = "analytics.monthlyVisitors"
	FetchCompaniesAnalyticsParamsAttributeApps                               FetchCompaniesAnalyticsParamsAttribute = "apps"
	FetchCompaniesAnalyticsParamsAttributeCodesNaics                         FetchCompaniesAnalyticsParamsAttribute = "codes.naics"
	FetchCompaniesAnalyticsParamsAttributeCodesSic                           FetchCompaniesAnalyticsParamsAttribute = "codes.sic"
	FetchCompaniesAnalyticsParamsAttributeContacts                           FetchCompaniesAnalyticsParamsAttribute = "contacts"
	FetchCompaniesAnalyticsParamsAttributeDomainTld                          FetchCompaniesAnalyticsParamsAttribute = "domain.tld"
	FetchCompaniesAnalyticsParamsAttributeFinancesRevenue                    FetchCompaniesAnalyticsParamsAttribute = "finances.revenue"
	FetchCompaniesAnalyticsParamsAttributeFinancesStockExchange              FetchCompaniesAnalyticsParamsAttribute = "finances.stockExchange"
	FetchCompaniesAnalyticsParamsAttributeLocationsHeadquartersCityCode      FetchCompaniesAnalyticsParamsAttribute = "locations.headquarters.city.code"
	FetchCompaniesAnalyticsParamsAttributeLocationsHeadquartersContinentCode FetchCompaniesAnalyticsParamsAttribute = "locations.headquarters.continent.code"
	FetchCompaniesAnalyticsParamsAttributeLocationsHeadquartersCountryCode   FetchCompaniesAnalyticsParamsAttribute = "locations.headquarters.country.code"
	FetchCompaniesAnalyticsParamsAttributeLocationsHeadquartersCountyCode    FetchCompaniesAnalyticsParamsAttribute = "locations.headquarters.county.code"
	FetchCompaniesAnalyticsParamsAttributeLocationsHeadquartersStateCode     FetchCompaniesAnalyticsParamsAttribute = "locations.headquarters.state.code"
	FetchCompaniesAnalyticsParamsAttributeMetaScore                          FetchCompaniesAnalyticsParamsAttribute = "meta.score"
	FetchCompaniesAnalyticsParamsAttributeMetaSyncedAt                       FetchCompaniesAnalyticsParamsAttribute = "meta.syncedAt"
	FetchCompaniesAnalyticsParamsAttributeSocials                            FetchCompaniesAnalyticsParamsAttribute = "socials"
	FetchCompaniesAnalyticsParamsAttributeTechnologiesActive                 FetchCompaniesAnalyticsParamsAttribute = "technologies.active"
	FetchCompaniesAnalyticsParamsAttributeTechnologiesCategories             FetchCompaniesAnalyticsParamsAttribute = "technologies.categories"
)

Defines values for FetchCompaniesAnalyticsParamsAttribute.

type FetchCompaniesAnalyticsParamsSort

type FetchCompaniesAnalyticsParamsSort string

FetchCompaniesAnalyticsParamsSort defines parameters for FetchCompaniesAnalytics.

const (
	FetchCompaniesAnalyticsParamsSortAsc  FetchCompaniesAnalyticsParamsSort = "asc"
	FetchCompaniesAnalyticsParamsSortDesc FetchCompaniesAnalyticsParamsSort = "desc"
)

Defines values for FetchCompaniesAnalyticsParamsSort.

type FetchCompaniesAnalyticsResponse

type FetchCompaniesAnalyticsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []struct {
			Count             float32 `json:"count"`
			Name              string  `json:"name"`
			PercentageOfAll   float32 `json:"percentageOfAll"`
			PercentageOfTotal float32 `json:"percentageOfTotal"`
		} `json:"data"`
		Meta struct {
			ListId          *float32                `json:"listId,omitempty"`
			Query           []SegmentationCondition `json:"query"`
			TotalDatapoints float32                 `json:"totalDatapoints"`
			TotalDocuments  float32                 `json:"totalDocuments"`
			TotalValues     float32                 `json:"totalValues"`
		} `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                        `json:"details,omitempty"`
		Messages FetchCompaniesAnalytics401Messages `json:"messages"`
		Status   float32                            `json:"status"`
	}
}

func ParseFetchCompaniesAnalyticsResponse

func ParseFetchCompaniesAnalyticsResponse(rsp *http.Response) (*FetchCompaniesAnalyticsResponse, error)

ParseFetchCompaniesAnalyticsResponse parses an HTTP response from a FetchCompaniesAnalyticsWithResponse call

func (FetchCompaniesAnalyticsResponse) Status

Status returns HTTPResponse.Status

func (FetchCompaniesAnalyticsResponse) StatusCode

func (r FetchCompaniesAnalyticsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompaniesInList400Messages

type FetchCompaniesInList400Messages string

type FetchCompaniesInList401Messages

type FetchCompaniesInList401Messages string

type FetchCompaniesInList403Messages

type FetchCompaniesInList403Messages string

type FetchCompaniesInListParams

type FetchCompaniesInListParams struct {
	ActionId   *float32                 `form:"actionId,omitempty" json:"actionId,omitempty"`
	Page       *float32                 `form:"page,omitempty" json:"page,omitempty"`
	Query      *[]SegmentationCondition `form:"query,omitempty" json:"query,omitempty"`
	Simplified *bool                    `form:"simplified,omitempty" json:"simplified,omitempty"`
	Size       *float32                 `form:"size,omitempty" json:"size,omitempty"`
	SortFields *[]struct {
		Key     FetchCompaniesInListParamsSortFieldsKey      `json:"key"`
		Missing *FetchCompaniesInListParamsSortFieldsMissing `json:"missing,omitempty"`
		Order   FetchCompaniesInListParamsSortFieldsOrder    `json:"order"`
	} `form:"sortFields,omitempty" json:"sortFields,omitempty"`
	SortKey   *FetchCompaniesInListParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *FetchCompaniesInListParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

FetchCompaniesInListParams defines parameters for FetchCompaniesInList.

type FetchCompaniesInListParamsSortFieldsKey

type FetchCompaniesInListParamsSortFieldsKey string

FetchCompaniesInListParamsSortFieldsKey defines parameters for FetchCompaniesInList.

const (
	FetchCompaniesInListParamsSortFieldsKeyAboutBusinessType                FetchCompaniesInListParamsSortFieldsKey = "about.businessType"
	FetchCompaniesInListParamsSortFieldsKeyAboutIndustries                  FetchCompaniesInListParamsSortFieldsKey = "about.industries"
	FetchCompaniesInListParamsSortFieldsKeyAboutIndustry                    FetchCompaniesInListParamsSortFieldsKey = "about.industry"
	FetchCompaniesInListParamsSortFieldsKeyAboutName                        FetchCompaniesInListParamsSortFieldsKey = "about.name"
	FetchCompaniesInListParamsSortFieldsKeyAboutTotalEmployees              FetchCompaniesInListParamsSortFieldsKey = "about.totalEmployees"
	FetchCompaniesInListParamsSortFieldsKeyAboutYearFounded                 FetchCompaniesInListParamsSortFieldsKey = "about.yearFounded"
	FetchCompaniesInListParamsSortFieldsKeyAnalyticsMonthlyVisitors         FetchCompaniesInListParamsSortFieldsKey = "analytics.monthlyVisitors"
	FetchCompaniesInListParamsSortFieldsKeyApps                             FetchCompaniesInListParamsSortFieldsKey = "apps"
	FetchCompaniesInListParamsSortFieldsKeyCodesNaics                       FetchCompaniesInListParamsSortFieldsKey = "codes.naics"
	FetchCompaniesInListParamsSortFieldsKeyCodesSic                         FetchCompaniesInListParamsSortFieldsKey = "codes.sic"
	FetchCompaniesInListParamsSortFieldsKeyContacts                         FetchCompaniesInListParamsSortFieldsKey = "contacts"
	FetchCompaniesInListParamsSortFieldsKeyDomainDomain                     FetchCompaniesInListParamsSortFieldsKey = "domain.domain"
	FetchCompaniesInListParamsSortFieldsKeyDomainTld                        FetchCompaniesInListParamsSortFieldsKey = "domain.tld"
	FetchCompaniesInListParamsSortFieldsKeyFinancesRevenue                  FetchCompaniesInListParamsSortFieldsKey = "finances.revenue"
	FetchCompaniesInListParamsSortFieldsKeyLocationsHeadquartersCityCode    FetchCompaniesInListParamsSortFieldsKey = "locations.headquarters.city.code"
	FetchCompaniesInListParamsSortFieldsKeyLocationsHeadquartersCountryCode FetchCompaniesInListParamsSortFieldsKey = "locations.headquarters.country.code"
	FetchCompaniesInListParamsSortFieldsKeyLocationsHeadquartersCountyCode  FetchCompaniesInListParamsSortFieldsKey = "locations.headquarters.county.code"
	FetchCompaniesInListParamsSortFieldsKeyLocationsHeadquartersStateCode   FetchCompaniesInListParamsSortFieldsKey = "locations.headquarters.state.code"
	FetchCompaniesInListParamsSortFieldsKeyMetaScore                        FetchCompaniesInListParamsSortFieldsKey = "meta.score"
	FetchCompaniesInListParamsSortFieldsKeyMetaSyncedAt                     FetchCompaniesInListParamsSortFieldsKey = "meta.syncedAt"
	FetchCompaniesInListParamsSortFieldsKeySocials                          FetchCompaniesInListParamsSortFieldsKey = "socials"
	FetchCompaniesInListParamsSortFieldsKeyTechnologiesActive               FetchCompaniesInListParamsSortFieldsKey = "technologies.active"
	FetchCompaniesInListParamsSortFieldsKeyUrls                             FetchCompaniesInListParamsSortFieldsKey = "urls"
)

Defines values for FetchCompaniesInListParamsSortFieldsKey.

type FetchCompaniesInListParamsSortFieldsMissing

type FetchCompaniesInListParamsSortFieldsMissing string

FetchCompaniesInListParamsSortFieldsMissing defines parameters for FetchCompaniesInList.

const (
	FetchCompaniesInListParamsSortFieldsMissingUnderscoreFirst FetchCompaniesInListParamsSortFieldsMissing = "_first"
	FetchCompaniesInListParamsSortFieldsMissingUnderscoreLast  FetchCompaniesInListParamsSortFieldsMissing = "_last"
)

Defines values for FetchCompaniesInListParamsSortFieldsMissing.

type FetchCompaniesInListParamsSortFieldsOrder

type FetchCompaniesInListParamsSortFieldsOrder string

FetchCompaniesInListParamsSortFieldsOrder defines parameters for FetchCompaniesInList.

const (
	FetchCompaniesInListParamsSortFieldsOrderAsc  FetchCompaniesInListParamsSortFieldsOrder = "asc"
	FetchCompaniesInListParamsSortFieldsOrderDesc FetchCompaniesInListParamsSortFieldsOrder = "desc"
)

Defines values for FetchCompaniesInListParamsSortFieldsOrder.

type FetchCompaniesInListParamsSortKey

type FetchCompaniesInListParamsSortKey string

FetchCompaniesInListParamsSortKey defines parameters for FetchCompaniesInList.

const (
	FetchCompaniesInListParamsSortKeyAboutBusinessType                FetchCompaniesInListParamsSortKey = "about.businessType"
	FetchCompaniesInListParamsSortKeyAboutIndustries                  FetchCompaniesInListParamsSortKey = "about.industries"
	FetchCompaniesInListParamsSortKeyAboutIndustry                    FetchCompaniesInListParamsSortKey = "about.industry"
	FetchCompaniesInListParamsSortKeyAboutName                        FetchCompaniesInListParamsSortKey = "about.name"
	FetchCompaniesInListParamsSortKeyAboutTotalEmployees              FetchCompaniesInListParamsSortKey = "about.totalEmployees"
	FetchCompaniesInListParamsSortKeyAboutYearFounded                 FetchCompaniesInListParamsSortKey = "about.yearFounded"
	FetchCompaniesInListParamsSortKeyAnalyticsMonthlyVisitors         FetchCompaniesInListParamsSortKey = "analytics.monthlyVisitors"
	FetchCompaniesInListParamsSortKeyApps                             FetchCompaniesInListParamsSortKey = "apps"
	FetchCompaniesInListParamsSortKeyCodesNaics                       FetchCompaniesInListParamsSortKey = "codes.naics"
	FetchCompaniesInListParamsSortKeyCodesSic                         FetchCompaniesInListParamsSortKey = "codes.sic"
	FetchCompaniesInListParamsSortKeyContacts                         FetchCompaniesInListParamsSortKey = "contacts"
	FetchCompaniesInListParamsSortKeyDomainDomain                     FetchCompaniesInListParamsSortKey = "domain.domain"
	FetchCompaniesInListParamsSortKeyDomainTld                        FetchCompaniesInListParamsSortKey = "domain.tld"
	FetchCompaniesInListParamsSortKeyFinancesRevenue                  FetchCompaniesInListParamsSortKey = "finances.revenue"
	FetchCompaniesInListParamsSortKeyLocationsHeadquartersCityCode    FetchCompaniesInListParamsSortKey = "locations.headquarters.city.code"
	FetchCompaniesInListParamsSortKeyLocationsHeadquartersCountryCode FetchCompaniesInListParamsSortKey = "locations.headquarters.country.code"
	FetchCompaniesInListParamsSortKeyLocationsHeadquartersCountyCode  FetchCompaniesInListParamsSortKey = "locations.headquarters.county.code"
	FetchCompaniesInListParamsSortKeyLocationsHeadquartersStateCode   FetchCompaniesInListParamsSortKey = "locations.headquarters.state.code"
	FetchCompaniesInListParamsSortKeyMetaScore                        FetchCompaniesInListParamsSortKey = "meta.score"
	FetchCompaniesInListParamsSortKeyMetaSyncedAt                     FetchCompaniesInListParamsSortKey = "meta.syncedAt"
	FetchCompaniesInListParamsSortKeySocials                          FetchCompaniesInListParamsSortKey = "socials"
	FetchCompaniesInListParamsSortKeyTechnologiesActive               FetchCompaniesInListParamsSortKey = "technologies.active"
	FetchCompaniesInListParamsSortKeyUrls                             FetchCompaniesInListParamsSortKey = "urls"
)

Defines values for FetchCompaniesInListParamsSortKey.

type FetchCompaniesInListParamsSortOrder

type FetchCompaniesInListParamsSortOrder string

FetchCompaniesInListParamsSortOrder defines parameters for FetchCompaniesInList.

const (
	FetchCompaniesInListParamsSortOrderAsc  FetchCompaniesInListParamsSortOrder = "asc"
	FetchCompaniesInListParamsSortOrderDesc FetchCompaniesInListParamsSortOrder = "desc"
)

Defines values for FetchCompaniesInListParamsSortOrder.

type FetchCompaniesInListPost400Messages

type FetchCompaniesInListPost400Messages string

type FetchCompaniesInListPost401Messages

type FetchCompaniesInListPost401Messages string

type FetchCompaniesInListPost403Messages

type FetchCompaniesInListPost403Messages string

type FetchCompaniesInListPostJSONBody

type FetchCompaniesInListPostJSONBody struct {
	ActionId   *float32                 `json:"actionId,omitempty"`
	Page       *float32                 `json:"page,omitempty"`
	Query      *[]SegmentationCondition `json:"query,omitempty"`
	Simplified *bool                    `json:"simplified,omitempty"`
	Size       *float32                 `json:"size,omitempty"`
	SortFields *[]struct {
		Key     FetchCompaniesInListPostJSONBodySortFieldsKey      `json:"key"`
		Missing *FetchCompaniesInListPostJSONBodySortFieldsMissing `json:"missing,omitempty"`
		Order   FetchCompaniesInListPostJSONBodySortFieldsOrder    `json:"order"`
	} `json:"sortFields,omitempty"`
	SortKey   *FetchCompaniesInListPostJSONBodySortKey   `json:"sortKey,omitempty"`
	SortOrder *FetchCompaniesInListPostJSONBodySortOrder `json:"sortOrder,omitempty"`
}

FetchCompaniesInListPostJSONBody defines parameters for FetchCompaniesInListPost.

type FetchCompaniesInListPostJSONBodySortFieldsKey

type FetchCompaniesInListPostJSONBodySortFieldsKey string

FetchCompaniesInListPostJSONBodySortFieldsKey defines parameters for FetchCompaniesInListPost.

const (
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutBusinessType                FetchCompaniesInListPostJSONBodySortFieldsKey = "about.businessType"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutIndustries                  FetchCompaniesInListPostJSONBodySortFieldsKey = "about.industries"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutIndustry                    FetchCompaniesInListPostJSONBodySortFieldsKey = "about.industry"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutName                        FetchCompaniesInListPostJSONBodySortFieldsKey = "about.name"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutTotalEmployees              FetchCompaniesInListPostJSONBodySortFieldsKey = "about.totalEmployees"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAboutYearFounded                 FetchCompaniesInListPostJSONBodySortFieldsKey = "about.yearFounded"
	FetchCompaniesInListPostJSONBodySortFieldsKeyAnalyticsMonthlyVisitors         FetchCompaniesInListPostJSONBodySortFieldsKey = "analytics.monthlyVisitors"
	FetchCompaniesInListPostJSONBodySortFieldsKeyApps                             FetchCompaniesInListPostJSONBodySortFieldsKey = "apps"
	FetchCompaniesInListPostJSONBodySortFieldsKeyCodesNaics                       FetchCompaniesInListPostJSONBodySortFieldsKey = "codes.naics"
	FetchCompaniesInListPostJSONBodySortFieldsKeyCodesSic                         FetchCompaniesInListPostJSONBodySortFieldsKey = "codes.sic"
	FetchCompaniesInListPostJSONBodySortFieldsKeyContacts                         FetchCompaniesInListPostJSONBodySortFieldsKey = "contacts"
	FetchCompaniesInListPostJSONBodySortFieldsKeyDomainDomain                     FetchCompaniesInListPostJSONBodySortFieldsKey = "domain.domain"
	FetchCompaniesInListPostJSONBodySortFieldsKeyDomainTld                        FetchCompaniesInListPostJSONBodySortFieldsKey = "domain.tld"
	FetchCompaniesInListPostJSONBodySortFieldsKeyFinancesRevenue                  FetchCompaniesInListPostJSONBodySortFieldsKey = "finances.revenue"
	FetchCompaniesInListPostJSONBodySortFieldsKeyLocationsHeadquartersCityCode    FetchCompaniesInListPostJSONBodySortFieldsKey = "locations.headquarters.city.code"
	FetchCompaniesInListPostJSONBodySortFieldsKeyLocationsHeadquartersCountryCode FetchCompaniesInListPostJSONBodySortFieldsKey = "locations.headquarters.country.code"
	FetchCompaniesInListPostJSONBodySortFieldsKeyLocationsHeadquartersCountyCode  FetchCompaniesInListPostJSONBodySortFieldsKey = "locations.headquarters.county.code"
	FetchCompaniesInListPostJSONBodySortFieldsKeyLocationsHeadquartersStateCode   FetchCompaniesInListPostJSONBodySortFieldsKey = "locations.headquarters.state.code"
	FetchCompaniesInListPostJSONBodySortFieldsKeyMetaScore                        FetchCompaniesInListPostJSONBodySortFieldsKey = "meta.score"
	FetchCompaniesInListPostJSONBodySortFieldsKeyMetaSyncedAt                     FetchCompaniesInListPostJSONBodySortFieldsKey = "meta.syncedAt"
	FetchCompaniesInListPostJSONBodySortFieldsKeySocials                          FetchCompaniesInListPostJSONBodySortFieldsKey = "socials"
	FetchCompaniesInListPostJSONBodySortFieldsKeyTechnologiesActive               FetchCompaniesInListPostJSONBodySortFieldsKey = "technologies.active"
	FetchCompaniesInListPostJSONBodySortFieldsKeyUrls                             FetchCompaniesInListPostJSONBodySortFieldsKey = "urls"
)

Defines values for FetchCompaniesInListPostJSONBodySortFieldsKey.

type FetchCompaniesInListPostJSONBodySortFieldsMissing

type FetchCompaniesInListPostJSONBodySortFieldsMissing string

FetchCompaniesInListPostJSONBodySortFieldsMissing defines parameters for FetchCompaniesInListPost.

Defines values for FetchCompaniesInListPostJSONBodySortFieldsMissing.

type FetchCompaniesInListPostJSONBodySortFieldsOrder

type FetchCompaniesInListPostJSONBodySortFieldsOrder string

FetchCompaniesInListPostJSONBodySortFieldsOrder defines parameters for FetchCompaniesInListPost.

const (
	FetchCompaniesInListPostJSONBodySortFieldsOrderAsc  FetchCompaniesInListPostJSONBodySortFieldsOrder = "asc"
	FetchCompaniesInListPostJSONBodySortFieldsOrderDesc FetchCompaniesInListPostJSONBodySortFieldsOrder = "desc"
)

Defines values for FetchCompaniesInListPostJSONBodySortFieldsOrder.

type FetchCompaniesInListPostJSONBodySortKey

type FetchCompaniesInListPostJSONBodySortKey string

FetchCompaniesInListPostJSONBodySortKey defines parameters for FetchCompaniesInListPost.

const (
	AboutBusinessType                FetchCompaniesInListPostJSONBodySortKey = "about.businessType"
	AboutIndustries                  FetchCompaniesInListPostJSONBodySortKey = "about.industries"
	AboutIndustry                    FetchCompaniesInListPostJSONBodySortKey = "about.industry"
	AboutName                        FetchCompaniesInListPostJSONBodySortKey = "about.name"
	AboutTotalEmployees              FetchCompaniesInListPostJSONBodySortKey = "about.totalEmployees"
	AboutYearFounded                 FetchCompaniesInListPostJSONBodySortKey = "about.yearFounded"
	AnalyticsMonthlyVisitors         FetchCompaniesInListPostJSONBodySortKey = "analytics.monthlyVisitors"
	Apps                             FetchCompaniesInListPostJSONBodySortKey = "apps"
	CodesNaics                       FetchCompaniesInListPostJSONBodySortKey = "codes.naics"
	CodesSic                         FetchCompaniesInListPostJSONBodySortKey = "codes.sic"
	Contacts                         FetchCompaniesInListPostJSONBodySortKey = "contacts"
	DomainDomain                     FetchCompaniesInListPostJSONBodySortKey = "domain.domain"
	DomainTld                        FetchCompaniesInListPostJSONBodySortKey = "domain.tld"
	FinancesRevenue                  FetchCompaniesInListPostJSONBodySortKey = "finances.revenue"
	LocationsHeadquartersCityCode    FetchCompaniesInListPostJSONBodySortKey = "locations.headquarters.city.code"
	LocationsHeadquartersCountryCode FetchCompaniesInListPostJSONBodySortKey = "locations.headquarters.country.code"
	LocationsHeadquartersCountyCode  FetchCompaniesInListPostJSONBodySortKey = "locations.headquarters.county.code"
	LocationsHeadquartersStateCode   FetchCompaniesInListPostJSONBodySortKey = "locations.headquarters.state.code"
	MetaScore                        FetchCompaniesInListPostJSONBodySortKey = "meta.score"
	MetaSyncedAt                     FetchCompaniesInListPostJSONBodySortKey = "meta.syncedAt"
	Socials                          FetchCompaniesInListPostJSONBodySortKey = "socials"
	TechnologiesActive               FetchCompaniesInListPostJSONBodySortKey = "technologies.active"
	Urls                             FetchCompaniesInListPostJSONBodySortKey = "urls"
)

Defines values for FetchCompaniesInListPostJSONBodySortKey.

type FetchCompaniesInListPostJSONBodySortOrder

type FetchCompaniesInListPostJSONBodySortOrder string

FetchCompaniesInListPostJSONBodySortOrder defines parameters for FetchCompaniesInListPost.

const (
	FetchCompaniesInListPostJSONBodySortOrderAsc  FetchCompaniesInListPostJSONBodySortOrder = "asc"
	FetchCompaniesInListPostJSONBodySortOrderDesc FetchCompaniesInListPostJSONBodySortOrder = "desc"
)

Defines values for FetchCompaniesInListPostJSONBodySortOrder.

type FetchCompaniesInListPostJSONRequestBody

type FetchCompaniesInListPostJSONRequestBody FetchCompaniesInListPostJSONBody

FetchCompaniesInListPostJSONRequestBody defines body for FetchCompaniesInListPost for application/json ContentType.

type FetchCompaniesInListPostResponse

type FetchCompaniesInListPostResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta  PaginationMeta           `json:"meta"`
		Query *[]SegmentationCondition `json:"query,omitempty"`
	}
	JSON400 *struct {
		Details  interface{}                         `json:"details,omitempty"`
		Messages FetchCompaniesInListPost400Messages `json:"messages"`
		Status   float32                             `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}                         `json:"details,omitempty"`
		Messages FetchCompaniesInListPost401Messages `json:"messages"`
		Status   float32                             `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                         `json:"details,omitempty"`
		Messages FetchCompaniesInListPost403Messages `json:"messages"`
		Status   float32                             `json:"status"`
	}
}

func ParseFetchCompaniesInListPostResponse

func ParseFetchCompaniesInListPostResponse(rsp *http.Response) (*FetchCompaniesInListPostResponse, error)

ParseFetchCompaniesInListPostResponse parses an HTTP response from a FetchCompaniesInListPostWithResponse call

func (FetchCompaniesInListPostResponse) Status

Status returns HTTPResponse.Status

func (FetchCompaniesInListPostResponse) StatusCode

func (r FetchCompaniesInListPostResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompaniesInListResponse

type FetchCompaniesInListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta  PaginationMeta           `json:"meta"`
		Query *[]SegmentationCondition `json:"query,omitempty"`
	}
	JSON400 *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages FetchCompaniesInList400Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages FetchCompaniesInList401Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages FetchCompaniesInList403Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
}

func ParseFetchCompaniesInListResponse

func ParseFetchCompaniesInListResponse(rsp *http.Response) (*FetchCompaniesInListResponse, error)

ParseFetchCompaniesInListResponse parses an HTTP response from a FetchCompaniesInListWithResponse call

func (FetchCompaniesInListResponse) Status

Status returns HTTPResponse.Status

func (FetchCompaniesInListResponse) StatusCode

func (r FetchCompaniesInListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompany401Messages

type FetchCompany401Messages string

type FetchCompany403Messages

type FetchCompany403Messages string

type FetchCompany404Messages

type FetchCompany404Messages string

type FetchCompanyByEmail401Messages

type FetchCompanyByEmail401Messages string

type FetchCompanyByEmail403Messages

type FetchCompanyByEmail403Messages string

type FetchCompanyByEmailParams

type FetchCompanyByEmailParams struct {
	Email      string `form:"email" json:"email"`
	Refresh    *bool  `form:"refresh,omitempty" json:"refresh,omitempty"`
	Simplified *bool  `form:"simplified,omitempty" json:"simplified,omitempty"`
}

FetchCompanyByEmailParams defines parameters for FetchCompanyByEmail.

type FetchCompanyByEmailResponse

type FetchCompanyByEmailResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Company Our complete schema for company data.
		Company *CompanyV2 `json:"company,omitempty"`
		Email   struct {
			Address  *string `json:"address,omitempty"`
			Domain   string  `json:"domain"`
			FullName struct {
				First  *string `json:"first,omitempty"`
				Last   *string `json:"last,omitempty"`
				Middle *string `json:"middle,omitempty"`
			} `json:"fullName"`
			IsDisposable  bool    `json:"isDisposable"`
			IsFree        bool    `json:"isFree"`
			IsSubaddress  bool    `json:"isSubaddress"`
			IsValid       bool    `json:"isValid"`
			IsValidFormat bool    `json:"isValidFormat"`
			Name          string  `json:"name"`
			Pattern       *string `json:"pattern,omitempty"`
		} `json:"email"`
		Meta *struct {
			FreeRequest *bool `json:"freeRequest,omitempty"`
		} `json:"meta,omitempty"`
	}
	JSON401 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages FetchCompanyByEmail401Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages FetchCompanyByEmail403Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
}

func ParseFetchCompanyByEmailResponse

func ParseFetchCompanyByEmailResponse(rsp *http.Response) (*FetchCompanyByEmailResponse, error)

ParseFetchCompanyByEmailResponse parses an HTTP response from a FetchCompanyByEmailWithResponse call

func (FetchCompanyByEmailResponse) Status

Status returns HTTPResponse.Status

func (FetchCompanyByEmailResponse) StatusCode

func (r FetchCompanyByEmailResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompanyBySocial401Messages

type FetchCompanyBySocial401Messages string

type FetchCompanyBySocial403Messages

type FetchCompanyBySocial403Messages string

type FetchCompanyBySocialParams

type FetchCompanyBySocialParams struct {
	Angellist  *string `form:"angellist,omitempty" json:"angellist,omitempty"`
	Dribbble   *string `form:"dribbble,omitempty" json:"dribbble,omitempty"`
	Facebook   *string `form:"facebook,omitempty" json:"facebook,omitempty"`
	Github     *string `form:"github,omitempty" json:"github,omitempty"`
	Instagram  *string `form:"instagram,omitempty" json:"instagram,omitempty"`
	Linkedin   *string `form:"linkedin,omitempty" json:"linkedin,omitempty"`
	Pinterest  *string `form:"pinterest,omitempty" json:"pinterest,omitempty"`
	Refresh    *bool   `form:"refresh,omitempty" json:"refresh,omitempty"`
	Simplified *bool   `form:"simplified,omitempty" json:"simplified,omitempty"`
	Snapchat   *string `form:"snapchat,omitempty" json:"snapchat,omitempty"`
	Souncloud  *string `form:"souncloud,omitempty" json:"souncloud,omitempty"`
	Tiktok     *string `form:"tiktok,omitempty" json:"tiktok,omitempty"`
	Twitter    *string `form:"twitter,omitempty" json:"twitter,omitempty"`
	Wellfound  *string `form:"wellfound,omitempty" json:"wellfound,omitempty"`
	Youtube    *string `form:"youtube,omitempty" json:"youtube,omitempty"`
}

FetchCompanyBySocialParams defines parameters for FetchCompanyBySocial.

type FetchCompanyBySocialResponse

type FetchCompanyBySocialResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyV2
	JSON401      *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages FetchCompanyBySocial401Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages FetchCompanyBySocial403Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
}

func ParseFetchCompanyBySocialResponse

func ParseFetchCompanyBySocialResponse(rsp *http.Response) (*FetchCompanyBySocialResponse, error)

ParseFetchCompanyBySocialResponse parses an HTTP response from a FetchCompanyBySocialWithResponse call

func (FetchCompanyBySocialResponse) Status

Status returns HTTPResponse.Status

func (FetchCompanyBySocialResponse) StatusCode

func (r FetchCompanyBySocialResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompanyContext401Messages

type FetchCompanyContext401Messages string

type FetchCompanyContext403Messages

type FetchCompanyContext403Messages string

type FetchCompanyContext404Messages

type FetchCompanyContext404Messages string

type FetchCompanyContextResponse

type FetchCompanyContextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Context *struct {
			// Company Our complete schema for company data.
			Company *CompanyV2 `json:"company,omitempty"`
			Domain  string     `json:"domain"`

			// Ideated A collection of categorized facts about a company aggregated from multiple sources.
			Ideated *PageContentsIdeated `json:"ideated,omitempty"`
			Sources *[]PageContentsPage  `json:"sources,omitempty"`
		} `json:"context,omitempty"`
		Meta struct {
			Cost   float32 `json:"cost"`
			Tokens float32 `json:"tokens"`
		} `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages FetchCompanyContext401Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages FetchCompanyContext403Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages FetchCompanyContext404Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
}

func ParseFetchCompanyContextResponse

func ParseFetchCompanyContextResponse(rsp *http.Response) (*FetchCompanyContextResponse, error)

ParseFetchCompanyContextResponse parses an HTTP response from a FetchCompanyContextWithResponse call

func (FetchCompanyContextResponse) Status

Status returns HTTPResponse.Status

func (FetchCompanyContextResponse) StatusCode

func (r FetchCompanyContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompanyEmailPatterns401Messages

type FetchCompanyEmailPatterns401Messages string

type FetchCompanyEmailPatterns403Messages

type FetchCompanyEmailPatterns403Messages string

type FetchCompanyEmailPatterns404Messages

type FetchCompanyEmailPatterns404Messages string

type FetchCompanyEmailPatternsParams

type FetchCompanyEmailPatternsParams struct {
	EmailsCount *bool    `form:"emailsCount,omitempty" json:"emailsCount,omitempty"`
	Precision   *float32 `form:"precision,omitempty" json:"precision,omitempty"`
}

FetchCompanyEmailPatternsParams defines parameters for FetchCompanyEmailPatterns.

type FetchCompanyEmailPatternsResponse

type FetchCompanyEmailPatternsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]EmailPattern
	JSON401      *struct {
		Details  interface{}                          `json:"details,omitempty"`
		Messages FetchCompanyEmailPatterns401Messages `json:"messages"`
		Status   float32                              `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                          `json:"details,omitempty"`
		Messages FetchCompanyEmailPatterns403Messages `json:"messages"`
		Status   float32                              `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}                          `json:"details,omitempty"`
		Messages FetchCompanyEmailPatterns404Messages `json:"messages"`
		Status   float32                              `json:"status"`
	}
}

func ParseFetchCompanyEmailPatternsResponse

func ParseFetchCompanyEmailPatternsResponse(rsp *http.Response) (*FetchCompanyEmailPatternsResponse, error)

ParseFetchCompanyEmailPatternsResponse parses an HTTP response from a FetchCompanyEmailPatternsWithResponse call

func (FetchCompanyEmailPatternsResponse) Status

Status returns HTTPResponse.Status

func (FetchCompanyEmailPatternsResponse) StatusCode

func (r FetchCompanyEmailPatternsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompanyInList400Messages

type FetchCompanyInList400Messages string

type FetchCompanyInList401Messages

type FetchCompanyInList401Messages string

type FetchCompanyInList403Messages

type FetchCompanyInList403Messages string

type FetchCompanyInList404Messages

type FetchCompanyInList404Messages string

type FetchCompanyInListResponse

type FetchCompanyInListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyV2
	JSON400      *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages FetchCompanyInList400Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages FetchCompanyInList401Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages FetchCompanyInList403Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages FetchCompanyInList404Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
}

func ParseFetchCompanyInListResponse

func ParseFetchCompanyInListResponse(rsp *http.Response) (*FetchCompanyInListResponse, error)

ParseFetchCompanyInListResponse parses an HTTP response from a FetchCompanyInListWithResponse call

func (FetchCompanyInListResponse) Status

Status returns HTTPResponse.Status

func (FetchCompanyInListResponse) StatusCode

func (r FetchCompanyInListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchCompanyParams

type FetchCompanyParams struct {
	Refresh    *bool `form:"refresh,omitempty" json:"refresh,omitempty"`
	Simplified *bool `form:"simplified,omitempty" json:"simplified,omitempty"`
}

FetchCompanyParams defines parameters for FetchCompany.

type FetchCompanyResponse

type FetchCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyV2
	JSON401      *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchCompany401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchCompany403Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchCompany404Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseFetchCompanyResponse

func ParseFetchCompanyResponse(rsp *http.Response) (*FetchCompanyResponse, error)

ParseFetchCompanyResponse parses an HTTP response from a FetchCompanyWithResponse call

func (FetchCompanyResponse) Status

func (r FetchCompanyResponse) Status() string

Status returns HTTPResponse.Status

func (FetchCompanyResponse) StatusCode

func (r FetchCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchLists401Messages

type FetchLists401Messages string

type FetchListsParams

type FetchListsParams struct {
	Page *float32 `form:"page,omitempty" json:"page,omitempty"`
	Size *float32 `form:"size,omitempty" json:"size,omitempty"`
}

FetchListsParams defines parameters for FetchLists.

type FetchListsResponse

type FetchListsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Lists []List `json:"lists"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages FetchLists401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseFetchListsResponse

func ParseFetchListsResponse(rsp *http.Response) (*FetchListsResponse, error)

ParseFetchListsResponse parses an HTTP response from a FetchListsWithResponse call

func (FetchListsResponse) Status

func (r FetchListsResponse) Status() string

Status returns HTTPResponse.Status

func (FetchListsResponse) StatusCode

func (r FetchListsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchOpenApiResponse

type FetchOpenApiResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseFetchOpenApiResponse

func ParseFetchOpenApiResponse(rsp *http.Response) (*FetchOpenApiResponse, error)

ParseFetchOpenApiResponse parses an HTTP response from a FetchOpenApiWithResponse call

func (FetchOpenApiResponse) Status

func (r FetchOpenApiResponse) Status() string

Status returns HTTPResponse.Status

func (FetchOpenApiResponse) StatusCode

func (r FetchOpenApiResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchPrompts401Messages

type FetchPrompts401Messages string

type FetchPromptsParams

type FetchPromptsParams struct {
	CompanyId *float32                   `form:"companyId,omitempty" json:"companyId,omitempty"`
	Context   *FetchPromptsParamsContext `form:"context,omitempty" json:"context,omitempty"`
	Feature   *FetchPromptsParamsFeature `form:"feature,omitempty" json:"feature,omitempty"`
	Limit     *float32                   `form:"limit,omitempty" json:"limit,omitempty"`
	ListId    *float32                   `form:"listId,omitempty" json:"listId,omitempty"`
	Model     *FetchPromptsParamsModel   `form:"model,omitempty" json:"model,omitempty"`
	Page      *float32                   `form:"page,omitempty" json:"page,omitempty"`
	Prompt    *string                    `form:"prompt,omitempty" json:"prompt,omitempty"`
	Search    *string                    `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                   `form:"size,omitempty" json:"size,omitempty"`
}

FetchPromptsParams defines parameters for FetchPrompts.

type FetchPromptsParamsContext

type FetchPromptsParamsContext string

FetchPromptsParamsContext defines parameters for FetchPrompts.

const (
	FetchPromptsParamsContextAnalytics     FetchPromptsParamsContext = "analytics"
	FetchPromptsParamsContextApi           FetchPromptsParamsContext = "api"
	FetchPromptsParamsContextCompanies     FetchPromptsParamsContext = "companies"
	FetchPromptsParamsContextCompany       FetchPromptsParamsContext = "company"
	FetchPromptsParamsContextDocumentation FetchPromptsParamsContext = "documentation"
	FetchPromptsParamsContextEnrichment    FetchPromptsParamsContext = "enrichment"
	FetchPromptsParamsContextLanding       FetchPromptsParamsContext = "landing"
	FetchPromptsParamsContextList          FetchPromptsParamsContext = "list"
	FetchPromptsParamsContextSimilarity    FetchPromptsParamsContext = "similarity"
)

Defines values for FetchPromptsParamsContext.

type FetchPromptsParamsFeature

type FetchPromptsParamsFeature string

FetchPromptsParamsFeature defines parameters for FetchPrompts.

const (
	FetchPromptsParamsFeatureAsk     FetchPromptsParamsFeature = "ask"
	FetchPromptsParamsFeatureCleanup FetchPromptsParamsFeature = "cleanup"
	FetchPromptsParamsFeatureEnrich  FetchPromptsParamsFeature = "enrich"
	FetchPromptsParamsFeatureProduct FetchPromptsParamsFeature = "product"
	FetchPromptsParamsFeatureSearch  FetchPromptsParamsFeature = "search"
	FetchPromptsParamsFeatureSimilar FetchPromptsParamsFeature = "similar"
)

Defines values for FetchPromptsParamsFeature.

type FetchPromptsParamsModel

type FetchPromptsParamsModel string

FetchPromptsParamsModel defines parameters for FetchPrompts.

const (
	FetchPromptsParamsModelLarge FetchPromptsParamsModel = "large"
	FetchPromptsParamsModelSmall FetchPromptsParamsModel = "small"
)

Defines values for FetchPromptsParamsModel.

type FetchPromptsResponse

type FetchPromptsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Meta Metadata about a paginated or billed response.
		Meta    PaginationMeta `json:"meta"`
		Prompts []Prompt       `json:"prompts"`
	}
	JSON401 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages FetchPrompts401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseFetchPromptsResponse

func ParseFetchPromptsResponse(rsp *http.Response) (*FetchPromptsResponse, error)

ParseFetchPromptsResponse parses an HTTP response from a FetchPromptsWithResponse call

func (FetchPromptsResponse) Status

func (r FetchPromptsResponse) Status() string

Status returns HTTPResponse.Status

func (FetchPromptsResponse) StatusCode

func (r FetchPromptsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchTeam401Messages

type FetchTeam401Messages string

type FetchTeam403Messages

type FetchTeam403Messages string

type FetchTeam404Messages

type FetchTeam404Messages string

type FetchTeamResponse

type FetchTeamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Team
	JSON401      *struct {
		Details  interface{}          `json:"details,omitempty"`
		Messages FetchTeam401Messages `json:"messages"`
		Status   float32              `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}          `json:"details,omitempty"`
		Messages FetchTeam403Messages `json:"messages"`
		Status   float32              `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}          `json:"details,omitempty"`
		Messages FetchTeam404Messages `json:"messages"`
		Status   float32              `json:"status"`
	}
}

func ParseFetchTeamResponse

func ParseFetchTeamResponse(rsp *http.Response) (*FetchTeamResponse, error)

ParseFetchTeamResponse parses an HTTP response from a FetchTeamWithResponse call

func (FetchTeamResponse) Status

func (r FetchTeamResponse) Status() string

Status returns HTTPResponse.Status

func (FetchTeamResponse) StatusCode

func (r FetchTeamResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FetchUser401Messages

type FetchUser401Messages string

type FetchUserResponse

type FetchUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *User
	JSON401      *struct {
		Details  interface{}          `json:"details,omitempty"`
		Messages FetchUser401Messages `json:"messages"`
		Status   float32              `json:"status"`
	}
}

func ParseFetchUserResponse

func ParseFetchUserResponse(rsp *http.Response) (*FetchUserResponse, error)

ParseFetchUserResponse parses an HTTP response from a FetchUserWithResponse call

func (FetchUserResponse) Status

func (r FetchUserResponse) Status() string

Status returns HTTPResponse.Status

func (FetchUserResponse) StatusCode

func (r FetchUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JobTitle

type JobTitle struct {
	Department              *string  `json:"department"`
	DepartmentSecondary     *string  `json:"departmentSecondary"`
	Id                      *float32 `json:"id,omitempty"`
	LinkedinCount           *float32 `json:"linkedinCount"`
	Name                    string   `json:"name"`
	NameEs                  *string  `json:"nameEs"`
	NameFr                  *string  `json:"nameFr"`
	SeniorityLevel          *string  `json:"seniorityLevel"`
	SeniorityLevelSecondary *string  `json:"seniorityLevelSecondary"`
	UsageCount              *float32 `json:"usageCount"`
}

JobTitle A job title and its related informations.

type LLMAnswer

type LLMAnswer struct {
	CompanyId   float32 `json:"companyId"`
	Explanation *string `json:"explanation,omitempty"`
	Fields      *[]struct {
		Description *string             `json:"description,omitempty"`
		Key         string              `json:"key"`
		Type        LLMAnswerFieldsType `json:"type"`
		Values      *[]string           `json:"values,omitempty"`
	} `json:"fields,omitempty"`
	Grounded *bool                  `json:"grounded,omitempty"`
	Output   map[string]interface{} `json:"output"`
	Question string                 `json:"question"`
	Score    float32                `json:"score"`
}

LLMAnswer An answer from a query made to the LLM.

type LLMAnswerFieldsType

type LLMAnswerFieldsType string

LLMAnswerFieldsType defines model for LLMAnswer.Fields.Type.

const (
	LLMAnswerFieldsTypeArrayboolean LLMAnswerFieldsType = "array|boolean"
	LLMAnswerFieldsTypeArraynumber  LLMAnswerFieldsType = "array|number"
	LLMAnswerFieldsTypeArraystring  LLMAnswerFieldsType = "array|string"
	LLMAnswerFieldsTypeBoolean      LLMAnswerFieldsType = "boolean"
	LLMAnswerFieldsTypeNumber       LLMAnswerFieldsType = "number"
	LLMAnswerFieldsTypeString       LLMAnswerFieldsType = "string"
)

Defines values for LLMAnswerFieldsType.

type List

type List struct {
	// Analytics Analytics collection of a list.
	Analytics          *ListAnalytics                  `json:"analytics,omitempty"`
	CompanyListId      *float32                        `json:"companyListId"`
	CreatedAt          *string                         `json:"createdAt"`
	Dynamic            *bool                           `json:"dynamic"`
	Exporting          bool                            `json:"exporting"`
	ExportingAt        *string                         `json:"exportingAt"`
	Id                 float32                         `json:"id"`
	Imported           bool                            `json:"imported"`
	MailFrequencies    *map[string]ListMailFrequencies `json:"mailFrequencies"`
	MaxCompanies       *float32                        `json:"maxCompanies"`
	Name               string                          `json:"name"`
	ProcessActive      bool                            `json:"processActive"`
	ProcessDisabled    *bool                           `json:"processDisabled"`
	ProcessInitialized bool                            `json:"processInitialized"`
	ProcessMessage     *string                         `json:"processMessage"`
	ProcessingAt       *string                         `json:"processingAt"`
	Query              *[]SegmentationCondition        `json:"query,omitempty"`
	QuerySimilar       []string                        `json:"querySimilar"`
	TeamId             *string                         `json:"teamId"`
	UnseenActions      *[]Action                       `json:"unseenActions,omitempty"`
	UserId             *float32                        `json:"userId"`
	Vectors            *[][]float32                    `json:"vectors,omitempty"`
}

List A collection of companies saved or imported by a team.

type ListAnalytics

type ListAnalytics struct {
	CompaniesCount *float32 `json:"companiesCount"`
	Id             *float32 `json:"id,omitempty"`
	ListId         *float32 `json:"listId"`
}

ListAnalytics Analytics collection of a list.

type ListMailFrequencies

type ListMailFrequencies string

ListMailFrequencies defines model for List.MailFrequencies.

const (
	ListMailFrequenciesDaily    ListMailFrequencies = "daily"
	ListMailFrequenciesDisabled ListMailFrequencies = "disabled"
	ListMailFrequenciesMonthly  ListMailFrequencies = "monthly"
	ListMailFrequenciesWeekly   ListMailFrequencies = "weekly"
)

Defines values for ListMailFrequencies.

type NominatimCity

type NominatimCity struct {
	Code               string   `json:"code"`
	CompaniesCount     *float32 `json:"companiesCount"`
	Id                 float32  `json:"id"`
	Latitude           *string  `json:"latitude"`
	LinkedinHeadline   *string  `json:"linkedinHeadline"`
	LinkedinId         *string  `json:"linkedinId"`
	LinkedinQuery      *string  `json:"linkedinQuery"`
	Longitude          *string  `json:"longitude"`
	Name               string   `json:"name"`
	NominatimCountryId *float32 `json:"nominatimCountryId"`
	NominatimCountyId  *float32 `json:"nominatimCountyId"`
	NominatimStateId   *float32 `json:"nominatimStateId"`
	Postcode           *string  `json:"postcode"`
	UsageCount         *float32 `json:"usageCount"`
}

NominatimCity A city from the Nominatim API.

type NominatimContinent

type NominatimContinent struct {
	CitiesCount      *float32               `json:"citiesCount"`
	Code             NominatimContinentCode `json:"code"`
	CompaniesCount   *float32               `json:"companiesCount"`
	CountiesCount    *float32               `json:"countiesCount"`
	CountriesCount   *float32               `json:"countriesCount"`
	Icon             *string                `json:"icon"`
	Id               float32                `json:"id"`
	Latitude         *string                `json:"latitude"`
	LinkedinHeadline *string                `json:"linkedinHeadline"`
	LinkedinId       *string                `json:"linkedinId"`
	Longitude        *string                `json:"longitude"`
	Name             string                 `json:"name"`
	NameEs           string                 `json:"nameEs"`
	NameFr           string                 `json:"nameFr"`
	StatesCount      *float32               `json:"statesCount"`
	UsageCount       *float32               `json:"usageCount"`
}

NominatimContinent A continent from the Nominatim API.

type NominatimContinentCode

type NominatimContinentCode string

NominatimContinentCode defines model for NominatimContinent.Code.

const (
	NominatimContinentCodeAf NominatimContinentCode = "af"
	NominatimContinentCodeAn NominatimContinentCode = "an"
	NominatimContinentCodeAs NominatimContinentCode = "as"
	NominatimContinentCodeEu NominatimContinentCode = "eu"
	NominatimContinentCodeNa NominatimContinentCode = "na"
	NominatimContinentCodeOc NominatimContinentCode = "oc"
	NominatimContinentCodeSa NominatimContinentCode = "sa"
)

Defines values for NominatimContinentCode.

type NominatimCountry

type NominatimCountry struct {
	CitiesCount      *float32                       `json:"citiesCount"`
	Code             string                         `json:"code"`
	CompaniesCount   *float32                       `json:"companiesCount"`
	Continent        *NominatimCountryContinent     `json:"continent"`
	ContinentCode    *NominatimCountryContinentCode `json:"continentCode"`
	CountiesCount    *float32                       `json:"countiesCount"`
	Id               float32                        `json:"id"`
	Latitude         *string                        `json:"latitude"`
	LinkedinHeadline *string                        `json:"linkedinHeadline"`
	LinkedinId       *string                        `json:"linkedinId"`
	Longitude        *string                        `json:"longitude"`
	Name             string                         `json:"name"`
	NameEs           string                         `json:"nameEs"`
	NameFr           string                         `json:"nameFr"`
	NameNative       string                         `json:"nameNative"`
	Population       *float32                       `json:"population"`
	StatesCount      *float32                       `json:"statesCount"`
	UsageCount       *float32                       `json:"usageCount"`
}

NominatimCountry A country from the Nominatim API.

type NominatimCountryContinent

type NominatimCountryContinent string

NominatimCountryContinent defines model for NominatimCountry.Continent.

const (
	Africa       NominatimCountryContinent = "Africa"
	Antarctica   NominatimCountryContinent = "Antarctica"
	Asia         NominatimCountryContinent = "Asia"
	Europe       NominatimCountryContinent = "Europe"
	NorthAmerica NominatimCountryContinent = "North America"
	Oceania      NominatimCountryContinent = "Oceania"
	SouthAmerica NominatimCountryContinent = "South America"
)

Defines values for NominatimCountryContinent.

type NominatimCountryContinentCode

type NominatimCountryContinentCode string

NominatimCountryContinentCode defines model for NominatimCountry.ContinentCode.

const (
	NominatimCountryContinentCodeAf NominatimCountryContinentCode = "af"
	NominatimCountryContinentCodeAn NominatimCountryContinentCode = "an"
	NominatimCountryContinentCodeAs NominatimCountryContinentCode = "as"
	NominatimCountryContinentCodeEu NominatimCountryContinentCode = "eu"
	NominatimCountryContinentCodeNa NominatimCountryContinentCode = "na"
	NominatimCountryContinentCodeOc NominatimCountryContinentCode = "oc"
	NominatimCountryContinentCodeSa NominatimCountryContinentCode = "sa"
)

Defines values for NominatimCountryContinentCode.

type NominatimCounty

type NominatimCounty struct {
	CitiesCount        *float32 `json:"citiesCount"`
	Code               string   `json:"code"`
	CompaniesCount     *float32 `json:"companiesCount"`
	Id                 float32  `json:"id"`
	Latitude           *string  `json:"latitude"`
	LinkedinHeadline   *string  `json:"linkedinHeadline"`
	LinkedinId         *string  `json:"linkedinId"`
	LinkedinQuery      *string  `json:"linkedinQuery"`
	Longitude          *string  `json:"longitude"`
	Name               string   `json:"name"`
	NominatimCountryId *float32 `json:"nominatimCountryId"`
	NominatimStateId   *float32 `json:"nominatimStateId"`
	UsageCount         *float32 `json:"usageCount"`
}

NominatimCounty A county from the Nominatim API.

type NominatimState

type NominatimState struct {
	CitiesCount        *float32 `json:"citiesCount"`
	Code               string   `json:"code"`
	CompaniesCount     *float32 `json:"companiesCount"`
	CountiesCount      *float32 `json:"countiesCount"`
	Id                 float32  `json:"id"`
	Latitude           *string  `json:"latitude"`
	LinkedinHeadline   *string  `json:"linkedinHeadline"`
	LinkedinId         *string  `json:"linkedinId"`
	LinkedinQuery      *string  `json:"linkedinQuery"`
	Longitude          *string  `json:"longitude"`
	Name               string   `json:"name"`
	NominatimCountryId *float32 `json:"nominatimCountryId"`
	UsageCount         *float32 `json:"usageCount"`
}

NominatimState A state from the Nominatim API.

type PageContentsIdeated

type PageContentsIdeated struct {
	About        *[]string `json:"about,omitempty"`
	Acquired     *[]string `json:"acquired,omitempty"`
	Broken       *bool     `json:"broken,omitempty"`
	Closed       *bool     `json:"closed,omitempty"`
	Contacts     *[]string `json:"contacts,omitempty"`
	Customers    *[]string `json:"customers,omitempty"`
	Domain       *string   `json:"domain,omitempty"`
	Features     *[]string `json:"features,omitempty"`
	Finances     *[]string `json:"finances,omitempty"`
	ForSale      *bool     `json:"forSale,omitempty"`
	Industries   *[]string `json:"industries,omitempty"`
	Jobs         *[]string `json:"jobs,omitempty"`
	Locations    *[]string `json:"locations,omitempty"`
	Nsfw         *bool     `json:"nsfw,omitempty"`
	Others       *[]string `json:"others,omitempty"`
	Pricing      *[]string `json:"pricing,omitempty"`
	Related      *[]string `json:"related,omitempty"`
	Resources    *[]string `json:"resources,omitempty"`
	Security     *[]string `json:"security,omitempty"`
	Social       *[]string `json:"social,omitempty"`
	Solutions    *[]string `json:"solutions,omitempty"`
	Sources      *[]string `json:"sources,omitempty"`
	Support      *[]string `json:"support,omitempty"`
	Team         *[]string `json:"team,omitempty"`
	Technologies *[]string `json:"technologies,omitempty"`
	Tokens       *float32  `json:"tokens,omitempty"`
	UpdatedAt    *string   `json:"updatedAt,omitempty"`
	Updates      *[]string `json:"updates,omitempty"`
}

PageContentsIdeated A collection of categorized facts about a company aggregated from multiple sources.

type PageContentsLink struct {
	Text *string `json:"text,omitempty"`
	Url  string  `json:"url"`
}

PageContentsLink A link found in a page content.

type PageContentsPage

type PageContentsPage struct {
	Content     *string             `json:"content,omitempty"`
	Description *string             `json:"description,omitempty"`
	Externals   *[]PageContentsLink `json:"externals,omitempty"`
	Html        *string             `json:"html,omitempty"`
	Navigation  *[]PageContentsLink `json:"navigation,omitempty"`
	Title       *string             `json:"title,omitempty"`
	Url         string              `json:"url"`
	VisitedAt   *string             `json:"visitedAt,omitempty"`
}

PageContentsPage A page content saved as a source for a company context.

type PaginationMeta

type PaginationMeta struct {
	Cost                    float32 `json:"cost"`
	Credits                 float32 `json:"credits"`
	CurrentPage             float32 `json:"currentPage"`
	FirstPage               float32 `json:"firstPage"`
	FreeRequest             bool    `json:"freeRequest"`
	LastPage                float32 `json:"lastPage"`
	MaxScrollResultsReached *bool   `json:"maxScrollResultsReached,omitempty"`
	PerPage                 float32 `json:"perPage"`
	Total                   float32 `json:"total"`
}

PaginationMeta Metadata about a paginated or billed response.

type ProductPrompt200Response0

type ProductPrompt200Response0 struct {
	Action *struct {
		Cost *float32 `json:"cost,omitempty"`
		Data *struct {
			// Answer An answer from a query made to the LLM.
			Answer  LLMAnswer `json:"answer"`
			Domains *[]string `json:"domains,omitempty"`
			Fields  []struct {
				Description *string                                       `json:"description,omitempty"`
				Key         string                                        `json:"key"`
				Type        ProductPrompt200Response0ActionDataFieldsType `json:"type"`
				Values      *[]string                                     `json:"values,omitempty"`
			} `json:"fields"`
			Job      ProductPrompt200Response0ActionDataJob `json:"job"`
			Query    *[]SegmentationCondition               `json:"query,omitempty"`
			Question string                                 `json:"question"`
		} `json:"data,omitempty"`
		ListId   *float32                              `json:"listId,omitempty"`
		PromptId float32                               `json:"promptId"`
		Status   ProductPrompt200Response0ActionStatus `json:"status"`
		Type     ProductPrompt200Response0ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool `json:"all,omitempty"`
	Answer *struct {
		Explanation *string                `json:"explanation,omitempty"`
		Output      map[string]interface{} `json:"output"`
		Score       float32                `json:"score"`
	} `json:"answer,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

type ProductPrompt200Response0ActionDataFieldsType

type ProductPrompt200Response0ActionDataFieldsType string

type ProductPrompt200Response0ActionDataJob

type ProductPrompt200Response0ActionDataJob string

type ProductPrompt200Response0ActionStatus

type ProductPrompt200Response0ActionStatus string

type ProductPrompt200Response0ActionType

type ProductPrompt200Response0ActionType string

type ProductPrompt200Response1

type ProductPrompt200Response1 struct {
	Action *struct {
		Cost *ProductPrompt200Response1ActionCost `json:"cost,omitempty"`
		Data *struct {
			Domains *[]string                              `json:"domains,omitempty"`
			Job     ProductPrompt200Response1ActionDataJob `json:"job"`
			Query   *[]SegmentationCondition               `json:"query,omitempty"`
		} `json:"data,omitempty"`
		ListId   *float32                              `json:"listId,omitempty"`
		PromptId float32                               `json:"promptId"`
		Status   ProductPrompt200Response1ActionStatus `json:"status"`
		Type     ProductPrompt200Response1ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool    `json:"all,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

type ProductPrompt200Response1ActionCost

type ProductPrompt200Response1ActionCost float32

type ProductPrompt200Response1ActionDataJob

type ProductPrompt200Response1ActionDataJob string

type ProductPrompt200Response1ActionStatus

type ProductPrompt200Response1ActionStatus string

type ProductPrompt200Response1ActionType

type ProductPrompt200Response1ActionType string

type ProductPrompt200Response2

type ProductPrompt200Response2 struct {
	Action *struct {
		Cost *float32 `json:"cost,omitempty"`
		Data struct {
			Domains *[]string                              `json:"domains,omitempty"`
			Job     ProductPrompt200Response2ActionDataJob `json:"job"`
			Query   *[]SegmentationCondition               `json:"query,omitempty"`
		} `json:"data"`
		ListId   *float32                              `json:"listId,omitempty"`
		PromptId float32                               `json:"promptId"`
		Status   ProductPrompt200Response2ActionStatus `json:"status"`
		Type     ProductPrompt200Response2ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool    `json:"all,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

type ProductPrompt200Response2ActionDataJob

type ProductPrompt200Response2ActionDataJob string

type ProductPrompt200Response2ActionStatus

type ProductPrompt200Response2ActionStatus string

type ProductPrompt200Response2ActionType

type ProductPrompt200Response2ActionType string

type ProductPrompt200Response3

type ProductPrompt200Response3 struct {
	All     *bool                    `json:"all,omitempty"`
	Cost    *float32                 `json:"cost,omitempty"`
	Count   *float32                 `json:"count,omitempty"`
	Domain  *string                  `json:"domain,omitempty"`
	Domains *[]string                `json:"domains,omitempty"`
	Error   *string                  `json:"error,omitempty"`
	ListId  *float32                 `json:"listId,omitempty"`
	Query   *[]SegmentationCondition `json:"query,omitempty"`
}

type ProductPrompt200Response4

type ProductPrompt200Response4 struct {
	All     *bool     `json:"all,omitempty"`
	Cost    *float32  `json:"cost,omitempty"`
	Count   *float32  `json:"count,omitempty"`
	Domain  *string   `json:"domain,omitempty"`
	Domains *[]string `json:"domains,omitempty"`
	Error   *string   `json:"error,omitempty"`
}

type ProductPrompt401Messages

type ProductPrompt401Messages string

type ProductPrompt403Messages

type ProductPrompt403Messages string

type ProductPromptJSONBody

type ProductPromptJSONBody struct {
	CompanyId *float32                      `json:"companyId,omitempty"`
	Context   *ProductPromptJSONBodyContext `json:"context,omitempty"`
	Feature   *ProductPromptJSONBodyFeature `json:"feature,omitempty"`
	Force     *bool                         `json:"force,omitempty"`
	ListId    *float32                      `json:"listId,omitempty"`
	Model     *ProductPromptJSONBodyModel   `json:"model,omitempty"`
	Prompt    string                        `json:"prompt"`
}

ProductPromptJSONBody defines parameters for ProductPrompt.

type ProductPromptJSONBodyContext

type ProductPromptJSONBodyContext string

ProductPromptJSONBodyContext defines parameters for ProductPrompt.

const (
	ProductPromptJSONBodyContextAnalytics     ProductPromptJSONBodyContext = "analytics"
	ProductPromptJSONBodyContextApi           ProductPromptJSONBodyContext = "api"
	ProductPromptJSONBodyContextCompanies     ProductPromptJSONBodyContext = "companies"
	ProductPromptJSONBodyContextCompany       ProductPromptJSONBodyContext = "company"
	ProductPromptJSONBodyContextDocumentation ProductPromptJSONBodyContext = "documentation"
	ProductPromptJSONBodyContextEnrichment    ProductPromptJSONBodyContext = "enrichment"
	ProductPromptJSONBodyContextLanding       ProductPromptJSONBodyContext = "landing"
	ProductPromptJSONBodyContextList          ProductPromptJSONBodyContext = "list"
	ProductPromptJSONBodyContextSimilarity    ProductPromptJSONBodyContext = "similarity"
)

Defines values for ProductPromptJSONBodyContext.

type ProductPromptJSONBodyFeature

type ProductPromptJSONBodyFeature string

ProductPromptJSONBodyFeature defines parameters for ProductPrompt.

const (
	Ask     ProductPromptJSONBodyFeature = "ask"
	Cleanup ProductPromptJSONBodyFeature = "cleanup"
	Enrich  ProductPromptJSONBodyFeature = "enrich"
	Product ProductPromptJSONBodyFeature = "product"
	Search  ProductPromptJSONBodyFeature = "search"
	Similar ProductPromptJSONBodyFeature = "similar"
)

Defines values for ProductPromptJSONBodyFeature.

type ProductPromptJSONBodyModel

type ProductPromptJSONBodyModel string

ProductPromptJSONBodyModel defines parameters for ProductPrompt.

const (
	ProductPromptJSONBodyModelLarge ProductPromptJSONBodyModel = "large"
	ProductPromptJSONBodyModelSmall ProductPromptJSONBodyModel = "small"
)

Defines values for ProductPromptJSONBodyModel.

type ProductPromptJSONRequestBody

type ProductPromptJSONRequestBody ProductPromptJSONBody

ProductPromptJSONRequestBody defines body for ProductPrompt for application/json ContentType.

type ProductPromptResponse

type ProductPromptResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`

		// Prompt A natural language request made to the platform resolving to a specific action or search segment.
		Prompt   Prompt                     `json:"prompt"`
		Response ProductPrompt_200_Response `json:"response"`
	}
	JSON401 *struct {
		Details  interface{}              `json:"details,omitempty"`
		Messages ProductPrompt401Messages `json:"messages"`
		Status   float32                  `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}              `json:"details,omitempty"`
		Messages ProductPrompt403Messages `json:"messages"`
		Status   float32                  `json:"status"`
	}
}

func ParseProductPromptResponse

func ParseProductPromptResponse(rsp *http.Response) (*ProductPromptResponse, error)

ParseProductPromptResponse parses an HTTP response from a ProductPromptWithResponse call

func (ProductPromptResponse) Status

func (r ProductPromptResponse) Status() string

Status returns HTTPResponse.Status

func (ProductPromptResponse) StatusCode

func (r ProductPromptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProductPrompt_200_Response

type ProductPrompt_200_Response struct {
	// contains filtered or unexported fields
}

type Prompt

type Prompt struct {
	CompanyId *float32      `json:"companyId,omitempty"`
	Context   PromptContext `json:"context"`
	CreatedAt *string       `json:"createdAt,omitempty"`
	Data      *struct {
		All     *bool     `json:"all,omitempty"`
		Count   *float32  `json:"count,omitempty"`
		Domains *[]string `json:"domains,omitempty"`
		Explain *bool     `json:"explain,omitempty"`
		Fields  *[]struct {
			Description *string              `json:"description,omitempty"`
			Key         string               `json:"key"`
			Type        PromptDataFieldsType `json:"type"`
			Values      *[]string            `json:"values,omitempty"`
		} `json:"fields,omitempty"`
		Model        *PromptDataModel         `json:"model,omitempty"`
		Names        *[]string                `json:"names,omitempty"`
		Query        *[]SegmentationCondition `json:"query,omitempty"`
		Question     *string                  `json:"question,omitempty"`
		Segmentation *bool                    `json:"segmentation,omitempty"`
	} `json:"data,omitempty"`
	Feature   *PromptFeature   `json:"feature,omitempty"`
	Hits      *float32         `json:"hits,omitempty"`
	Id        float32          `json:"id"`
	Model     *PromptModel     `json:"model,omitempty"`
	Prompt    string           `json:"prompt"`
	PromptKey string           `json:"promptKey"`
	Response  *Prompt_Response `json:"response,omitempty"`
	UpdatedAt *string          `json:"updatedAt,omitempty"`
}

Prompt A natural language request made to the platform resolving to a specific action or search segment.

type PromptContext

type PromptContext string

PromptContext defines model for Prompt.Context.

const (
	PromptContextAnalytics     PromptContext = "analytics"
	PromptContextApi           PromptContext = "api"
	PromptContextCompanies     PromptContext = "companies"
	PromptContextCompany       PromptContext = "company"
	PromptContextDocumentation PromptContext = "documentation"
	PromptContextEnrichment    PromptContext = "enrichment"
	PromptContextLanding       PromptContext = "landing"
	PromptContextList          PromptContext = "list"
	PromptContextSimilarity    PromptContext = "similarity"
)

Defines values for PromptContext.

type PromptDataFieldsType

type PromptDataFieldsType string

PromptDataFieldsType defines model for Prompt.Data.Fields.Type.

const (
	PromptDataFieldsTypeArrayboolean PromptDataFieldsType = "array|boolean"
	PromptDataFieldsTypeArraynumber  PromptDataFieldsType = "array|number"
	PromptDataFieldsTypeArraystring  PromptDataFieldsType = "array|string"
	PromptDataFieldsTypeBoolean      PromptDataFieldsType = "boolean"
	PromptDataFieldsTypeNumber       PromptDataFieldsType = "number"
	PromptDataFieldsTypeString       PromptDataFieldsType = "string"
)

Defines values for PromptDataFieldsType.

type PromptDataModel

type PromptDataModel string

PromptDataModel defines model for Prompt.Data.Model.

const (
	PromptDataModelLarge PromptDataModel = "large"
	PromptDataModelSmall PromptDataModel = "small"
)

Defines values for PromptDataModel.

type PromptFeature

type PromptFeature string

PromptFeature defines model for Prompt.Feature.

const (
	PromptFeatureAsk     PromptFeature = "ask"
	PromptFeatureCleanup PromptFeature = "cleanup"
	PromptFeatureEnrich  PromptFeature = "enrich"
	PromptFeatureProduct PromptFeature = "product"
	PromptFeatureSearch  PromptFeature = "search"
	PromptFeatureSimilar PromptFeature = "similar"
)

Defines values for PromptFeature.

type PromptModel

type PromptModel string

PromptModel defines model for Prompt.Model.

const (
	PromptModelLarge PromptModel = "large"
	PromptModelSmall PromptModel = "small"
)

Defines values for PromptModel.

type PromptResponse0

type PromptResponse0 struct {
	Action *struct {
		Cost *float32 `json:"cost,omitempty"`
		Data *struct {
			// Answer An answer from a query made to the LLM.
			Answer  LLMAnswer `json:"answer"`
			Domains *[]string `json:"domains,omitempty"`
			Fields  []struct {
				Description *string                             `json:"description,omitempty"`
				Key         string                              `json:"key"`
				Type        PromptResponse0ActionDataFieldsType `json:"type"`
				Values      *[]string                           `json:"values,omitempty"`
			} `json:"fields"`
			Job      PromptResponse0ActionDataJob `json:"job"`
			Query    *[]SegmentationCondition     `json:"query,omitempty"`
			Question string                       `json:"question"`
		} `json:"data,omitempty"`
		ListId   *float32                    `json:"listId,omitempty"`
		PromptId float32                     `json:"promptId"`
		Status   PromptResponse0ActionStatus `json:"status"`
		Type     PromptResponse0ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool `json:"all,omitempty"`
	Answer *struct {
		Explanation *string                `json:"explanation,omitempty"`
		Output      map[string]interface{} `json:"output"`
		Score       float32                `json:"score"`
	} `json:"answer,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

PromptResponse0 defines model for .

type PromptResponse0ActionDataFieldsType

type PromptResponse0ActionDataFieldsType string

PromptResponse0ActionDataFieldsType defines model for Prompt.Response.0.Action.Data.Fields.Type.

const (
	PromptResponse0ActionDataFieldsTypeArrayboolean PromptResponse0ActionDataFieldsType = "array|boolean"
	PromptResponse0ActionDataFieldsTypeArraynumber  PromptResponse0ActionDataFieldsType = "array|number"
	PromptResponse0ActionDataFieldsTypeArraystring  PromptResponse0ActionDataFieldsType = "array|string"
	PromptResponse0ActionDataFieldsTypeBoolean      PromptResponse0ActionDataFieldsType = "boolean"
	PromptResponse0ActionDataFieldsTypeNumber       PromptResponse0ActionDataFieldsType = "number"
	PromptResponse0ActionDataFieldsTypeString       PromptResponse0ActionDataFieldsType = "string"
)

Defines values for PromptResponse0ActionDataFieldsType.

type PromptResponse0ActionDataJob

type PromptResponse0ActionDataJob string

PromptResponse0ActionDataJob defines model for Prompt.Response.0.Action.Data.Job.

const (
	PromptResponse0ActionDataJobAskList PromptResponse0ActionDataJob = "ask-list"
)

Defines values for PromptResponse0ActionDataJob.

type PromptResponse0ActionStatus

type PromptResponse0ActionStatus string

PromptResponse0ActionStatus defines model for Prompt.Response.0.Action.Status.

const (
	PromptResponse0ActionStatusPending PromptResponse0ActionStatus = "pending"
)

Defines values for PromptResponse0ActionStatus.

type PromptResponse0ActionType

type PromptResponse0ActionType string

PromptResponse0ActionType defines model for Prompt.Response.0.Action.Type.

const (
	PromptResponse0ActionTypeJobsRequest PromptResponse0ActionType = "jobs:request"
)

Defines values for PromptResponse0ActionType.

type PromptResponse1

type PromptResponse1 struct {
	Action *struct {
		Cost *PromptResponse1ActionCost `json:"cost,omitempty"`
		Data *struct {
			Domains *[]string                    `json:"domains,omitempty"`
			Job     PromptResponse1ActionDataJob `json:"job"`
			Query   *[]SegmentationCondition     `json:"query,omitempty"`
		} `json:"data,omitempty"`
		ListId   *float32                    `json:"listId,omitempty"`
		PromptId float32                     `json:"promptId"`
		Status   PromptResponse1ActionStatus `json:"status"`
		Type     PromptResponse1ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool    `json:"all,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

PromptResponse1 defines model for .

type PromptResponse1ActionCost

type PromptResponse1ActionCost float32

PromptResponse1ActionCost defines model for Prompt.Response.1.Action.Cost.

const (
	N0 PromptResponse1ActionCost = 0
)

Defines values for PromptResponse1ActionCost.

type PromptResponse1ActionDataJob

type PromptResponse1ActionDataJob string

PromptResponse1ActionDataJob defines model for Prompt.Response.1.Action.Job.

const (
	PromptResponse1ActionDataJobCleanupList PromptResponse1ActionDataJob = "cleanup-list"
)

Defines values for PromptResponse1ActionDataJob.

type PromptResponse1ActionStatus

type PromptResponse1ActionStatus string

PromptResponse1ActionStatus defines model for Prompt.Response.1.Action.Status.

const (
	PromptResponse1ActionStatusPending PromptResponse1ActionStatus = "pending"
)

Defines values for PromptResponse1ActionStatus.

type PromptResponse1ActionType

type PromptResponse1ActionType string

PromptResponse1ActionType defines model for Prompt.Response.1.Action.Type.

const (
	PromptResponse1ActionTypeJobsRequest PromptResponse1ActionType = "jobs:request"
)

Defines values for PromptResponse1ActionType.

type PromptResponse2

type PromptResponse2 struct {
	Action *struct {
		Cost *float32 `json:"cost,omitempty"`
		Data struct {
			Domains *[]string                    `json:"domains,omitempty"`
			Job     PromptResponse2ActionDataJob `json:"job"`
			Query   *[]SegmentationCondition     `json:"query,omitempty"`
		} `json:"data"`
		ListId   *float32                    `json:"listId,omitempty"`
		PromptId float32                     `json:"promptId"`
		Status   PromptResponse2ActionStatus `json:"status"`
		Type     PromptResponse2ActionType   `json:"type"`
	} `json:"action,omitempty"`
	All    *bool    `json:"all,omitempty"`
	Cost   *float32 `json:"cost,omitempty"`
	Count  *float32 `json:"count,omitempty"`
	Domain *string  `json:"domain,omitempty"`
	Error  *string  `json:"error,omitempty"`
}

PromptResponse2 defines model for .

type PromptResponse2ActionDataJob

type PromptResponse2ActionDataJob string

PromptResponse2ActionDataJob defines model for Prompt.Response.2.Action.Data.Job.

const (
	EnrichCompanies PromptResponse2ActionDataJob = "enrich-companies"
	EnrichList      PromptResponse2ActionDataJob = "enrich-list"
)

Defines values for PromptResponse2ActionDataJob.

type PromptResponse2ActionStatus

type PromptResponse2ActionStatus string

PromptResponse2ActionStatus defines model for Prompt.Response.2.Action.Status.

const (
	PromptResponse2ActionStatusPending PromptResponse2ActionStatus = "pending"
)

Defines values for PromptResponse2ActionStatus.

type PromptResponse2ActionType

type PromptResponse2ActionType string

PromptResponse2ActionType defines model for Prompt.Response.2.Action.Type.

const (
	PromptResponse2ActionTypeJobsRequest PromptResponse2ActionType = "jobs:request"
)

Defines values for PromptResponse2ActionType.

type PromptResponse3

type PromptResponse3 struct {
	All     *bool                    `json:"all,omitempty"`
	Cost    *float32                 `json:"cost,omitempty"`
	Count   *float32                 `json:"count,omitempty"`
	Domain  *string                  `json:"domain,omitempty"`
	Domains *[]string                `json:"domains,omitempty"`
	Error   *string                  `json:"error,omitempty"`
	ListId  *float32                 `json:"listId,omitempty"`
	Query   *[]SegmentationCondition `json:"query,omitempty"`
}

PromptResponse3 defines model for .

type PromptResponse4

type PromptResponse4 struct {
	All     *bool     `json:"all,omitempty"`
	Cost    *float32  `json:"cost,omitempty"`
	Count   *float32  `json:"count,omitempty"`
	Domain  *string   `json:"domain,omitempty"`
	Domains *[]string `json:"domains,omitempty"`
	Error   *string   `json:"error,omitempty"`
}

PromptResponse4 defines model for .

type PromptToSegmentation401Messages

type PromptToSegmentation401Messages string

type PromptToSegmentationJSONBody

type PromptToSegmentationJSONBody struct {
	Context *PromptToSegmentationJSONBodyContext `json:"context,omitempty"`
	Force   *bool                                `json:"force,omitempty"`
	ListId  *float32                             `json:"listId,omitempty"`
	Model   *PromptToSegmentationJSONBodyModel   `json:"model,omitempty"`
	Prompt  string                               `json:"prompt"`
}

PromptToSegmentationJSONBody defines parameters for PromptToSegmentation.

type PromptToSegmentationJSONBodyContext

type PromptToSegmentationJSONBodyContext string

PromptToSegmentationJSONBodyContext defines parameters for PromptToSegmentation.

const (
	PromptToSegmentationJSONBodyContextAnalytics     PromptToSegmentationJSONBodyContext = "analytics"
	PromptToSegmentationJSONBodyContextApi           PromptToSegmentationJSONBodyContext = "api"
	PromptToSegmentationJSONBodyContextCompanies     PromptToSegmentationJSONBodyContext = "companies"
	PromptToSegmentationJSONBodyContextCompany       PromptToSegmentationJSONBodyContext = "company"
	PromptToSegmentationJSONBodyContextDocumentation PromptToSegmentationJSONBodyContext = "documentation"
	PromptToSegmentationJSONBodyContextEnrichment    PromptToSegmentationJSONBodyContext = "enrichment"
	PromptToSegmentationJSONBodyContextLanding       PromptToSegmentationJSONBodyContext = "landing"
	PromptToSegmentationJSONBodyContextList          PromptToSegmentationJSONBodyContext = "list"
	PromptToSegmentationJSONBodyContextSimilarity    PromptToSegmentationJSONBodyContext = "similarity"
)

Defines values for PromptToSegmentationJSONBodyContext.

type PromptToSegmentationJSONBodyModel

type PromptToSegmentationJSONBodyModel string

PromptToSegmentationJSONBodyModel defines parameters for PromptToSegmentation.

const (
	PromptToSegmentationJSONBodyModelLarge PromptToSegmentationJSONBodyModel = "large"
	PromptToSegmentationJSONBodyModelSmall PromptToSegmentationJSONBodyModel = "small"
)

Defines values for PromptToSegmentationJSONBodyModel.

type PromptToSegmentationJSONRequestBody

type PromptToSegmentationJSONRequestBody PromptToSegmentationJSONBody

PromptToSegmentationJSONRequestBody defines body for PromptToSegmentation for application/json ContentType.

type PromptToSegmentationResponse

type PromptToSegmentationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`

		// Prompt A natural language request made to the platform resolving to a specific action or search segment.
		Prompt   Prompt `json:"prompt"`
		Response struct {
			All     *bool                    `json:"all,omitempty"`
			Cost    *float32                 `json:"cost,omitempty"`
			Count   *float32                 `json:"count,omitempty"`
			Domain  *string                  `json:"domain,omitempty"`
			Domains *[]string                `json:"domains,omitempty"`
			Error   *string                  `json:"error,omitempty"`
			ListId  *float32                 `json:"listId,omitempty"`
			Query   *[]SegmentationCondition `json:"query,omitempty"`
		} `json:"response"`
	}
	JSON401 *struct {
		Details  interface{}                     `json:"details,omitempty"`
		Messages PromptToSegmentation401Messages `json:"messages"`
		Status   float32                         `json:"status"`
	}
}

func ParsePromptToSegmentationResponse

func ParsePromptToSegmentationResponse(rsp *http.Response) (*PromptToSegmentationResponse, error)

ParsePromptToSegmentationResponse parses an HTTP response from a PromptToSegmentationWithResponse call

func (PromptToSegmentationResponse) Status

Status returns HTTPResponse.Status

func (PromptToSegmentationResponse) StatusCode

func (r PromptToSegmentationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Prompt_Response

type Prompt_Response struct {
	// contains filtered or unexported fields
}

Prompt_Response defines model for Prompt.Response.

func (Prompt_Response) AsPromptResponse0

func (t Prompt_Response) AsPromptResponse0() (PromptResponse0, error)

AsPromptResponse0 returns the union data inside the Prompt_Response as a PromptResponse0

func (Prompt_Response) AsPromptResponse1

func (t Prompt_Response) AsPromptResponse1() (PromptResponse1, error)

AsPromptResponse1 returns the union data inside the Prompt_Response as a PromptResponse1

func (Prompt_Response) AsPromptResponse2

func (t Prompt_Response) AsPromptResponse2() (PromptResponse2, error)

AsPromptResponse2 returns the union data inside the Prompt_Response as a PromptResponse2

func (Prompt_Response) AsPromptResponse3

func (t Prompt_Response) AsPromptResponse3() (PromptResponse3, error)

AsPromptResponse3 returns the union data inside the Prompt_Response as a PromptResponse3

func (Prompt_Response) AsPromptResponse4

func (t Prompt_Response) AsPromptResponse4() (PromptResponse4, error)

AsPromptResponse4 returns the union data inside the Prompt_Response as a PromptResponse4

func (*Prompt_Response) FromPromptResponse0

func (t *Prompt_Response) FromPromptResponse0(v PromptResponse0) error

FromPromptResponse0 overwrites any union data inside the Prompt_Response as the provided PromptResponse0

func (*Prompt_Response) FromPromptResponse1

func (t *Prompt_Response) FromPromptResponse1(v PromptResponse1) error

FromPromptResponse1 overwrites any union data inside the Prompt_Response as the provided PromptResponse1

func (*Prompt_Response) FromPromptResponse2

func (t *Prompt_Response) FromPromptResponse2(v PromptResponse2) error

FromPromptResponse2 overwrites any union data inside the Prompt_Response as the provided PromptResponse2

func (*Prompt_Response) FromPromptResponse3

func (t *Prompt_Response) FromPromptResponse3(v PromptResponse3) error

FromPromptResponse3 overwrites any union data inside the Prompt_Response as the provided PromptResponse3

func (*Prompt_Response) FromPromptResponse4

func (t *Prompt_Response) FromPromptResponse4(v PromptResponse4) error

FromPromptResponse4 overwrites any union data inside the Prompt_Response as the provided PromptResponse4

func (Prompt_Response) MarshalJSON

func (t Prompt_Response) MarshalJSON() ([]byte, error)

func (*Prompt_Response) MergePromptResponse0

func (t *Prompt_Response) MergePromptResponse0(v PromptResponse0) error

MergePromptResponse0 performs a merge with any union data inside the Prompt_Response, using the provided PromptResponse0

func (*Prompt_Response) MergePromptResponse1

func (t *Prompt_Response) MergePromptResponse1(v PromptResponse1) error

MergePromptResponse1 performs a merge with any union data inside the Prompt_Response, using the provided PromptResponse1

func (*Prompt_Response) MergePromptResponse2

func (t *Prompt_Response) MergePromptResponse2(v PromptResponse2) error

MergePromptResponse2 performs a merge with any union data inside the Prompt_Response, using the provided PromptResponse2

func (*Prompt_Response) MergePromptResponse3

func (t *Prompt_Response) MergePromptResponse3(v PromptResponse3) error

MergePromptResponse3 performs a merge with any union data inside the Prompt_Response, using the provided PromptResponse3

func (*Prompt_Response) MergePromptResponse4

func (t *Prompt_Response) MergePromptResponse4(v PromptResponse4) error

MergePromptResponse4 performs a merge with any union data inside the Prompt_Response, using the provided PromptResponse4

func (*Prompt_Response) UnmarshalJSON

func (t *Prompt_Response) UnmarshalJSON(b []byte) error

type RequestAction400Messages

type RequestAction400Messages string

type RequestAction401Messages

type RequestAction401Messages string

type RequestAction403Messages

type RequestAction403Messages string

type RequestActionJSONBody

type RequestActionJSONBody struct {
	Domains  *[]string `json:"domains,omitempty"`
	Estimate *bool     `json:"estimate,omitempty"`
	Fields   *[]struct {
		Description *string                         `json:"description,omitempty"`
		Key         string                          `json:"key"`
		Type        RequestActionJSONBodyFieldsType `json:"type"`
		Values      *[]string                       `json:"values,omitempty"`
	} `json:"fields,omitempty"`
	Job      *RequestActionJSONBodyJob `json:"job,omitempty"`
	ListId   *float32                  `json:"listId,omitempty"`
	Names    *[]string                 `json:"names,omitempty"`
	PromptId *float32                  `json:"promptId,omitempty"`
	Query    *[]SegmentationCondition  `json:"query,omitempty"`
	Question *string                   `json:"question,omitempty"`
	Type     RequestActionJSONBodyType `json:"type"`
}

RequestActionJSONBody defines parameters for RequestAction.

type RequestActionJSONBodyFieldsType

type RequestActionJSONBodyFieldsType string

RequestActionJSONBodyFieldsType defines parameters for RequestAction.

const (
	RequestActionJSONBodyFieldsTypeArrayboolean RequestActionJSONBodyFieldsType = "array|boolean"
	RequestActionJSONBodyFieldsTypeArraynumber  RequestActionJSONBodyFieldsType = "array|number"
	RequestActionJSONBodyFieldsTypeArraystring  RequestActionJSONBodyFieldsType = "array|string"
	RequestActionJSONBodyFieldsTypeBoolean      RequestActionJSONBodyFieldsType = "boolean"
	RequestActionJSONBodyFieldsTypeNumber       RequestActionJSONBodyFieldsType = "number"
	RequestActionJSONBodyFieldsTypeString       RequestActionJSONBodyFieldsType = "string"
)

Defines values for RequestActionJSONBodyFieldsType.

type RequestActionJSONBodyJob

type RequestActionJSONBodyJob string

RequestActionJSONBodyJob defines parameters for RequestAction.

const (
	RequestActionJSONBodyJobAskDomain       RequestActionJSONBodyJob = "ask-domain"
	RequestActionJSONBodyJobAskList         RequestActionJSONBodyJob = "ask-list"
	RequestActionJSONBodyJobCleanupList     RequestActionJSONBodyJob = "cleanup-list"
	RequestActionJSONBodyJobEnrichCompanies RequestActionJSONBodyJob = "enrich-companies"
	RequestActionJSONBodyJobEnrichList      RequestActionJSONBodyJob = "enrich-list"
)

Defines values for RequestActionJSONBodyJob.

type RequestActionJSONBodyType

type RequestActionJSONBodyType string

RequestActionJSONBodyType defines parameters for RequestAction.

const (
	RequestActionJSONBodyTypeCompaniesAdded RequestActionJSONBodyType = "companies:added"
	RequestActionJSONBodyTypeJobsRequest    RequestActionJSONBodyType = "jobs:request"
)

Defines values for RequestActionJSONBodyType.

type RequestActionJSONRequestBody

type RequestActionJSONRequestBody RequestActionJSONBody

RequestActionJSONRequestBody defines body for RequestAction for application/json ContentType.

type RequestActionResponse

type RequestActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Actions []Action `json:"actions"`
	}
	JSON400 *struct {
		Details  interface{}              `json:"details,omitempty"`
		Messages RequestAction400Messages `json:"messages"`
		Status   float32                  `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}              `json:"details,omitempty"`
		Messages RequestAction401Messages `json:"messages"`
		Status   float32                  `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}              `json:"details,omitempty"`
		Messages RequestAction403Messages `json:"messages"`
		Status   float32                  `json:"status"`
	}
}

func ParseRequestActionResponse

func ParseRequestActionResponse(rsp *http.Response) (*RequestActionResponse, error)

ParseRequestActionResponse parses an HTTP response from a RequestActionWithResponse call

func (RequestActionResponse) Status

func (r RequestActionResponse) Status() string

Status returns HTTPResponse.Status

func (RequestActionResponse) StatusCode

func (r RequestActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RetryAction400Messages

type RetryAction400Messages string

type RetryAction401Messages

type RetryAction401Messages string

type RetryActionJSONBody

type RetryActionJSONBody = map[string]interface{}

RetryActionJSONBody defines parameters for RetryAction.

type RetryActionJSONRequestBody

type RetryActionJSONRequestBody = RetryActionJSONBody

RetryActionJSONRequestBody defines body for RetryAction for application/json ContentType.

type RetryActionResponse

type RetryActionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Action An action tracks a request made to our job queue and its result.
		Action Action `json:"action"`
	}
	JSON400 *struct {
		Details  interface{}            `json:"details,omitempty"`
		Messages RetryAction400Messages `json:"messages"`
		Status   float32                `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}            `json:"details,omitempty"`
		Messages RetryAction401Messages `json:"messages"`
		Status   float32                `json:"status"`
	}
}

func ParseRetryActionResponse

func ParseRetryActionResponse(rsp *http.Response) (*RetryActionResponse, error)

ParseRetryActionResponse parses an HTTP response from a RetryActionWithResponse call

func (RetryActionResponse) Status

func (r RetryActionResponse) Status() string

Status returns HTTPResponse.Status

func (RetryActionResponse) StatusCode

func (r RetryActionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCities401Messages

type SearchCities401Messages string

type SearchCitiesParams

type SearchCitiesParams struct {
	Filters   *string                      `form:"filters,omitempty" json:"filters,omitempty"`
	Page      *float32                     `form:"page,omitempty" json:"page,omitempty"`
	Search    *string                      `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                     `form:"size,omitempty" json:"size,omitempty"`
	SortKey   *SearchCitiesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCitiesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCitiesParams defines parameters for SearchCities.

type SearchCitiesParamsSortKey

type SearchCitiesParamsSortKey string

SearchCitiesParamsSortKey defines parameters for SearchCities.

const (
	SearchCitiesParamsSortKeyCountsCompanies SearchCitiesParamsSortKey = "counts.companies"
)

Defines values for SearchCitiesParamsSortKey.

type SearchCitiesParamsSortOrder

type SearchCitiesParamsSortOrder string

SearchCitiesParamsSortOrder defines parameters for SearchCities.

const (
	SearchCitiesParamsSortOrderAsc  SearchCitiesParamsSortOrder = "asc"
	SearchCitiesParamsSortOrderDesc SearchCitiesParamsSortOrder = "desc"
)

Defines values for SearchCitiesParamsSortOrder.

type SearchCitiesResponse

type SearchCitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cities []NominatimCity `json:"cities"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages SearchCities401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseSearchCitiesResponse

func ParseSearchCitiesResponse(rsp *http.Response) (*SearchCitiesResponse, error)

ParseSearchCitiesResponse parses an HTTP response from a SearchCitiesWithResponse call

func (SearchCitiesResponse) Status

func (r SearchCitiesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchCitiesResponse) StatusCode

func (r SearchCitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCompanies401Messages

type SearchCompanies401Messages string

type SearchCompanies403Messages

type SearchCompanies403Messages string

type SearchCompaniesByName400Messages

type SearchCompaniesByName400Messages string

type SearchCompaniesByName401Messages

type SearchCompaniesByName401Messages string

type SearchCompaniesByName403Messages

type SearchCompaniesByName403Messages string

type SearchCompaniesByNameParams

type SearchCompaniesByNameParams struct {
	Countries       *string                                    `form:"countries,omitempty" json:"countries,omitempty"`
	ExactWordsMatch *bool                                      `form:"exactWordsMatch,omitempty" json:"exactWordsMatch,omitempty"`
	ListsToExclude  *string                                    `form:"listsToExclude,omitempty" json:"listsToExclude,omitempty"`
	Name            string                                     `form:"name" json:"name"`
	Page            *float32                                   `form:"page,omitempty" json:"page,omitempty"`
	SearchFields    *[]SearchCompaniesByNameParamsSearchFields `form:"searchFields,omitempty" json:"searchFields,omitempty"`
	Simplified      *bool                                      `form:"simplified,omitempty" json:"simplified,omitempty"`
	Size            *float32                                   `form:"size,omitempty" json:"size,omitempty"`
	SortFields      *[]struct {
		Key     SearchCompaniesByNameParamsSortFieldsKey      `json:"key"`
		Missing *SearchCompaniesByNameParamsSortFieldsMissing `json:"missing,omitempty"`
		Order   SearchCompaniesByNameParamsSortFieldsOrder    `json:"order"`
	} `form:"sortFields,omitempty" json:"sortFields,omitempty"`
	SortKey   *SearchCompaniesByNameParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCompaniesByNameParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCompaniesByNameParams defines parameters for SearchCompaniesByName.

type SearchCompaniesByNameParamsSearchFields

type SearchCompaniesByNameParamsSearchFields string

SearchCompaniesByNameParamsSearchFields defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSearchFieldsAboutName    SearchCompaniesByNameParamsSearchFields = "about.name"
	SearchCompaniesByNameParamsSearchFieldsDomainDomain SearchCompaniesByNameParamsSearchFields = "domain.domain"
)

Defines values for SearchCompaniesByNameParamsSearchFields.

type SearchCompaniesByNameParamsSortFieldsKey

type SearchCompaniesByNameParamsSortFieldsKey string

SearchCompaniesByNameParamsSortFieldsKey defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSortFieldsKeyAboutBusinessType                SearchCompaniesByNameParamsSortFieldsKey = "about.businessType"
	SearchCompaniesByNameParamsSortFieldsKeyAboutIndustries                  SearchCompaniesByNameParamsSortFieldsKey = "about.industries"
	SearchCompaniesByNameParamsSortFieldsKeyAboutIndustry                    SearchCompaniesByNameParamsSortFieldsKey = "about.industry"
	SearchCompaniesByNameParamsSortFieldsKeyAboutName                        SearchCompaniesByNameParamsSortFieldsKey = "about.name"
	SearchCompaniesByNameParamsSortFieldsKeyAboutTotalEmployees              SearchCompaniesByNameParamsSortFieldsKey = "about.totalEmployees"
	SearchCompaniesByNameParamsSortFieldsKeyAboutYearFounded                 SearchCompaniesByNameParamsSortFieldsKey = "about.yearFounded"
	SearchCompaniesByNameParamsSortFieldsKeyAnalyticsMonthlyVisitors         SearchCompaniesByNameParamsSortFieldsKey = "analytics.monthlyVisitors"
	SearchCompaniesByNameParamsSortFieldsKeyApps                             SearchCompaniesByNameParamsSortFieldsKey = "apps"
	SearchCompaniesByNameParamsSortFieldsKeyCodesNaics                       SearchCompaniesByNameParamsSortFieldsKey = "codes.naics"
	SearchCompaniesByNameParamsSortFieldsKeyCodesSic                         SearchCompaniesByNameParamsSortFieldsKey = "codes.sic"
	SearchCompaniesByNameParamsSortFieldsKeyContacts                         SearchCompaniesByNameParamsSortFieldsKey = "contacts"
	SearchCompaniesByNameParamsSortFieldsKeyDomainDomain                     SearchCompaniesByNameParamsSortFieldsKey = "domain.domain"
	SearchCompaniesByNameParamsSortFieldsKeyDomainTld                        SearchCompaniesByNameParamsSortFieldsKey = "domain.tld"
	SearchCompaniesByNameParamsSortFieldsKeyFinancesRevenue                  SearchCompaniesByNameParamsSortFieldsKey = "finances.revenue"
	SearchCompaniesByNameParamsSortFieldsKeyLocationsHeadquartersCityCode    SearchCompaniesByNameParamsSortFieldsKey = "locations.headquarters.city.code"
	SearchCompaniesByNameParamsSortFieldsKeyLocationsHeadquartersCountryCode SearchCompaniesByNameParamsSortFieldsKey = "locations.headquarters.country.code"
	SearchCompaniesByNameParamsSortFieldsKeyLocationsHeadquartersCountyCode  SearchCompaniesByNameParamsSortFieldsKey = "locations.headquarters.county.code"
	SearchCompaniesByNameParamsSortFieldsKeyLocationsHeadquartersStateCode   SearchCompaniesByNameParamsSortFieldsKey = "locations.headquarters.state.code"
	SearchCompaniesByNameParamsSortFieldsKeyMetaScore                        SearchCompaniesByNameParamsSortFieldsKey = "meta.score"
	SearchCompaniesByNameParamsSortFieldsKeyMetaSyncedAt                     SearchCompaniesByNameParamsSortFieldsKey = "meta.syncedAt"
	SearchCompaniesByNameParamsSortFieldsKeySocials                          SearchCompaniesByNameParamsSortFieldsKey = "socials"
	SearchCompaniesByNameParamsSortFieldsKeyTechnologiesActive               SearchCompaniesByNameParamsSortFieldsKey = "technologies.active"
	SearchCompaniesByNameParamsSortFieldsKeyUrls                             SearchCompaniesByNameParamsSortFieldsKey = "urls"
)

Defines values for SearchCompaniesByNameParamsSortFieldsKey.

type SearchCompaniesByNameParamsSortFieldsMissing

type SearchCompaniesByNameParamsSortFieldsMissing string

SearchCompaniesByNameParamsSortFieldsMissing defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSortFieldsMissingUnderscoreFirst SearchCompaniesByNameParamsSortFieldsMissing = "_first"
	SearchCompaniesByNameParamsSortFieldsMissingUnderscoreLast  SearchCompaniesByNameParamsSortFieldsMissing = "_last"
)

Defines values for SearchCompaniesByNameParamsSortFieldsMissing.

type SearchCompaniesByNameParamsSortFieldsOrder

type SearchCompaniesByNameParamsSortFieldsOrder string

SearchCompaniesByNameParamsSortFieldsOrder defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSortFieldsOrderAsc  SearchCompaniesByNameParamsSortFieldsOrder = "asc"
	SearchCompaniesByNameParamsSortFieldsOrderDesc SearchCompaniesByNameParamsSortFieldsOrder = "desc"
)

Defines values for SearchCompaniesByNameParamsSortFieldsOrder.

type SearchCompaniesByNameParamsSortKey

type SearchCompaniesByNameParamsSortKey string

SearchCompaniesByNameParamsSortKey defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSortKeyAboutBusinessType                SearchCompaniesByNameParamsSortKey = "about.businessType"
	SearchCompaniesByNameParamsSortKeyAboutIndustries                  SearchCompaniesByNameParamsSortKey = "about.industries"
	SearchCompaniesByNameParamsSortKeyAboutIndustry                    SearchCompaniesByNameParamsSortKey = "about.industry"
	SearchCompaniesByNameParamsSortKeyAboutName                        SearchCompaniesByNameParamsSortKey = "about.name"
	SearchCompaniesByNameParamsSortKeyAboutTotalEmployees              SearchCompaniesByNameParamsSortKey = "about.totalEmployees"
	SearchCompaniesByNameParamsSortKeyAboutYearFounded                 SearchCompaniesByNameParamsSortKey = "about.yearFounded"
	SearchCompaniesByNameParamsSortKeyAnalyticsMonthlyVisitors         SearchCompaniesByNameParamsSortKey = "analytics.monthlyVisitors"
	SearchCompaniesByNameParamsSortKeyApps                             SearchCompaniesByNameParamsSortKey = "apps"
	SearchCompaniesByNameParamsSortKeyCodesNaics                       SearchCompaniesByNameParamsSortKey = "codes.naics"
	SearchCompaniesByNameParamsSortKeyCodesSic                         SearchCompaniesByNameParamsSortKey = "codes.sic"
	SearchCompaniesByNameParamsSortKeyContacts                         SearchCompaniesByNameParamsSortKey = "contacts"
	SearchCompaniesByNameParamsSortKeyDomainDomain                     SearchCompaniesByNameParamsSortKey = "domain.domain"
	SearchCompaniesByNameParamsSortKeyDomainTld                        SearchCompaniesByNameParamsSortKey = "domain.tld"
	SearchCompaniesByNameParamsSortKeyFinancesRevenue                  SearchCompaniesByNameParamsSortKey = "finances.revenue"
	SearchCompaniesByNameParamsSortKeyLocationsHeadquartersCityCode    SearchCompaniesByNameParamsSortKey = "locations.headquarters.city.code"
	SearchCompaniesByNameParamsSortKeyLocationsHeadquartersCountryCode SearchCompaniesByNameParamsSortKey = "locations.headquarters.country.code"
	SearchCompaniesByNameParamsSortKeyLocationsHeadquartersCountyCode  SearchCompaniesByNameParamsSortKey = "locations.headquarters.county.code"
	SearchCompaniesByNameParamsSortKeyLocationsHeadquartersStateCode   SearchCompaniesByNameParamsSortKey = "locations.headquarters.state.code"
	SearchCompaniesByNameParamsSortKeyMetaScore                        SearchCompaniesByNameParamsSortKey = "meta.score"
	SearchCompaniesByNameParamsSortKeyMetaSyncedAt                     SearchCompaniesByNameParamsSortKey = "meta.syncedAt"
	SearchCompaniesByNameParamsSortKeySocials                          SearchCompaniesByNameParamsSortKey = "socials"
	SearchCompaniesByNameParamsSortKeyTechnologiesActive               SearchCompaniesByNameParamsSortKey = "technologies.active"
	SearchCompaniesByNameParamsSortKeyUrls                             SearchCompaniesByNameParamsSortKey = "urls"
)

Defines values for SearchCompaniesByNameParamsSortKey.

type SearchCompaniesByNameParamsSortOrder

type SearchCompaniesByNameParamsSortOrder string

SearchCompaniesByNameParamsSortOrder defines parameters for SearchCompaniesByName.

const (
	SearchCompaniesByNameParamsSortOrderAsc  SearchCompaniesByNameParamsSortOrder = "asc"
	SearchCompaniesByNameParamsSortOrderDesc SearchCompaniesByNameParamsSortOrder = "desc"
)

Defines values for SearchCompaniesByNameParamsSortOrder.

type SearchCompaniesByNameResponse

type SearchCompaniesByNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON400 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages SearchCompaniesByName400Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages SearchCompaniesByName401Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages SearchCompaniesByName403Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
}

func ParseSearchCompaniesByNameResponse

func ParseSearchCompaniesByNameResponse(rsp *http.Response) (*SearchCompaniesByNameResponse, error)

ParseSearchCompaniesByNameResponse parses an HTTP response from a SearchCompaniesByNameWithResponse call

func (SearchCompaniesByNameResponse) Status

Status returns HTTPResponse.Status

func (SearchCompaniesByNameResponse) StatusCode

func (r SearchCompaniesByNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCompaniesByPrompt401Messages

type SearchCompaniesByPrompt401Messages string

type SearchCompaniesByPrompt403Messages

type SearchCompaniesByPrompt403Messages string

type SearchCompaniesByPromptParams

type SearchCompaniesByPromptParams struct {
	ListsToExclude *string  `form:"listsToExclude,omitempty" json:"listsToExclude,omitempty"`
	Page           *float32 `form:"page,omitempty" json:"page,omitempty"`
	Prompt         string   `form:"prompt" json:"prompt"`
	Similarity     *float32 `form:"similarity,omitempty" json:"similarity,omitempty"`
	Simplified     *bool    `form:"simplified,omitempty" json:"simplified,omitempty"`
	Size           *float32 `form:"size,omitempty" json:"size,omitempty"`
	SortFields     *[]struct {
		Key     SearchCompaniesByPromptParamsSortFieldsKey      `json:"key"`
		Missing *SearchCompaniesByPromptParamsSortFieldsMissing `json:"missing,omitempty"`
		Order   SearchCompaniesByPromptParamsSortFieldsOrder    `json:"order"`
	} `form:"sortFields,omitempty" json:"sortFields,omitempty"`
	SortKey   *SearchCompaniesByPromptParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCompaniesByPromptParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCompaniesByPromptParams defines parameters for SearchCompaniesByPrompt.

type SearchCompaniesByPromptParamsSortFieldsKey

type SearchCompaniesByPromptParamsSortFieldsKey string

SearchCompaniesByPromptParamsSortFieldsKey defines parameters for SearchCompaniesByPrompt.

const (
	SearchCompaniesByPromptParamsSortFieldsKeyAboutBusinessType                SearchCompaniesByPromptParamsSortFieldsKey = "about.businessType"
	SearchCompaniesByPromptParamsSortFieldsKeyAboutIndustries                  SearchCompaniesByPromptParamsSortFieldsKey = "about.industries"
	SearchCompaniesByPromptParamsSortFieldsKeyAboutIndustry                    SearchCompaniesByPromptParamsSortFieldsKey = "about.industry"
	SearchCompaniesByPromptParamsSortFieldsKeyAboutName                        SearchCompaniesByPromptParamsSortFieldsKey = "about.name"
	SearchCompaniesByPromptParamsSortFieldsKeyAboutTotalEmployees              SearchCompaniesByPromptParamsSortFieldsKey = "about.totalEmployees"
	SearchCompaniesByPromptParamsSortFieldsKeyAboutYearFounded                 SearchCompaniesByPromptParamsSortFieldsKey = "about.yearFounded"
	SearchCompaniesByPromptParamsSortFieldsKeyAnalyticsMonthlyVisitors         SearchCompaniesByPromptParamsSortFieldsKey = "analytics.monthlyVisitors"
	SearchCompaniesByPromptParamsSortFieldsKeyApps                             SearchCompaniesByPromptParamsSortFieldsKey = "apps"
	SearchCompaniesByPromptParamsSortFieldsKeyCodesNaics                       SearchCompaniesByPromptParamsSortFieldsKey = "codes.naics"
	SearchCompaniesByPromptParamsSortFieldsKeyCodesSic                         SearchCompaniesByPromptParamsSortFieldsKey = "codes.sic"
	SearchCompaniesByPromptParamsSortFieldsKeyContacts                         SearchCompaniesByPromptParamsSortFieldsKey = "contacts"
	SearchCompaniesByPromptParamsSortFieldsKeyDomainDomain                     SearchCompaniesByPromptParamsSortFieldsKey = "domain.domain"
	SearchCompaniesByPromptParamsSortFieldsKeyDomainTld                        SearchCompaniesByPromptParamsSortFieldsKey = "domain.tld"
	SearchCompaniesByPromptParamsSortFieldsKeyFinancesRevenue                  SearchCompaniesByPromptParamsSortFieldsKey = "finances.revenue"
	SearchCompaniesByPromptParamsSortFieldsKeyLocationsHeadquartersCityCode    SearchCompaniesByPromptParamsSortFieldsKey = "locations.headquarters.city.code"
	SearchCompaniesByPromptParamsSortFieldsKeyLocationsHeadquartersCountryCode SearchCompaniesByPromptParamsSortFieldsKey = "locations.headquarters.country.code"
	SearchCompaniesByPromptParamsSortFieldsKeyLocationsHeadquartersCountyCode  SearchCompaniesByPromptParamsSortFieldsKey = "locations.headquarters.county.code"
	SearchCompaniesByPromptParamsSortFieldsKeyLocationsHeadquartersStateCode   SearchCompaniesByPromptParamsSortFieldsKey = "locations.headquarters.state.code"
	SearchCompaniesByPromptParamsSortFieldsKeyMetaScore                        SearchCompaniesByPromptParamsSortFieldsKey = "meta.score"
	SearchCompaniesByPromptParamsSortFieldsKeyMetaSyncedAt                     SearchCompaniesByPromptParamsSortFieldsKey = "meta.syncedAt"
	SearchCompaniesByPromptParamsSortFieldsKeySocials                          SearchCompaniesByPromptParamsSortFieldsKey = "socials"
	SearchCompaniesByPromptParamsSortFieldsKeyTechnologiesActive               SearchCompaniesByPromptParamsSortFieldsKey = "technologies.active"
	SearchCompaniesByPromptParamsSortFieldsKeyUrls                             SearchCompaniesByPromptParamsSortFieldsKey = "urls"
)

Defines values for SearchCompaniesByPromptParamsSortFieldsKey.

type SearchCompaniesByPromptParamsSortFieldsMissing

type SearchCompaniesByPromptParamsSortFieldsMissing string

SearchCompaniesByPromptParamsSortFieldsMissing defines parameters for SearchCompaniesByPrompt.

const (
	SearchCompaniesByPromptParamsSortFieldsMissingUnderscoreFirst SearchCompaniesByPromptParamsSortFieldsMissing = "_first"
	SearchCompaniesByPromptParamsSortFieldsMissingUnderscoreLast  SearchCompaniesByPromptParamsSortFieldsMissing = "_last"
)

Defines values for SearchCompaniesByPromptParamsSortFieldsMissing.

type SearchCompaniesByPromptParamsSortFieldsOrder

type SearchCompaniesByPromptParamsSortFieldsOrder string

SearchCompaniesByPromptParamsSortFieldsOrder defines parameters for SearchCompaniesByPrompt.

const (
	SearchCompaniesByPromptParamsSortFieldsOrderAsc  SearchCompaniesByPromptParamsSortFieldsOrder = "asc"
	SearchCompaniesByPromptParamsSortFieldsOrderDesc SearchCompaniesByPromptParamsSortFieldsOrder = "desc"
)

Defines values for SearchCompaniesByPromptParamsSortFieldsOrder.

type SearchCompaniesByPromptParamsSortKey

type SearchCompaniesByPromptParamsSortKey string

SearchCompaniesByPromptParamsSortKey defines parameters for SearchCompaniesByPrompt.

const (
	SearchCompaniesByPromptParamsSortKeyAboutBusinessType                SearchCompaniesByPromptParamsSortKey = "about.businessType"
	SearchCompaniesByPromptParamsSortKeyAboutIndustries                  SearchCompaniesByPromptParamsSortKey = "about.industries"
	SearchCompaniesByPromptParamsSortKeyAboutIndustry                    SearchCompaniesByPromptParamsSortKey = "about.industry"
	SearchCompaniesByPromptParamsSortKeyAboutName                        SearchCompaniesByPromptParamsSortKey = "about.name"
	SearchCompaniesByPromptParamsSortKeyAboutTotalEmployees              SearchCompaniesByPromptParamsSortKey = "about.totalEmployees"
	SearchCompaniesByPromptParamsSortKeyAboutYearFounded                 SearchCompaniesByPromptParamsSortKey = "about.yearFounded"
	SearchCompaniesByPromptParamsSortKeyAnalyticsMonthlyVisitors         SearchCompaniesByPromptParamsSortKey = "analytics.monthlyVisitors"
	SearchCompaniesByPromptParamsSortKeyApps                             SearchCompaniesByPromptParamsSortKey = "apps"
	SearchCompaniesByPromptParamsSortKeyCodesNaics                       SearchCompaniesByPromptParamsSortKey = "codes.naics"
	SearchCompaniesByPromptParamsSortKeyCodesSic                         SearchCompaniesByPromptParamsSortKey = "codes.sic"
	SearchCompaniesByPromptParamsSortKeyContacts                         SearchCompaniesByPromptParamsSortKey = "contacts"
	SearchCompaniesByPromptParamsSortKeyDomainDomain                     SearchCompaniesByPromptParamsSortKey = "domain.domain"
	SearchCompaniesByPromptParamsSortKeyDomainTld                        SearchCompaniesByPromptParamsSortKey = "domain.tld"
	SearchCompaniesByPromptParamsSortKeyFinancesRevenue                  SearchCompaniesByPromptParamsSortKey = "finances.revenue"
	SearchCompaniesByPromptParamsSortKeyLocationsHeadquartersCityCode    SearchCompaniesByPromptParamsSortKey = "locations.headquarters.city.code"
	SearchCompaniesByPromptParamsSortKeyLocationsHeadquartersCountryCode SearchCompaniesByPromptParamsSortKey = "locations.headquarters.country.code"
	SearchCompaniesByPromptParamsSortKeyLocationsHeadquartersCountyCode  SearchCompaniesByPromptParamsSortKey = "locations.headquarters.county.code"
	SearchCompaniesByPromptParamsSortKeyLocationsHeadquartersStateCode   SearchCompaniesByPromptParamsSortKey = "locations.headquarters.state.code"
	SearchCompaniesByPromptParamsSortKeyMetaScore                        SearchCompaniesByPromptParamsSortKey = "meta.score"
	SearchCompaniesByPromptParamsSortKeyMetaSyncedAt                     SearchCompaniesByPromptParamsSortKey = "meta.syncedAt"
	SearchCompaniesByPromptParamsSortKeySocials                          SearchCompaniesByPromptParamsSortKey = "socials"
	SearchCompaniesByPromptParamsSortKeyTechnologiesActive               SearchCompaniesByPromptParamsSortKey = "technologies.active"
	SearchCompaniesByPromptParamsSortKeyUrls                             SearchCompaniesByPromptParamsSortKey = "urls"
)

Defines values for SearchCompaniesByPromptParamsSortKey.

type SearchCompaniesByPromptParamsSortOrder

type SearchCompaniesByPromptParamsSortOrder string

SearchCompaniesByPromptParamsSortOrder defines parameters for SearchCompaniesByPrompt.

const (
	SearchCompaniesByPromptParamsSortOrderAsc  SearchCompaniesByPromptParamsSortOrder = "asc"
	SearchCompaniesByPromptParamsSortOrderDesc SearchCompaniesByPromptParamsSortOrder = "desc"
)

Defines values for SearchCompaniesByPromptParamsSortOrder.

type SearchCompaniesByPromptResponse

type SearchCompaniesByPromptResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                        `json:"details,omitempty"`
		Messages SearchCompaniesByPrompt401Messages `json:"messages"`
		Status   float32                            `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                        `json:"details,omitempty"`
		Messages SearchCompaniesByPrompt403Messages `json:"messages"`
		Status   float32                            `json:"status"`
	}
}

func ParseSearchCompaniesByPromptResponse

func ParseSearchCompaniesByPromptResponse(rsp *http.Response) (*SearchCompaniesByPromptResponse, error)

ParseSearchCompaniesByPromptResponse parses an HTTP response from a SearchCompaniesByPromptWithResponse call

func (SearchCompaniesByPromptResponse) Status

Status returns HTTPResponse.Status

func (SearchCompaniesByPromptResponse) StatusCode

func (r SearchCompaniesByPromptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCompaniesParams

type SearchCompaniesParams struct {
	ActionId          *float32                             `form:"actionId,omitempty" json:"actionId,omitempty"`
	DomainsToExclude  *string                              `form:"domainsToExclude,omitempty" json:"domainsToExclude,omitempty"`
	LinkedinToExclude *string                              `form:"linkedinToExclude,omitempty" json:"linkedinToExclude,omitempty"`
	Page              *float32                             `form:"page,omitempty" json:"page,omitempty"`
	Query             *[]SegmentationCondition             `form:"query,omitempty" json:"query,omitempty"`
	Search            *string                              `form:"search,omitempty" json:"search,omitempty"`
	SearchFields      *[]SearchCompaniesParamsSearchFields `form:"searchFields,omitempty" json:"searchFields,omitempty"`
	Simplified        *bool                                `form:"simplified,omitempty" json:"simplified,omitempty"`
	Size              *float32                             `form:"size,omitempty" json:"size,omitempty"`
	SortFields        *[]struct {
		Key     SearchCompaniesParamsSortFieldsKey      `json:"key"`
		Missing *SearchCompaniesParamsSortFieldsMissing `json:"missing,omitempty"`
		Order   SearchCompaniesParamsSortFieldsOrder    `json:"order"`
	} `form:"sortFields,omitempty" json:"sortFields,omitempty"`
	SortKey   *SearchCompaniesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCompaniesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCompaniesParams defines parameters for SearchCompanies.

type SearchCompaniesParamsSearchFields

type SearchCompaniesParamsSearchFields string

SearchCompaniesParamsSearchFields defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSearchFieldsAboutName    SearchCompaniesParamsSearchFields = "about.name"
	SearchCompaniesParamsSearchFieldsDomainDomain SearchCompaniesParamsSearchFields = "domain.domain"
)

Defines values for SearchCompaniesParamsSearchFields.

type SearchCompaniesParamsSortFieldsKey

type SearchCompaniesParamsSortFieldsKey string

SearchCompaniesParamsSortFieldsKey defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSortFieldsKeyAboutBusinessType                SearchCompaniesParamsSortFieldsKey = "about.businessType"
	SearchCompaniesParamsSortFieldsKeyAboutIndustries                  SearchCompaniesParamsSortFieldsKey = "about.industries"
	SearchCompaniesParamsSortFieldsKeyAboutIndustry                    SearchCompaniesParamsSortFieldsKey = "about.industry"
	SearchCompaniesParamsSortFieldsKeyAboutName                        SearchCompaniesParamsSortFieldsKey = "about.name"
	SearchCompaniesParamsSortFieldsKeyAboutTotalEmployees              SearchCompaniesParamsSortFieldsKey = "about.totalEmployees"
	SearchCompaniesParamsSortFieldsKeyAboutYearFounded                 SearchCompaniesParamsSortFieldsKey = "about.yearFounded"
	SearchCompaniesParamsSortFieldsKeyAnalyticsMonthlyVisitors         SearchCompaniesParamsSortFieldsKey = "analytics.monthlyVisitors"
	SearchCompaniesParamsSortFieldsKeyApps                             SearchCompaniesParamsSortFieldsKey = "apps"
	SearchCompaniesParamsSortFieldsKeyCodesNaics                       SearchCompaniesParamsSortFieldsKey = "codes.naics"
	SearchCompaniesParamsSortFieldsKeyCodesSic                         SearchCompaniesParamsSortFieldsKey = "codes.sic"
	SearchCompaniesParamsSortFieldsKeyContacts                         SearchCompaniesParamsSortFieldsKey = "contacts"
	SearchCompaniesParamsSortFieldsKeyDomainDomain                     SearchCompaniesParamsSortFieldsKey = "domain.domain"
	SearchCompaniesParamsSortFieldsKeyDomainTld                        SearchCompaniesParamsSortFieldsKey = "domain.tld"
	SearchCompaniesParamsSortFieldsKeyFinancesRevenue                  SearchCompaniesParamsSortFieldsKey = "finances.revenue"
	SearchCompaniesParamsSortFieldsKeyLocationsHeadquartersCityCode    SearchCompaniesParamsSortFieldsKey = "locations.headquarters.city.code"
	SearchCompaniesParamsSortFieldsKeyLocationsHeadquartersCountryCode SearchCompaniesParamsSortFieldsKey = "locations.headquarters.country.code"
	SearchCompaniesParamsSortFieldsKeyLocationsHeadquartersCountyCode  SearchCompaniesParamsSortFieldsKey = "locations.headquarters.county.code"
	SearchCompaniesParamsSortFieldsKeyLocationsHeadquartersStateCode   SearchCompaniesParamsSortFieldsKey = "locations.headquarters.state.code"
	SearchCompaniesParamsSortFieldsKeyMetaScore                        SearchCompaniesParamsSortFieldsKey = "meta.score"
	SearchCompaniesParamsSortFieldsKeyMetaSyncedAt                     SearchCompaniesParamsSortFieldsKey = "meta.syncedAt"
	SearchCompaniesParamsSortFieldsKeySocials                          SearchCompaniesParamsSortFieldsKey = "socials"
	SearchCompaniesParamsSortFieldsKeyTechnologiesActive               SearchCompaniesParamsSortFieldsKey = "technologies.active"
	SearchCompaniesParamsSortFieldsKeyUrls                             SearchCompaniesParamsSortFieldsKey = "urls"
)

Defines values for SearchCompaniesParamsSortFieldsKey.

type SearchCompaniesParamsSortFieldsMissing

type SearchCompaniesParamsSortFieldsMissing string

SearchCompaniesParamsSortFieldsMissing defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSortFieldsMissingUnderscoreFirst SearchCompaniesParamsSortFieldsMissing = "_first"
	SearchCompaniesParamsSortFieldsMissingUnderscoreLast  SearchCompaniesParamsSortFieldsMissing = "_last"
)

Defines values for SearchCompaniesParamsSortFieldsMissing.

type SearchCompaniesParamsSortFieldsOrder

type SearchCompaniesParamsSortFieldsOrder string

SearchCompaniesParamsSortFieldsOrder defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSortFieldsOrderAsc  SearchCompaniesParamsSortFieldsOrder = "asc"
	SearchCompaniesParamsSortFieldsOrderDesc SearchCompaniesParamsSortFieldsOrder = "desc"
)

Defines values for SearchCompaniesParamsSortFieldsOrder.

type SearchCompaniesParamsSortKey

type SearchCompaniesParamsSortKey string

SearchCompaniesParamsSortKey defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSortKeyAboutBusinessType                SearchCompaniesParamsSortKey = "about.businessType"
	SearchCompaniesParamsSortKeyAboutIndustries                  SearchCompaniesParamsSortKey = "about.industries"
	SearchCompaniesParamsSortKeyAboutIndustry                    SearchCompaniesParamsSortKey = "about.industry"
	SearchCompaniesParamsSortKeyAboutName                        SearchCompaniesParamsSortKey = "about.name"
	SearchCompaniesParamsSortKeyAboutTotalEmployees              SearchCompaniesParamsSortKey = "about.totalEmployees"
	SearchCompaniesParamsSortKeyAboutYearFounded                 SearchCompaniesParamsSortKey = "about.yearFounded"
	SearchCompaniesParamsSortKeyAnalyticsMonthlyVisitors         SearchCompaniesParamsSortKey = "analytics.monthlyVisitors"
	SearchCompaniesParamsSortKeyApps                             SearchCompaniesParamsSortKey = "apps"
	SearchCompaniesParamsSortKeyCodesNaics                       SearchCompaniesParamsSortKey = "codes.naics"
	SearchCompaniesParamsSortKeyCodesSic                         SearchCompaniesParamsSortKey = "codes.sic"
	SearchCompaniesParamsSortKeyContacts                         SearchCompaniesParamsSortKey = "contacts"
	SearchCompaniesParamsSortKeyDomainDomain                     SearchCompaniesParamsSortKey = "domain.domain"
	SearchCompaniesParamsSortKeyDomainTld                        SearchCompaniesParamsSortKey = "domain.tld"
	SearchCompaniesParamsSortKeyFinancesRevenue                  SearchCompaniesParamsSortKey = "finances.revenue"
	SearchCompaniesParamsSortKeyLocationsHeadquartersCityCode    SearchCompaniesParamsSortKey = "locations.headquarters.city.code"
	SearchCompaniesParamsSortKeyLocationsHeadquartersCountryCode SearchCompaniesParamsSortKey = "locations.headquarters.country.code"
	SearchCompaniesParamsSortKeyLocationsHeadquartersCountyCode  SearchCompaniesParamsSortKey = "locations.headquarters.county.code"
	SearchCompaniesParamsSortKeyLocationsHeadquartersStateCode   SearchCompaniesParamsSortKey = "locations.headquarters.state.code"
	SearchCompaniesParamsSortKeyMetaScore                        SearchCompaniesParamsSortKey = "meta.score"
	SearchCompaniesParamsSortKeyMetaSyncedAt                     SearchCompaniesParamsSortKey = "meta.syncedAt"
	SearchCompaniesParamsSortKeySocials                          SearchCompaniesParamsSortKey = "socials"
	SearchCompaniesParamsSortKeyTechnologiesActive               SearchCompaniesParamsSortKey = "technologies.active"
	SearchCompaniesParamsSortKeyUrls                             SearchCompaniesParamsSortKey = "urls"
)

Defines values for SearchCompaniesParamsSortKey.

type SearchCompaniesParamsSortOrder

type SearchCompaniesParamsSortOrder string

SearchCompaniesParamsSortOrder defines parameters for SearchCompanies.

const (
	SearchCompaniesParamsSortOrderAsc  SearchCompaniesParamsSortOrder = "asc"
	SearchCompaniesParamsSortOrderDesc SearchCompaniesParamsSortOrder = "desc"
)

Defines values for SearchCompaniesParamsSortOrder.

type SearchCompaniesPost401Messages

type SearchCompaniesPost401Messages string

type SearchCompaniesPost403Messages

type SearchCompaniesPost403Messages string

type SearchCompaniesPostJSONBody

type SearchCompaniesPostJSONBody struct {
	ActionId          *float32                                   `json:"actionId,omitempty"`
	DomainsToExclude  *string                                    `json:"domainsToExclude,omitempty"`
	LinkedinToExclude *string                                    `json:"linkedinToExclude,omitempty"`
	Page              *float32                                   `json:"page,omitempty"`
	Query             *[]SegmentationCondition                   `json:"query,omitempty"`
	Search            *string                                    `json:"search,omitempty"`
	SearchFields      *[]SearchCompaniesPostJSONBodySearchFields `json:"searchFields,omitempty"`
	Simplified        *bool                                      `json:"simplified,omitempty"`
	Size              *float32                                   `json:"size,omitempty"`
	SortFields        *[]struct {
		Key     SearchCompaniesPostJSONBodySortFieldsKey      `json:"key"`
		Missing *SearchCompaniesPostJSONBodySortFieldsMissing `json:"missing,omitempty"`
		Order   SearchCompaniesPostJSONBodySortFieldsOrder    `json:"order"`
	} `json:"sortFields,omitempty"`
	SortKey   *SearchCompaniesPostJSONBodySortKey   `json:"sortKey,omitempty"`
	SortOrder *SearchCompaniesPostJSONBodySortOrder `json:"sortOrder,omitempty"`
}

SearchCompaniesPostJSONBody defines parameters for SearchCompaniesPost.

type SearchCompaniesPostJSONBodySearchFields

type SearchCompaniesPostJSONBodySearchFields string

SearchCompaniesPostJSONBodySearchFields defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySearchFieldsAboutName    SearchCompaniesPostJSONBodySearchFields = "about.name"
	SearchCompaniesPostJSONBodySearchFieldsDomainDomain SearchCompaniesPostJSONBodySearchFields = "domain.domain"
)

Defines values for SearchCompaniesPostJSONBodySearchFields.

type SearchCompaniesPostJSONBodySortFieldsKey

type SearchCompaniesPostJSONBodySortFieldsKey string

SearchCompaniesPostJSONBodySortFieldsKey defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySortFieldsKeyAboutBusinessType                SearchCompaniesPostJSONBodySortFieldsKey = "about.businessType"
	SearchCompaniesPostJSONBodySortFieldsKeyAboutIndustries                  SearchCompaniesPostJSONBodySortFieldsKey = "about.industries"
	SearchCompaniesPostJSONBodySortFieldsKeyAboutIndustry                    SearchCompaniesPostJSONBodySortFieldsKey = "about.industry"
	SearchCompaniesPostJSONBodySortFieldsKeyAboutName                        SearchCompaniesPostJSONBodySortFieldsKey = "about.name"
	SearchCompaniesPostJSONBodySortFieldsKeyAboutTotalEmployees              SearchCompaniesPostJSONBodySortFieldsKey = "about.totalEmployees"
	SearchCompaniesPostJSONBodySortFieldsKeyAboutYearFounded                 SearchCompaniesPostJSONBodySortFieldsKey = "about.yearFounded"
	SearchCompaniesPostJSONBodySortFieldsKeyAnalyticsMonthlyVisitors         SearchCompaniesPostJSONBodySortFieldsKey = "analytics.monthlyVisitors"
	SearchCompaniesPostJSONBodySortFieldsKeyApps                             SearchCompaniesPostJSONBodySortFieldsKey = "apps"
	SearchCompaniesPostJSONBodySortFieldsKeyCodesNaics                       SearchCompaniesPostJSONBodySortFieldsKey = "codes.naics"
	SearchCompaniesPostJSONBodySortFieldsKeyCodesSic                         SearchCompaniesPostJSONBodySortFieldsKey = "codes.sic"
	SearchCompaniesPostJSONBodySortFieldsKeyContacts                         SearchCompaniesPostJSONBodySortFieldsKey = "contacts"
	SearchCompaniesPostJSONBodySortFieldsKeyDomainDomain                     SearchCompaniesPostJSONBodySortFieldsKey = "domain.domain"
	SearchCompaniesPostJSONBodySortFieldsKeyDomainTld                        SearchCompaniesPostJSONBodySortFieldsKey = "domain.tld"
	SearchCompaniesPostJSONBodySortFieldsKeyFinancesRevenue                  SearchCompaniesPostJSONBodySortFieldsKey = "finances.revenue"
	SearchCompaniesPostJSONBodySortFieldsKeyLocationsHeadquartersCityCode    SearchCompaniesPostJSONBodySortFieldsKey = "locations.headquarters.city.code"
	SearchCompaniesPostJSONBodySortFieldsKeyLocationsHeadquartersCountryCode SearchCompaniesPostJSONBodySortFieldsKey = "locations.headquarters.country.code"
	SearchCompaniesPostJSONBodySortFieldsKeyLocationsHeadquartersCountyCode  SearchCompaniesPostJSONBodySortFieldsKey = "locations.headquarters.county.code"
	SearchCompaniesPostJSONBodySortFieldsKeyLocationsHeadquartersStateCode   SearchCompaniesPostJSONBodySortFieldsKey = "locations.headquarters.state.code"
	SearchCompaniesPostJSONBodySortFieldsKeyMetaScore                        SearchCompaniesPostJSONBodySortFieldsKey = "meta.score"
	SearchCompaniesPostJSONBodySortFieldsKeyMetaSyncedAt                     SearchCompaniesPostJSONBodySortFieldsKey = "meta.syncedAt"
	SearchCompaniesPostJSONBodySortFieldsKeySocials                          SearchCompaniesPostJSONBodySortFieldsKey = "socials"
	SearchCompaniesPostJSONBodySortFieldsKeyTechnologiesActive               SearchCompaniesPostJSONBodySortFieldsKey = "technologies.active"
	SearchCompaniesPostJSONBodySortFieldsKeyUrls                             SearchCompaniesPostJSONBodySortFieldsKey = "urls"
)

Defines values for SearchCompaniesPostJSONBodySortFieldsKey.

type SearchCompaniesPostJSONBodySortFieldsMissing

type SearchCompaniesPostJSONBodySortFieldsMissing string

SearchCompaniesPostJSONBodySortFieldsMissing defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySortFieldsMissingUnderscoreFirst SearchCompaniesPostJSONBodySortFieldsMissing = "_first"
	SearchCompaniesPostJSONBodySortFieldsMissingUnderscoreLast  SearchCompaniesPostJSONBodySortFieldsMissing = "_last"
)

Defines values for SearchCompaniesPostJSONBodySortFieldsMissing.

type SearchCompaniesPostJSONBodySortFieldsOrder

type SearchCompaniesPostJSONBodySortFieldsOrder string

SearchCompaniesPostJSONBodySortFieldsOrder defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySortFieldsOrderAsc  SearchCompaniesPostJSONBodySortFieldsOrder = "asc"
	SearchCompaniesPostJSONBodySortFieldsOrderDesc SearchCompaniesPostJSONBodySortFieldsOrder = "desc"
)

Defines values for SearchCompaniesPostJSONBodySortFieldsOrder.

type SearchCompaniesPostJSONBodySortKey

type SearchCompaniesPostJSONBodySortKey string

SearchCompaniesPostJSONBodySortKey defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySortKeyAboutBusinessType                SearchCompaniesPostJSONBodySortKey = "about.businessType"
	SearchCompaniesPostJSONBodySortKeyAboutIndustries                  SearchCompaniesPostJSONBodySortKey = "about.industries"
	SearchCompaniesPostJSONBodySortKeyAboutIndustry                    SearchCompaniesPostJSONBodySortKey = "about.industry"
	SearchCompaniesPostJSONBodySortKeyAboutName                        SearchCompaniesPostJSONBodySortKey = "about.name"
	SearchCompaniesPostJSONBodySortKeyAboutTotalEmployees              SearchCompaniesPostJSONBodySortKey = "about.totalEmployees"
	SearchCompaniesPostJSONBodySortKeyAboutYearFounded                 SearchCompaniesPostJSONBodySortKey = "about.yearFounded"
	SearchCompaniesPostJSONBodySortKeyAnalyticsMonthlyVisitors         SearchCompaniesPostJSONBodySortKey = "analytics.monthlyVisitors"
	SearchCompaniesPostJSONBodySortKeyApps                             SearchCompaniesPostJSONBodySortKey = "apps"
	SearchCompaniesPostJSONBodySortKeyCodesNaics                       SearchCompaniesPostJSONBodySortKey = "codes.naics"
	SearchCompaniesPostJSONBodySortKeyCodesSic                         SearchCompaniesPostJSONBodySortKey = "codes.sic"
	SearchCompaniesPostJSONBodySortKeyContacts                         SearchCompaniesPostJSONBodySortKey = "contacts"
	SearchCompaniesPostJSONBodySortKeyDomainDomain                     SearchCompaniesPostJSONBodySortKey = "domain.domain"
	SearchCompaniesPostJSONBodySortKeyDomainTld                        SearchCompaniesPostJSONBodySortKey = "domain.tld"
	SearchCompaniesPostJSONBodySortKeyFinancesRevenue                  SearchCompaniesPostJSONBodySortKey = "finances.revenue"
	SearchCompaniesPostJSONBodySortKeyLocationsHeadquartersCityCode    SearchCompaniesPostJSONBodySortKey = "locations.headquarters.city.code"
	SearchCompaniesPostJSONBodySortKeyLocationsHeadquartersCountryCode SearchCompaniesPostJSONBodySortKey = "locations.headquarters.country.code"
	SearchCompaniesPostJSONBodySortKeyLocationsHeadquartersCountyCode  SearchCompaniesPostJSONBodySortKey = "locations.headquarters.county.code"
	SearchCompaniesPostJSONBodySortKeyLocationsHeadquartersStateCode   SearchCompaniesPostJSONBodySortKey = "locations.headquarters.state.code"
	SearchCompaniesPostJSONBodySortKeyMetaScore                        SearchCompaniesPostJSONBodySortKey = "meta.score"
	SearchCompaniesPostJSONBodySortKeyMetaSyncedAt                     SearchCompaniesPostJSONBodySortKey = "meta.syncedAt"
	SearchCompaniesPostJSONBodySortKeySocials                          SearchCompaniesPostJSONBodySortKey = "socials"
	SearchCompaniesPostJSONBodySortKeyTechnologiesActive               SearchCompaniesPostJSONBodySortKey = "technologies.active"
	SearchCompaniesPostJSONBodySortKeyUrls                             SearchCompaniesPostJSONBodySortKey = "urls"
)

Defines values for SearchCompaniesPostJSONBodySortKey.

type SearchCompaniesPostJSONBodySortOrder

type SearchCompaniesPostJSONBodySortOrder string

SearchCompaniesPostJSONBodySortOrder defines parameters for SearchCompaniesPost.

const (
	SearchCompaniesPostJSONBodySortOrderAsc  SearchCompaniesPostJSONBodySortOrder = "asc"
	SearchCompaniesPostJSONBodySortOrderDesc SearchCompaniesPostJSONBodySortOrder = "desc"
)

Defines values for SearchCompaniesPostJSONBodySortOrder.

type SearchCompaniesPostJSONRequestBody

type SearchCompaniesPostJSONRequestBody SearchCompaniesPostJSONBody

SearchCompaniesPostJSONRequestBody defines body for SearchCompaniesPost for application/json ContentType.

type SearchCompaniesPostResponse

type SearchCompaniesPostResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta  PaginationMeta          `json:"meta"`
		Query []SegmentationCondition `json:"query"`
	}
	JSON401 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages SearchCompaniesPost401Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                    `json:"details,omitempty"`
		Messages SearchCompaniesPost403Messages `json:"messages"`
		Status   float32                        `json:"status"`
	}
}

func ParseSearchCompaniesPostResponse

func ParseSearchCompaniesPostResponse(rsp *http.Response) (*SearchCompaniesPostResponse, error)

ParseSearchCompaniesPostResponse parses an HTTP response from a SearchCompaniesPostWithResponse call

func (SearchCompaniesPostResponse) Status

Status returns HTTPResponse.Status

func (SearchCompaniesPostResponse) StatusCode

func (r SearchCompaniesPostResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCompaniesResponse

type SearchCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta  PaginationMeta          `json:"meta"`
		Query []SegmentationCondition `json:"query"`
	}
	JSON401 *struct {
		Details  interface{}                `json:"details,omitempty"`
		Messages SearchCompanies401Messages `json:"messages"`
		Status   float32                    `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                `json:"details,omitempty"`
		Messages SearchCompanies403Messages `json:"messages"`
		Status   float32                    `json:"status"`
	}
}

func ParseSearchCompaniesResponse

func ParseSearchCompaniesResponse(rsp *http.Response) (*SearchCompaniesResponse, error)

ParseSearchCompaniesResponse parses an HTTP response from a SearchCompaniesWithResponse call

func (SearchCompaniesResponse) Status

func (r SearchCompaniesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchCompaniesResponse) StatusCode

func (r SearchCompaniesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchContinents401Messages

type SearchContinents401Messages string

type SearchContinentsParams

type SearchContinentsParams struct {
	Page      *float32                         `form:"page,omitempty" json:"page,omitempty"`
	Search    *string                          `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                         `form:"size,omitempty" json:"size,omitempty"`
	SortKey   *SearchContinentsParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchContinentsParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchContinentsParams defines parameters for SearchContinents.

type SearchContinentsParamsSortKey

type SearchContinentsParamsSortKey string

SearchContinentsParamsSortKey defines parameters for SearchContinents.

const (
	SearchContinentsParamsSortKeyCountsCompanies SearchContinentsParamsSortKey = "counts.companies"
)

Defines values for SearchContinentsParamsSortKey.

type SearchContinentsParamsSortOrder

type SearchContinentsParamsSortOrder string

SearchContinentsParamsSortOrder defines parameters for SearchContinents.

const (
	SearchContinentsParamsSortOrderAsc  SearchContinentsParamsSortOrder = "asc"
	SearchContinentsParamsSortOrderDesc SearchContinentsParamsSortOrder = "desc"
)

Defines values for SearchContinentsParamsSortOrder.

type SearchContinentsResponse

type SearchContinentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Continents []NominatimContinent `json:"continents"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                 `json:"details,omitempty"`
		Messages SearchContinents401Messages `json:"messages"`
		Status   float32                     `json:"status"`
	}
}

func ParseSearchContinentsResponse

func ParseSearchContinentsResponse(rsp *http.Response) (*SearchContinentsResponse, error)

ParseSearchContinentsResponse parses an HTTP response from a SearchContinentsWithResponse call

func (SearchContinentsResponse) Status

func (r SearchContinentsResponse) Status() string

Status returns HTTPResponse.Status

func (SearchContinentsResponse) StatusCode

func (r SearchContinentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCounties401Messages

type SearchCounties401Messages string

type SearchCountiesParams

type SearchCountiesParams struct {
	Page      *float32                       `form:"page,omitempty" json:"page,omitempty"`
	Search    *string                        `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                       `form:"size,omitempty" json:"size,omitempty"`
	SortKey   *SearchCountiesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCountiesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCountiesParams defines parameters for SearchCounties.

type SearchCountiesParamsSortKey

type SearchCountiesParamsSortKey string

SearchCountiesParamsSortKey defines parameters for SearchCounties.

const (
	SearchCountiesParamsSortKeyCountsCompanies SearchCountiesParamsSortKey = "counts.companies"
)

Defines values for SearchCountiesParamsSortKey.

type SearchCountiesParamsSortOrder

type SearchCountiesParamsSortOrder string

SearchCountiesParamsSortOrder defines parameters for SearchCounties.

const (
	SearchCountiesParamsSortOrderAsc  SearchCountiesParamsSortOrder = "asc"
	SearchCountiesParamsSortOrderDesc SearchCountiesParamsSortOrder = "desc"
)

Defines values for SearchCountiesParamsSortOrder.

type SearchCountiesResponse

type SearchCountiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Counties []NominatimCounty `json:"counties"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}               `json:"details,omitempty"`
		Messages SearchCounties401Messages `json:"messages"`
		Status   float32                   `json:"status"`
	}
}

func ParseSearchCountiesResponse

func ParseSearchCountiesResponse(rsp *http.Response) (*SearchCountiesResponse, error)

ParseSearchCountiesResponse parses an HTTP response from a SearchCountiesWithResponse call

func (SearchCountiesResponse) Status

func (r SearchCountiesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchCountiesResponse) StatusCode

func (r SearchCountiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchCountries401Messages

type SearchCountries401Messages string

type SearchCountriesParams

type SearchCountriesParams struct {
	Filters   *string                         `form:"filters,omitempty" json:"filters,omitempty"`
	Page      *float32                        `form:"page,omitempty" json:"page,omitempty"`
	Search    *string                         `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                        `form:"size,omitempty" json:"size,omitempty"`
	SortKey   *SearchCountriesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchCountriesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchCountriesParams defines parameters for SearchCountries.

type SearchCountriesParamsSortKey

type SearchCountriesParamsSortKey string

SearchCountriesParamsSortKey defines parameters for SearchCountries.

const (
	SearchCountriesParamsSortKeyCountsCompanies SearchCountriesParamsSortKey = "counts.companies"
)

Defines values for SearchCountriesParamsSortKey.

type SearchCountriesParamsSortOrder

type SearchCountriesParamsSortOrder string

SearchCountriesParamsSortOrder defines parameters for SearchCountries.

const (
	SearchCountriesParamsSortOrderAsc  SearchCountriesParamsSortOrder = "asc"
	SearchCountriesParamsSortOrderDesc SearchCountriesParamsSortOrder = "desc"
)

Defines values for SearchCountriesParamsSortOrder.

type SearchCountriesResponse

type SearchCountriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Countries []NominatimCountry `json:"countries"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                `json:"details,omitempty"`
		Messages SearchCountries401Messages `json:"messages"`
		Status   float32                    `json:"status"`
	}
}

func ParseSearchCountriesResponse

func ParseSearchCountriesResponse(rsp *http.Response) (*SearchCountriesResponse, error)

ParseSearchCountriesResponse parses an HTTP response from a SearchCountriesWithResponse call

func (SearchCountriesResponse) Status

func (r SearchCountriesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchCountriesResponse) StatusCode

func (r SearchCountriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchIndustries401Messages

type SearchIndustries401Messages string

type SearchIndustriesParams

type SearchIndustriesParams struct {
	Page   *float32 `form:"page,omitempty" json:"page,omitempty"`
	Search *string  `form:"search,omitempty" json:"search,omitempty"`
	Size   *float32 `form:"size,omitempty" json:"size,omitempty"`
}

SearchIndustriesParams defines parameters for SearchIndustries.

type SearchIndustriesResponse

type SearchIndustriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Industries []struct {
			CompaniesCount *float32    `json:"companiesCount"`
			Name           string      `json:"name"`
			Slug           interface{} `json:"slug,omitempty"`
		} `json:"industries"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                 `json:"details,omitempty"`
		Messages SearchIndustries401Messages `json:"messages"`
		Status   float32                     `json:"status"`
	}
}

func ParseSearchIndustriesResponse

func ParseSearchIndustriesResponse(rsp *http.Response) (*SearchIndustriesResponse, error)

ParseSearchIndustriesResponse parses an HTTP response from a SearchIndustriesWithResponse call

func (SearchIndustriesResponse) Status

func (r SearchIndustriesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchIndustriesResponse) StatusCode

func (r SearchIndustriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchIndustriesSimilar401Messages

type SearchIndustriesSimilar401Messages string

type SearchIndustriesSimilarParams

type SearchIndustriesSimilarParams struct {
	Industries []string `form:"industries" json:"industries"`
	Page       *float32 `form:"page,omitempty" json:"page,omitempty"`
	Size       *float32 `form:"size,omitempty" json:"size,omitempty"`
}

SearchIndustriesSimilarParams defines parameters for SearchIndustriesSimilar.

type SearchIndustriesSimilarResponse

type SearchIndustriesSimilarResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Industries []struct {
			CompaniesCount *float32    `json:"companiesCount"`
			Name           string      `json:"name"`
			Slug           interface{} `json:"slug,omitempty"`
		} `json:"industries"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                        `json:"details,omitempty"`
		Messages SearchIndustriesSimilar401Messages `json:"messages"`
		Status   float32                            `json:"status"`
	}
}

func ParseSearchIndustriesSimilarResponse

func ParseSearchIndustriesSimilarResponse(rsp *http.Response) (*SearchIndustriesSimilarResponse, error)

ParseSearchIndustriesSimilarResponse parses an HTTP response from a SearchIndustriesSimilarWithResponse call

func (SearchIndustriesSimilarResponse) Status

Status returns HTTPResponse.Status

func (SearchIndustriesSimilarResponse) StatusCode

func (r SearchIndustriesSimilarResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchSimilarCompanies401Messages

type SearchSimilarCompanies401Messages string

type SearchSimilarCompanies403Messages

type SearchSimilarCompanies403Messages string

type SearchSimilarCompaniesParams

type SearchSimilarCompaniesParams struct {
	Domains        []string                                   `form:"domains" json:"domains"`
	Page           *float32                                   `form:"page,omitempty" json:"page,omitempty"`
	ProximityExact *float32                                   `form:"proximityExact,omitempty" json:"proximityExact,omitempty"`
	ProximityTerm  *SearchSimilarCompaniesParamsProximityTerm `form:"proximityTerm,omitempty" json:"proximityTerm,omitempty"`
	Simplified     *bool                                      `form:"simplified,omitempty" json:"simplified,omitempty"`
	Size           *float32                                   `form:"size,omitempty" json:"size,omitempty"`
	SortFields     *[]struct {
		Key     SearchSimilarCompaniesParamsSortFieldsKey      `json:"key"`
		Missing *SearchSimilarCompaniesParamsSortFieldsMissing `json:"missing,omitempty"`
		Order   SearchSimilarCompaniesParamsSortFieldsOrder    `json:"order"`
	} `form:"sortFields,omitempty" json:"sortFields,omitempty"`
	SortKey   *SearchSimilarCompaniesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchSimilarCompaniesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchSimilarCompaniesParams defines parameters for SearchSimilarCompanies.

type SearchSimilarCompaniesParamsProximityTerm

type SearchSimilarCompaniesParamsProximityTerm string

SearchSimilarCompaniesParamsProximityTerm defines parameters for SearchSimilarCompanies.

Defines values for SearchSimilarCompaniesParamsProximityTerm.

type SearchSimilarCompaniesParamsSortFieldsKey

type SearchSimilarCompaniesParamsSortFieldsKey string

SearchSimilarCompaniesParamsSortFieldsKey defines parameters for SearchSimilarCompanies.

const (
	SearchSimilarCompaniesParamsSortFieldsKeyAboutBusinessType                SearchSimilarCompaniesParamsSortFieldsKey = "about.businessType"
	SearchSimilarCompaniesParamsSortFieldsKeyAboutIndustries                  SearchSimilarCompaniesParamsSortFieldsKey = "about.industries"
	SearchSimilarCompaniesParamsSortFieldsKeyAboutIndustry                    SearchSimilarCompaniesParamsSortFieldsKey = "about.industry"
	SearchSimilarCompaniesParamsSortFieldsKeyAboutName                        SearchSimilarCompaniesParamsSortFieldsKey = "about.name"
	SearchSimilarCompaniesParamsSortFieldsKeyAboutTotalEmployees              SearchSimilarCompaniesParamsSortFieldsKey = "about.totalEmployees"
	SearchSimilarCompaniesParamsSortFieldsKeyAboutYearFounded                 SearchSimilarCompaniesParamsSortFieldsKey = "about.yearFounded"
	SearchSimilarCompaniesParamsSortFieldsKeyAnalyticsMonthlyVisitors         SearchSimilarCompaniesParamsSortFieldsKey = "analytics.monthlyVisitors"
	SearchSimilarCompaniesParamsSortFieldsKeyApps                             SearchSimilarCompaniesParamsSortFieldsKey = "apps"
	SearchSimilarCompaniesParamsSortFieldsKeyCodesNaics                       SearchSimilarCompaniesParamsSortFieldsKey = "codes.naics"
	SearchSimilarCompaniesParamsSortFieldsKeyCodesSic                         SearchSimilarCompaniesParamsSortFieldsKey = "codes.sic"
	SearchSimilarCompaniesParamsSortFieldsKeyContacts                         SearchSimilarCompaniesParamsSortFieldsKey = "contacts"
	SearchSimilarCompaniesParamsSortFieldsKeyDomainDomain                     SearchSimilarCompaniesParamsSortFieldsKey = "domain.domain"
	SearchSimilarCompaniesParamsSortFieldsKeyDomainTld                        SearchSimilarCompaniesParamsSortFieldsKey = "domain.tld"
	SearchSimilarCompaniesParamsSortFieldsKeyFinancesRevenue                  SearchSimilarCompaniesParamsSortFieldsKey = "finances.revenue"
	SearchSimilarCompaniesParamsSortFieldsKeyLocationsHeadquartersCityCode    SearchSimilarCompaniesParamsSortFieldsKey = "locations.headquarters.city.code"
	SearchSimilarCompaniesParamsSortFieldsKeyLocationsHeadquartersCountryCode SearchSimilarCompaniesParamsSortFieldsKey = "locations.headquarters.country.code"
	SearchSimilarCompaniesParamsSortFieldsKeyLocationsHeadquartersCountyCode  SearchSimilarCompaniesParamsSortFieldsKey = "locations.headquarters.county.code"
	SearchSimilarCompaniesParamsSortFieldsKeyLocationsHeadquartersStateCode   SearchSimilarCompaniesParamsSortFieldsKey = "locations.headquarters.state.code"
	SearchSimilarCompaniesParamsSortFieldsKeyMetaScore                        SearchSimilarCompaniesParamsSortFieldsKey = "meta.score"
	SearchSimilarCompaniesParamsSortFieldsKeyMetaSyncedAt                     SearchSimilarCompaniesParamsSortFieldsKey = "meta.syncedAt"
	SearchSimilarCompaniesParamsSortFieldsKeySocials                          SearchSimilarCompaniesParamsSortFieldsKey = "socials"
	SearchSimilarCompaniesParamsSortFieldsKeyTechnologiesActive               SearchSimilarCompaniesParamsSortFieldsKey = "technologies.active"
	SearchSimilarCompaniesParamsSortFieldsKeyUrls                             SearchSimilarCompaniesParamsSortFieldsKey = "urls"
)

Defines values for SearchSimilarCompaniesParamsSortFieldsKey.

type SearchSimilarCompaniesParamsSortFieldsMissing

type SearchSimilarCompaniesParamsSortFieldsMissing string

SearchSimilarCompaniesParamsSortFieldsMissing defines parameters for SearchSimilarCompanies.

const (
	SearchSimilarCompaniesParamsSortFieldsMissingUnderscoreFirst SearchSimilarCompaniesParamsSortFieldsMissing = "_first"
	SearchSimilarCompaniesParamsSortFieldsMissingUnderscoreLast  SearchSimilarCompaniesParamsSortFieldsMissing = "_last"
)

Defines values for SearchSimilarCompaniesParamsSortFieldsMissing.

type SearchSimilarCompaniesParamsSortFieldsOrder

type SearchSimilarCompaniesParamsSortFieldsOrder string

SearchSimilarCompaniesParamsSortFieldsOrder defines parameters for SearchSimilarCompanies.

const (
	SearchSimilarCompaniesParamsSortFieldsOrderAsc  SearchSimilarCompaniesParamsSortFieldsOrder = "asc"
	SearchSimilarCompaniesParamsSortFieldsOrderDesc SearchSimilarCompaniesParamsSortFieldsOrder = "desc"
)

Defines values for SearchSimilarCompaniesParamsSortFieldsOrder.

type SearchSimilarCompaniesParamsSortKey

type SearchSimilarCompaniesParamsSortKey string

SearchSimilarCompaniesParamsSortKey defines parameters for SearchSimilarCompanies.

const (
	SearchSimilarCompaniesParamsSortKeyAboutBusinessType                SearchSimilarCompaniesParamsSortKey = "about.businessType"
	SearchSimilarCompaniesParamsSortKeyAboutIndustries                  SearchSimilarCompaniesParamsSortKey = "about.industries"
	SearchSimilarCompaniesParamsSortKeyAboutIndustry                    SearchSimilarCompaniesParamsSortKey = "about.industry"
	SearchSimilarCompaniesParamsSortKeyAboutName                        SearchSimilarCompaniesParamsSortKey = "about.name"
	SearchSimilarCompaniesParamsSortKeyAboutTotalEmployees              SearchSimilarCompaniesParamsSortKey = "about.totalEmployees"
	SearchSimilarCompaniesParamsSortKeyAboutYearFounded                 SearchSimilarCompaniesParamsSortKey = "about.yearFounded"
	SearchSimilarCompaniesParamsSortKeyAnalyticsMonthlyVisitors         SearchSimilarCompaniesParamsSortKey = "analytics.monthlyVisitors"
	SearchSimilarCompaniesParamsSortKeyApps                             SearchSimilarCompaniesParamsSortKey = "apps"
	SearchSimilarCompaniesParamsSortKeyCodesNaics                       SearchSimilarCompaniesParamsSortKey = "codes.naics"
	SearchSimilarCompaniesParamsSortKeyCodesSic                         SearchSimilarCompaniesParamsSortKey = "codes.sic"
	SearchSimilarCompaniesParamsSortKeyContacts                         SearchSimilarCompaniesParamsSortKey = "contacts"
	SearchSimilarCompaniesParamsSortKeyDomainDomain                     SearchSimilarCompaniesParamsSortKey = "domain.domain"
	SearchSimilarCompaniesParamsSortKeyDomainTld                        SearchSimilarCompaniesParamsSortKey = "domain.tld"
	SearchSimilarCompaniesParamsSortKeyFinancesRevenue                  SearchSimilarCompaniesParamsSortKey = "finances.revenue"
	SearchSimilarCompaniesParamsSortKeyLocationsHeadquartersCityCode    SearchSimilarCompaniesParamsSortKey = "locations.headquarters.city.code"
	SearchSimilarCompaniesParamsSortKeyLocationsHeadquartersCountryCode SearchSimilarCompaniesParamsSortKey = "locations.headquarters.country.code"
	SearchSimilarCompaniesParamsSortKeyLocationsHeadquartersCountyCode  SearchSimilarCompaniesParamsSortKey = "locations.headquarters.county.code"
	SearchSimilarCompaniesParamsSortKeyLocationsHeadquartersStateCode   SearchSimilarCompaniesParamsSortKey = "locations.headquarters.state.code"
	SearchSimilarCompaniesParamsSortKeyMetaScore                        SearchSimilarCompaniesParamsSortKey = "meta.score"
	SearchSimilarCompaniesParamsSortKeyMetaSyncedAt                     SearchSimilarCompaniesParamsSortKey = "meta.syncedAt"
	SearchSimilarCompaniesParamsSortKeySocials                          SearchSimilarCompaniesParamsSortKey = "socials"
	SearchSimilarCompaniesParamsSortKeyTechnologiesActive               SearchSimilarCompaniesParamsSortKey = "technologies.active"
	SearchSimilarCompaniesParamsSortKeyUrls                             SearchSimilarCompaniesParamsSortKey = "urls"
)

Defines values for SearchSimilarCompaniesParamsSortKey.

type SearchSimilarCompaniesParamsSortOrder

type SearchSimilarCompaniesParamsSortOrder string

SearchSimilarCompaniesParamsSortOrder defines parameters for SearchSimilarCompanies.

const (
	SearchSimilarCompaniesParamsSortOrderAsc  SearchSimilarCompaniesParamsSortOrder = "asc"
	SearchSimilarCompaniesParamsSortOrderDesc SearchSimilarCompaniesParamsSortOrder = "desc"
)

Defines values for SearchSimilarCompaniesParamsSortOrder.

type SearchSimilarCompaniesResponse

type SearchSimilarCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Companies []CompanyV2 `json:"companies"`

		// Meta Metadata about a paginated or billed response.
		Meta PaginationMeta `json:"meta"`
	}
	JSON401 *struct {
		Details  interface{}                       `json:"details,omitempty"`
		Messages SearchSimilarCompanies401Messages `json:"messages"`
		Status   float32                           `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                       `json:"details,omitempty"`
		Messages SearchSimilarCompanies403Messages `json:"messages"`
		Status   float32                           `json:"status"`
	}
}

func ParseSearchSimilarCompaniesResponse

func ParseSearchSimilarCompaniesResponse(rsp *http.Response) (*SearchSimilarCompaniesResponse, error)

ParseSearchSimilarCompaniesResponse parses an HTTP response from a SearchSimilarCompaniesWithResponse call

func (SearchSimilarCompaniesResponse) Status

Status returns HTTPResponse.Status

func (SearchSimilarCompaniesResponse) StatusCode

func (r SearchSimilarCompaniesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchStates401Messages

type SearchStates401Messages string

type SearchStatesParams

type SearchStatesParams struct {
	Page      *float32                     `form:"page,omitempty" json:"page,omitempty"`
	Search    *string                      `form:"search,omitempty" json:"search,omitempty"`
	Size      *float32                     `form:"size,omitempty" json:"size,omitempty"`
	SortKey   *SearchStatesParamsSortKey   `form:"sortKey,omitempty" json:"sortKey,omitempty"`
	SortOrder *SearchStatesParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`
}

SearchStatesParams defines parameters for SearchStates.

type SearchStatesParamsSortKey

type SearchStatesParamsSortKey string

SearchStatesParamsSortKey defines parameters for SearchStates.

const (
	CountsCompanies SearchStatesParamsSortKey = "counts.companies"
)

Defines values for SearchStatesParamsSortKey.

type SearchStatesParamsSortOrder

type SearchStatesParamsSortOrder string

SearchStatesParamsSortOrder defines parameters for SearchStates.

const (
	Asc  SearchStatesParamsSortOrder = "asc"
	Desc SearchStatesParamsSortOrder = "desc"
)

Defines values for SearchStatesParamsSortOrder.

type SearchStatesResponse

type SearchStatesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Meta Metadata about a paginated or billed response.
		Meta   PaginationMeta   `json:"meta"`
		States []NominatimState `json:"states"`
	}
	JSON401 *struct {
		Details  interface{}             `json:"details,omitempty"`
		Messages SearchStates401Messages `json:"messages"`
		Status   float32                 `json:"status"`
	}
}

func ParseSearchStatesResponse

func ParseSearchStatesResponse(rsp *http.Response) (*SearchStatesResponse, error)

ParseSearchStatesResponse parses an HTTP response from a SearchStatesWithResponse call

func (SearchStatesResponse) Status

func (r SearchStatesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchStatesResponse) StatusCode

func (r SearchStatesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchTechnologies401Messages

type SearchTechnologies401Messages string

type SearchTechnologiesParams

type SearchTechnologiesParams struct {
	Page   *float32 `form:"page,omitempty" json:"page,omitempty"`
	Search *string  `form:"search,omitempty" json:"search,omitempty"`
	Size   *float32 `form:"size,omitempty" json:"size,omitempty"`
}

SearchTechnologiesParams defines parameters for SearchTechnologies.

type SearchTechnologiesResponse

type SearchTechnologiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Meta Metadata about a paginated or billed response.
		Meta         PaginationMeta `json:"meta"`
		Technologies []Technology   `json:"technologies"`
	}
	JSON401 *struct {
		Details  interface{}                   `json:"details,omitempty"`
		Messages SearchTechnologies401Messages `json:"messages"`
		Status   float32                       `json:"status"`
	}
}

func ParseSearchTechnologiesResponse

func ParseSearchTechnologiesResponse(rsp *http.Response) (*SearchTechnologiesResponse, error)

ParseSearchTechnologiesResponse parses an HTTP response from a SearchTechnologiesWithResponse call

func (SearchTechnologiesResponse) Status

Status returns HTTPResponse.Status

func (SearchTechnologiesResponse) StatusCode

func (r SearchTechnologiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SegmentationCondition

type SegmentationCondition struct {
	Attribute       SegmentationConditionAttribute      `json:"attribute"`
	BlockedOperator *bool                               `json:"blockedOperator,omitempty"`
	Operator        SegmentationConditionOperator       `json:"operator"`
	Sign            SegmentationConditionSign           `json:"sign"`
	Values          []SegmentationCondition_Values_Item `json:"values"`
}

SegmentationCondition A condition for our platform segmentation engine.

type SegmentationConditionAttribute

type SegmentationConditionAttribute string

SegmentationConditionAttribute defines model for SegmentationCondition.Attribute.

const (
	SegmentationConditionAttributeAboutBusinessType                  SegmentationConditionAttribute = "about.businessType"
	SegmentationConditionAttributeAboutIndustries                    SegmentationConditionAttribute = "about.industries"
	SegmentationConditionAttributeAboutIndustry                      SegmentationConditionAttribute = "about.industry"
	SegmentationConditionAttributeAboutName                          SegmentationConditionAttribute = "about.name"
	SegmentationConditionAttributeAboutTotalEmployees                SegmentationConditionAttribute = "about.totalEmployees"
	SegmentationConditionAttributeAboutYearFounded                   SegmentationConditionAttribute = "about.yearFounded"
	SegmentationConditionAttributeAiSearch                           SegmentationConditionAttribute = "ai.search"
	SegmentationConditionAttributeAnalyticsMonthlyVisitors           SegmentationConditionAttribute = "analytics.monthlyVisitors"
	SegmentationConditionAttributeApps                               SegmentationConditionAttribute = "apps"
	SegmentationConditionAttributeCodesNaics                         SegmentationConditionAttribute = "codes.naics"
	SegmentationConditionAttributeCodesSic                           SegmentationConditionAttribute = "codes.sic"
	SegmentationConditionAttributeContacts                           SegmentationConditionAttribute = "contacts"
	SegmentationConditionAttributeDomainDomain                       SegmentationConditionAttribute = "domain.domain"
	SegmentationConditionAttributeDomainTld                          SegmentationConditionAttribute = "domain.tld"
	SegmentationConditionAttributeFinancesRevenue                    SegmentationConditionAttribute = "finances.revenue"
	SegmentationConditionAttributeFinancesStockExchange              SegmentationConditionAttribute = "finances.stockExchange"
	SegmentationConditionAttributeLocationsHeadquartersCityCode      SegmentationConditionAttribute = "locations.headquarters.city.code"
	SegmentationConditionAttributeLocationsHeadquartersContinentCode SegmentationConditionAttribute = "locations.headquarters.continent.code"
	SegmentationConditionAttributeLocationsHeadquartersCountryCode   SegmentationConditionAttribute = "locations.headquarters.country.code"
	SegmentationConditionAttributeLocationsHeadquartersCountyCode    SegmentationConditionAttribute = "locations.headquarters.county.code"
	SegmentationConditionAttributeLocationsHeadquartersStateCode     SegmentationConditionAttribute = "locations.headquarters.state.code"
	SegmentationConditionAttributeMetaListIds                        SegmentationConditionAttribute = "meta.listIds"
	SegmentationConditionAttributeMetaScore                          SegmentationConditionAttribute = "meta.score"
	SegmentationConditionAttributeMetaSyncedAt                       SegmentationConditionAttribute = "meta.syncedAt"
	SegmentationConditionAttributeSocials                            SegmentationConditionAttribute = "socials"
	SegmentationConditionAttributeSocialsLinkedinId                  SegmentationConditionAttribute = "socials.linkedin.id"
	SegmentationConditionAttributeTechnologiesActive                 SegmentationConditionAttribute = "technologies.active"
	SegmentationConditionAttributeTechnologiesCategories             SegmentationConditionAttribute = "technologies.categories"
	SegmentationConditionAttributeUrls                               SegmentationConditionAttribute = "urls"
)

Defines values for SegmentationConditionAttribute.

type SegmentationConditionOperator

type SegmentationConditionOperator string

SegmentationConditionOperator defines model for SegmentationCondition.Operator.

Defines values for SegmentationConditionOperator.

type SegmentationConditionSign

type SegmentationConditionSign string

SegmentationConditionSign defines model for SegmentationCondition.Sign.

const (
	Equals      SegmentationConditionSign = "equals"
	ExactEquals SegmentationConditionSign = "exactEquals"
	Greater     SegmentationConditionSign = "greater"
	Lower       SegmentationConditionSign = "lower"
	NotEquals   SegmentationConditionSign = "notEquals"
)

Defines values for SegmentationConditionSign.

type SegmentationConditionValues0

type SegmentationConditionValues0 = string

SegmentationConditionValues0 defines model for .

type SegmentationConditionValues1

type SegmentationConditionValues1 = float32

SegmentationConditionValues1 defines model for .

type SegmentationCondition_Values_Item

type SegmentationCondition_Values_Item struct {
	// contains filtered or unexported fields
}

SegmentationCondition_Values_Item defines model for SegmentationCondition.values.Item.

func (SegmentationCondition_Values_Item) AsSegmentationConditionValues0

func (t SegmentationCondition_Values_Item) AsSegmentationConditionValues0() (SegmentationConditionValues0, error)

AsSegmentationConditionValues0 returns the union data inside the SegmentationCondition_Values_Item as a SegmentationConditionValues0

func (SegmentationCondition_Values_Item) AsSegmentationConditionValues1

func (t SegmentationCondition_Values_Item) AsSegmentationConditionValues1() (SegmentationConditionValues1, error)

AsSegmentationConditionValues1 returns the union data inside the SegmentationCondition_Values_Item as a SegmentationConditionValues1

func (*SegmentationCondition_Values_Item) FromSegmentationConditionValues0

func (t *SegmentationCondition_Values_Item) FromSegmentationConditionValues0(v SegmentationConditionValues0) error

FromSegmentationConditionValues0 overwrites any union data inside the SegmentationCondition_Values_Item as the provided SegmentationConditionValues0

func (*SegmentationCondition_Values_Item) FromSegmentationConditionValues1

func (t *SegmentationCondition_Values_Item) FromSegmentationConditionValues1(v SegmentationConditionValues1) error

FromSegmentationConditionValues1 overwrites any union data inside the SegmentationCondition_Values_Item as the provided SegmentationConditionValues1

func (SegmentationCondition_Values_Item) MarshalJSON

func (t SegmentationCondition_Values_Item) MarshalJSON() ([]byte, error)

func (*SegmentationCondition_Values_Item) MergeSegmentationConditionValues0

func (t *SegmentationCondition_Values_Item) MergeSegmentationConditionValues0(v SegmentationConditionValues0) error

MergeSegmentationConditionValues0 performs a merge with any union data inside the SegmentationCondition_Values_Item, using the provided SegmentationConditionValues0

func (*SegmentationCondition_Values_Item) MergeSegmentationConditionValues1

func (t *SegmentationCondition_Values_Item) MergeSegmentationConditionValues1(v SegmentationConditionValues1) error

MergeSegmentationConditionValues1 performs a merge with any union data inside the SegmentationCondition_Values_Item, using the provided SegmentationConditionValues1

func (*SegmentationCondition_Values_Item) UnmarshalJSON

func (t *SegmentationCondition_Values_Item) UnmarshalJSON(b []byte) error

type Team

type Team struct {
	Admin                    *bool   `json:"admin"`
	Country                  *string `json:"country"`
	CreatedAt                *string `json:"createdAt"`
	Credits                  float32 `json:"credits"`
	CreditsPack              float32 `json:"creditsPack"`
	Id                       float32 `json:"id"`
	Name                     *string `json:"name"`
	Role                     *string `json:"role"`
	StripeCustomerId         *string `json:"stripeCustomerId"`
	StripeProductId          *string `json:"stripeProductId"`
	StripeSubscribed         bool    `json:"stripeSubscribed"`
	StripeSubscriptionId     *string `json:"stripeSubscriptionId"`
	StripeSubscriptionStatus *string `json:"stripeSubscriptionStatus"`
	WebsiteUrl               *string `json:"websiteUrl"`
}

Team A collection of users that can access the same resources.

type Technology

type Technology struct {
	Categories     *[]string `json:"categories"`
	CompaniesCount *float32  `json:"companiesCount"`
	CreatedAt      *string   `json:"createdAt"`
	Editor         string    `json:"editor"`
	Free           *bool     `json:"free"`
	Id             float32   `json:"id"`
	Name           string    `json:"name"`
	NameSynonyms   *[]string `json:"nameSynonyms"`
	Paid           *bool     `json:"paid"`
	Slug           string    `json:"slug"`
	UpdatedAt      *string   `json:"updatedAt"`
	UsageCount     *float32  `json:"usageCount"`
	WebsiteUrl     *string   `json:"websiteUrl"`
}

Technology A technology description from our platform.

type ToggleCompaniesInList400Messages

type ToggleCompaniesInList400Messages string

type ToggleCompaniesInList401Messages

type ToggleCompaniesInList401Messages string

type ToggleCompaniesInList403Messages

type ToggleCompaniesInList403Messages string

type ToggleCompaniesInList404Messages

type ToggleCompaniesInList404Messages string

type ToggleCompaniesInListJSONBody

type ToggleCompaniesInListJSONBody struct {
	Action     ToggleCompaniesInListJSONBodyAction `json:"action"`
	CompanyIds *[]float32                          `json:"companyIds,omitempty"`
	Domains    *[]string                           `json:"domains,omitempty"`
	Refresh    *bool                               `json:"refresh,omitempty"`
}

ToggleCompaniesInListJSONBody defines parameters for ToggleCompaniesInList.

type ToggleCompaniesInListJSONBodyAction

type ToggleCompaniesInListJSONBodyAction string

ToggleCompaniesInListJSONBodyAction defines parameters for ToggleCompaniesInList.

const (
	Attach ToggleCompaniesInListJSONBodyAction = "attach"
	Detach ToggleCompaniesInListJSONBodyAction = "detach"
)

Defines values for ToggleCompaniesInListJSONBodyAction.

type ToggleCompaniesInListJSONRequestBody

type ToggleCompaniesInListJSONRequestBody ToggleCompaniesInListJSONBody

ToggleCompaniesInListJSONRequestBody defines body for ToggleCompaniesInList for application/json ContentType.

type ToggleCompaniesInListResponse

type ToggleCompaniesInListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *List
	JSON400      *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages ToggleCompaniesInList400Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages ToggleCompaniesInList401Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages ToggleCompaniesInList403Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}                      `json:"details,omitempty"`
		Messages ToggleCompaniesInList404Messages `json:"messages"`
		Status   float32                          `json:"status"`
	}
}

func ParseToggleCompaniesInListResponse

func ParseToggleCompaniesInListResponse(rsp *http.Response) (*ToggleCompaniesInListResponse, error)

ParseToggleCompaniesInListResponse parses an HTTP response from a ToggleCompaniesInListWithResponse call

func (ToggleCompaniesInListResponse) Status

Status returns HTTPResponse.Status

func (ToggleCompaniesInListResponse) StatusCode

func (r ToggleCompaniesInListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateList400Messages

type UpdateList400Messages string

type UpdateList401Messages

type UpdateList401Messages string

type UpdateList403Messages

type UpdateList403Messages string

type UpdateListJSONBody

type UpdateListJSONBody struct {
	Dynamic       *bool                            `json:"dynamic,omitempty"`
	LastSeen      *bool                            `json:"lastSeen,omitempty"`
	MailFrequency *UpdateListJSONBodyMailFrequency `json:"mailFrequency,omitempty"`
	MaxCompanies  *float32                         `json:"maxCompanies"`
	Name          *string                          `json:"name,omitempty"`
	Query         *[]SegmentationCondition         `json:"query,omitempty"`
	Resync        *bool                            `json:"resync,omitempty"`
}

UpdateListJSONBody defines parameters for UpdateList.

type UpdateListJSONBodyMailFrequency

type UpdateListJSONBodyMailFrequency string

UpdateListJSONBodyMailFrequency defines parameters for UpdateList.

const (
	Daily    UpdateListJSONBodyMailFrequency = "daily"
	Disabled UpdateListJSONBodyMailFrequency = "disabled"
	Monthly  UpdateListJSONBodyMailFrequency = "monthly"
	Weekly   UpdateListJSONBodyMailFrequency = "weekly"
)

Defines values for UpdateListJSONBodyMailFrequency.

type UpdateListJSONRequestBody

type UpdateListJSONRequestBody UpdateListJSONBody

UpdateListJSONRequestBody defines body for UpdateList for application/json ContentType.

type UpdateListResponse

type UpdateListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *List
	JSON400      *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateList400Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON401 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateList401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateList403Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseUpdateListResponse

func ParseUpdateListResponse(rsp *http.Response) (*UpdateListResponse, error)

ParseUpdateListResponse parses an HTTP response from a UpdateListWithResponse call

func (UpdateListResponse) Status

func (r UpdateListResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateListResponse) StatusCode

func (r UpdateListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTeam401Messages

type UpdateTeam401Messages string

type UpdateTeam403Messages

type UpdateTeam403Messages string

type UpdateTeam404Messages

type UpdateTeam404Messages string

type UpdateTeamJSONBody

type UpdateTeamJSONBody struct {
	Country    *string `json:"country,omitempty"`
	Name       *string `json:"name,omitempty"`
	WebsiteUrl *string `json:"websiteUrl,omitempty"`
}

UpdateTeamJSONBody defines parameters for UpdateTeam.

type UpdateTeamJSONRequestBody

type UpdateTeamJSONRequestBody UpdateTeamJSONBody

UpdateTeamJSONRequestBody defines body for UpdateTeam for application/json ContentType.

type UpdateTeamResponse

type UpdateTeamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Team
	JSON401      *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateTeam401Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON403 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateTeam403Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
	JSON404 *struct {
		Details  interface{}           `json:"details,omitempty"`
		Messages UpdateTeam404Messages `json:"messages"`
		Status   float32               `json:"status"`
	}
}

func ParseUpdateTeamResponse

func ParseUpdateTeamResponse(rsp *http.Response) (*UpdateTeamResponse, error)

ParseUpdateTeamResponse parses an HTTP response from a UpdateTeamWithResponse call

func (UpdateTeamResponse) Status

func (r UpdateTeamResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateTeamResponse) StatusCode

func (r UpdateTeamResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type User

type User struct {
	ColorMode             *UserColorMode `json:"colorMode,omitempty"`
	CreatedAt             *string        `json:"createdAt"`
	CurrentTeamId         *float32       `json:"currentTeamId"`
	Email                 string         `json:"email"`
	EmailFree             *bool          `json:"emailFree"`
	EmailVerified         *bool          `json:"emailVerified"`
	EmailVerifiedResentAt *string        `json:"emailVerifiedResentAt"`
	FullName              *string        `json:"fullName"`
	HasPassword           *bool          `json:"hasPassword"`
	Id                    float32        `json:"id"`
	Locale                interface{}    `json:"locale,omitempty"`
	PictureUrl            *string        `json:"pictureUrl"`
	Referral              *string        `json:"referral"`
	Role                  *UserRole      `json:"role"`
}

User A user of the platform.

type UserColorMode

type UserColorMode string

UserColorMode defines model for User.ColorMode.

const (
	Dark   UserColorMode = "dark"
	Light  UserColorMode = "light"
	System UserColorMode = "system"
)

Defines values for UserColorMode.

type UserRole

type UserRole string

UserRole defines model for User.Role.

const (
	UserRoleOwner UserRole = "owner"
	UserRoleUser  UserRole = "user"
)

Defines values for UserRole.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL