contextdev

package module
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: May 31, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

README

Context Dev Go API Library

Go Reference

The Context Dev Go library provides convenient access to the Context Dev REST API from applications written in Go.

It is generated with Stainless.

MCP Server

Use the Context Dev MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.

Add to Cursor Install in VS Code

Note: You may need to set environment variables in your MCP client.

Installation

import (
	"github.com/context-dot-dev/context-go-sdk" // imported as contextdev
)

Or to pin the version:

go get -u 'github.com/context-dot-dev/context-go-sdk@v0.5.0'

Requirements

This library requires Go 1.22+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/context-dot-dev/context-go-sdk"
	"github.com/context-dot-dev/context-go-sdk/option"
)

func main() {
	client := contextdev.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("CONTEXT_DEV_API_KEY")
	)
	brand, err := client.Brand.Get(context.TODO(), contextdev.BrandGetParams{
		Domain: "REPLACE_ME",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", brand.Brand)
}
Request fields

The contextdev library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `api:"required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, contextdev.String(string), contextdev.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := contextdev.ExampleParams{
	ID:   "id_xxx",                 // required property
	Name: contextdev.String("..."), // optional property

	Point: contextdev.Point{
		X: 0,                 // required field will serialize as 0
		Y: contextdev.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: contextdev.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[contextdev.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of its variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

All fields in response structs are ordinary value types (not pointers or wrappers). Response structs also include a special JSON field containing metadata about each property.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := contextdev.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Brand.Get(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *contextdev.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Brand.Get(context.TODO(), contextdev.BrandGetParams{
	Domain: "REPLACE_ME",
})
if err != nil {
	var apierr *contextdev.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/brand/retrieve": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Brand.Get(
	ctx,
	contextdev.BrandGetParams{
		Domain: "REPLACE_ME",
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as io.Reader. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper contextdev.File(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := contextdev.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Brand.Get(
	context.TODO(),
	contextdev.BrandGetParams{
		Domain: "REPLACE_ME",
	},
	option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
brand, err := client.Brand.Get(
	context.TODO(),
	contextdev.BrandGetParams{
		Domain: "REPLACE_ME",
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", brand)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]any

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: contextdev.String("John"),
    },
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := contextdev.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(b bool) param.Opt[bool]

func BoolPtr 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (CONTEXT_DEV_API_KEY, CONTEXT_DEV_BASE_URL). This should be used to initialize new clients.

func File 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

func Opt[T comparable](v T) param.Opt[T]

func Ptr 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr 

func StringPtr(v string) *string

func Time 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr 

func TimePtr(v time.Time) *time.Time

Types

type AIAIQueryParams 

type AIAIQueryParams struct {
	// Array of data points to extract from the website
	DataToExtract []AIAIQueryParamsDataToExtract `json:"data_to_extract,omitzero" api:"required"`
	// The domain name to analyze
	Domain string `json:"domain" api:"required"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// Optional object specifying which pages to analyze
	SpecificPages AIAIQueryParamsSpecificPages `json:"specific_pages,omitzero"`
	// contains filtered or unexported fields
}

func (AIAIQueryParams) MarshalJSON 

func (r AIAIQueryParams) MarshalJSON() (data []byte, err error)

func (*AIAIQueryParams) UnmarshalJSON 

func (r *AIAIQueryParams) UnmarshalJSON(data []byte) error

type AIAIQueryParamsDataToExtract 

type AIAIQueryParamsDataToExtract struct {
	// Description of what to extract
	DatapointDescription string `json:"datapoint_description" api:"required"`
	// Example of the expected value
	DatapointExample string `json:"datapoint_example" api:"required"`
	// Name of the data point to extract
	DatapointName string `json:"datapoint_name" api:"required"`
	// Type of the data point
	//
	// Any of "text", "number", "date", "boolean", "list", "url".
	DatapointType string `json:"datapoint_type,omitzero" api:"required"`
	// Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
	// Use 'object' to extract an array of objects matching a schema.
	//
	// Any of "string", "text", "number", "date", "boolean", "list", "url", "object".
	DatapointListType string `json:"datapoint_list_type,omitzero"`
	// Schema definition for objects when datapoint_list_type is 'object'. Provide a
	// map of field names to their scalar types.
	//
	// Any of "string", "number", "date", "boolean".
	DatapointObjectSchema map[string]string `json:"datapoint_object_schema,omitzero"`
	// contains filtered or unexported fields
}

The properties DatapointDescription, DatapointExample, DatapointName, DatapointType are required.

func (AIAIQueryParamsDataToExtract) MarshalJSON 

func (r AIAIQueryParamsDataToExtract) MarshalJSON() (data []byte, err error)

func (*AIAIQueryParamsDataToExtract) UnmarshalJSON 

func (r *AIAIQueryParamsDataToExtract) UnmarshalJSON(data []byte) error

type AIAIQueryParamsSpecificPages 

type AIAIQueryParamsSpecificPages struct {
	// Whether to analyze the about us page
	AboutUs param.Opt[bool] `json:"about_us,omitzero"`
	// Whether to analyze the blog
	Blog param.Opt[bool] `json:"blog,omitzero"`
	// Whether to analyze the careers page
	Careers param.Opt[bool] `json:"careers,omitzero"`
	// Whether to analyze the contact us page
	ContactUs param.Opt[bool] `json:"contact_us,omitzero"`
	// Whether to analyze the FAQ page
	Faq param.Opt[bool] `json:"faq,omitzero"`
	// Whether to analyze the home page
	HomePage param.Opt[bool] `json:"home_page,omitzero"`
	// Whether to analyze the pricing page
	Pricing param.Opt[bool] `json:"pricing,omitzero"`
	// Whether to analyze the privacy policy page
	PrivacyPolicy param.Opt[bool] `json:"privacy_policy,omitzero"`
	// Whether to analyze the terms and conditions page
	TermsAndConditions param.Opt[bool] `json:"terms_and_conditions,omitzero"`
	// contains filtered or unexported fields
}

Optional object specifying which pages to analyze

func (AIAIQueryParamsSpecificPages) MarshalJSON 

func (r AIAIQueryParamsSpecificPages) MarshalJSON() (data []byte, err error)

func (*AIAIQueryParamsSpecificPages) UnmarshalJSON 

func (r *AIAIQueryParamsSpecificPages) UnmarshalJSON(data []byte) error

type AIExtractProductParams 

type AIExtractProductParams struct {
	// The product page URL to extract product data from.
	URL string `json:"url" api:"required" format:"uri"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// contains filtered or unexported fields
}

func (AIExtractProductParams) MarshalJSON 

func (r AIExtractProductParams) MarshalJSON() (data []byte, err error)

func (*AIExtractProductParams) UnmarshalJSON 

func (r *AIExtractProductParams) UnmarshalJSON(data []byte) error

type AIExtractProductResponse 

type AIExtractProductResponse struct {
	// Whether the given URL is a product detail page
	IsProductPage bool `json:"is_product_page"`
	// The detected ecommerce platform, or null if not a product page
	//
	// Any of "amazon", "tiktok_shop", "etsy", "generic".
	Platform AIExtractProductResponsePlatform `json:"platform" api:"nullable"`
	// The extracted product data, or null if not a product page
	Product AIExtractProductResponseProduct `json:"product" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		IsProductPage respjson.Field
		Platform      respjson.Field
		Product       respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AIExtractProductResponse) RawJSON 

func (r AIExtractProductResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AIExtractProductResponse) UnmarshalJSON 

func (r *AIExtractProductResponse) UnmarshalJSON(data []byte) error

type AIExtractProductResponsePlatform 

type AIExtractProductResponsePlatform string

The detected ecommerce platform, or null if not a product page 

const (
	AIExtractProductResponsePlatformAmazon     AIExtractProductResponsePlatform = "amazon"
	AIExtractProductResponsePlatformTiktokShop AIExtractProductResponsePlatform = "tiktok_shop"
	AIExtractProductResponsePlatformEtsy       AIExtractProductResponsePlatform = "etsy"
	AIExtractProductResponsePlatformGeneric    AIExtractProductResponsePlatform = "generic"
)

type AIExtractProductResponseProduct 

type AIExtractProductResponseProduct struct {
	// Description of the product
	Description string `json:"description" api:"required"`
	// List of product features
	Features []string `json:"features" api:"required"`
	// URLs to product images on the page (up to 7)
	Images []string `json:"images" api:"required"`
	// Name of the product
	Name string `json:"name" api:"required"`
	// Stock Keeping Unit (product identifier). Null if no identifier is found.
	SKU string `json:"sku" api:"required"`
	// Tags associated with the product
	Tags []string `json:"tags" api:"required"`
	// Target audience for the product (array of strings)
	TargetAudience []string `json:"target_audience" api:"required"`
	// Billing frequency for the product
	//
	// Any of "monthly", "yearly", "one_time", "usage_based".
	BillingFrequency string `json:"billing_frequency" api:"nullable"`
	// Category of the product
	Category string `json:"category" api:"nullable"`
	// Currency code for the price (e.g., USD, EUR)
	Currency string `json:"currency" api:"nullable"`
	// URL to the product image
	ImageURL string `json:"image_url" api:"nullable"`
	// Price of the product
	Price float64 `json:"price" api:"nullable"`
	// Pricing model for the product
	//
	// Any of "per_seat", "flat", "tiered", "freemium", "custom".
	PricingModel string `json:"pricing_model" api:"nullable"`
	// URL to the product page
	URL string `json:"url" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Description      respjson.Field
		Features         respjson.Field
		Images           respjson.Field
		Name             respjson.Field
		SKU              respjson.Field
		Tags             respjson.Field
		TargetAudience   respjson.Field
		BillingFrequency respjson.Field
		Category         respjson.Field
		Currency         respjson.Field
		ImageURL         respjson.Field
		Price            respjson.Field
		PricingModel     respjson.Field
		URL              respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

The extracted product data, or null if not a product page

func (AIExtractProductResponseProduct) RawJSON 

func (r AIExtractProductResponseProduct) RawJSON() string

Returns the unmodified JSON received from the API

func (*AIExtractProductResponseProduct) UnmarshalJSON 

func (r *AIExtractProductResponseProduct) UnmarshalJSON(data []byte) error

type AIExtractProductsParams 

type AIExtractProductsParams struct {

	// This field is a request body variant, only one variant field can be set.
	OfByDomain *AIExtractProductsParamsBodyByDomain `json:",inline"`
	// This field is a request body variant, only one variant field can be set.
	OfByDirectURL *AIExtractProductsParamsBodyByDirectURL `json:",inline"`
	// contains filtered or unexported fields
}

func (AIExtractProductsParams) MarshalJSON 

func (u AIExtractProductsParams) MarshalJSON() ([]byte, error)

func (*AIExtractProductsParams) UnmarshalJSON 

func (r *AIExtractProductsParams) UnmarshalJSON(data []byte) error

type AIExtractProductsParamsBodyByDirectURL 

type AIExtractProductsParamsBodyByDirectURL struct {
	// A specific URL to use directly as the starting point for extraction without
	// domain resolution.
	DirectURL string `json:"directUrl" api:"required" format:"uri"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Maximum number of products to extract.
	MaxProducts param.Opt[int64] `json:"maxProducts,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// contains filtered or unexported fields
}

The property DirectURL is required.

func (AIExtractProductsParamsBodyByDirectURL) MarshalJSON 

func (r AIExtractProductsParamsBodyByDirectURL) MarshalJSON() (data []byte, err error)

func (*AIExtractProductsParamsBodyByDirectURL) UnmarshalJSON 

func (r *AIExtractProductsParamsBodyByDirectURL) UnmarshalJSON(data []byte) error

type AIExtractProductsParamsBodyByDomain 

type AIExtractProductsParamsBodyByDomain struct {
	// The domain name to analyze.
	Domain string `json:"domain" api:"required"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Maximum number of products to extract.
	MaxProducts param.Opt[int64] `json:"maxProducts,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// contains filtered or unexported fields
}

The property Domain is required.

func (AIExtractProductsParamsBodyByDomain) MarshalJSON 

func (r AIExtractProductsParamsBodyByDomain) MarshalJSON() (data []byte, err error)

func (*AIExtractProductsParamsBodyByDomain) UnmarshalJSON 

func (r *AIExtractProductsParamsBodyByDomain) UnmarshalJSON(data []byte) error

type AIExtractProductsResponse 

type AIExtractProductsResponse struct {
	// Array of products extracted from the website
	Products []AIExtractProductsResponseProduct `json:"products"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Products    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AIExtractProductsResponse) RawJSON 

func (r AIExtractProductsResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AIExtractProductsResponse) UnmarshalJSON 

func (r *AIExtractProductsResponse) UnmarshalJSON(data []byte) error

type AIExtractProductsResponseProduct 

type AIExtractProductsResponseProduct struct {
	// Description of the product
	Description string `json:"description" api:"required"`
	// List of product features
	Features []string `json:"features" api:"required"`
	// URLs to product images on the page (up to 7)
	Images []string `json:"images" api:"required"`
	// Name of the product
	Name string `json:"name" api:"required"`
	// Stock Keeping Unit (product identifier). Null if no identifier is found.
	SKU string `json:"sku" api:"required"`
	// Tags associated with the product
	Tags []string `json:"tags" api:"required"`
	// Target audience for the product (array of strings)
	TargetAudience []string `json:"target_audience" api:"required"`
	// Billing frequency for the product
	//
	// Any of "monthly", "yearly", "one_time", "usage_based".
	BillingFrequency string `json:"billing_frequency" api:"nullable"`
	// Category of the product
	Category string `json:"category" api:"nullable"`
	// Currency code for the price (e.g., USD, EUR)
	Currency string `json:"currency" api:"nullable"`
	// URL to the product image
	ImageURL string `json:"image_url" api:"nullable"`
	// Price of the product
	Price float64 `json:"price" api:"nullable"`
	// Pricing model for the product
	//
	// Any of "per_seat", "flat", "tiered", "freemium", "custom".
	PricingModel string `json:"pricing_model" api:"nullable"`
	// URL to the product page
	URL string `json:"url" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Description      respjson.Field
		Features         respjson.Field
		Images           respjson.Field
		Name             respjson.Field
		SKU              respjson.Field
		Tags             respjson.Field
		TargetAudience   respjson.Field
		BillingFrequency respjson.Field
		Category         respjson.Field
		Currency         respjson.Field
		ImageURL         respjson.Field
		Price            respjson.Field
		PricingModel     respjson.Field
		URL              respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AIExtractProductsResponseProduct) RawJSON 

func (r AIExtractProductsResponseProduct) RawJSON() string

Returns the unmodified JSON received from the API

func (*AIExtractProductsResponseProduct) UnmarshalJSON 

func (r *AIExtractProductsResponseProduct) UnmarshalJSON(data []byte) error

type AIService 

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

AIService contains methods and other services that help with interacting with the context.dev API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIService method instead.

func NewAIService 

func NewAIService(opts ...option.RequestOption) (r AIService)

NewAIService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AIService) AIQuery 

func (r *AIService) AIQuery(ctx context.Context, body AIAIQueryParams, opts ...option.RequestOption) (res *AiaiQueryResponse, err error)

Use AI to extract specific data points from a brand's website. The AI will crawl the website and extract the requested information based on the provided data points.

func (*AIService) ExtractProduct 

func (r *AIService) ExtractProduct(ctx context.Context, body AIExtractProductParams, opts ...option.RequestOption) (res *AIExtractProductResponse, err error)

Given a single URL, determines if it is a product page and extracts the product information.

func (*AIService) ExtractProducts 

func (r *AIService) ExtractProducts(ctx context.Context, body AIExtractProductsParams, opts ...option.RequestOption) (res *AIExtractProductsResponse, err error)

Extract product information from a brand's website. We will analyze the website and return a list of products with details such as name, description, image, pricing, features, and more.

type AiaiQueryResponse 

type AiaiQueryResponse struct {
	// Array of extracted data points
	DataExtracted []AiaiQueryResponseDataExtracted `json:"data_extracted"`
	// The domain that was analyzed
	Domain string `json:"domain"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// List of URLs that were analyzed
	URLsAnalyzed []string `json:"urls_analyzed"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		DataExtracted respjson.Field
		Domain        respjson.Field
		Status        respjson.Field
		URLsAnalyzed  respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AiaiQueryResponse) RawJSON 

func (r AiaiQueryResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AiaiQueryResponse) UnmarshalJSON 

func (r *AiaiQueryResponse) UnmarshalJSON(data []byte) error

type AiaiQueryResponseDataExtracted 

type AiaiQueryResponseDataExtracted struct {
	// Name of the extracted data point
	DatapointName string `json:"datapoint_name"`
	// Value of the extracted data point. Can be a primitive type, an array of
	// primitives, or an array of objects when datapoint_list_type is 'object'.
	DatapointValue AiaiQueryResponseDataExtractedDatapointValueUnion `json:"datapoint_value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		DatapointName  respjson.Field
		DatapointValue respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AiaiQueryResponseDataExtracted) RawJSON 

func (r AiaiQueryResponseDataExtracted) RawJSON() string

Returns the unmodified JSON received from the API

func (*AiaiQueryResponseDataExtracted) UnmarshalJSON 

func (r *AiaiQueryResponseDataExtracted) UnmarshalJSON(data []byte) error

type AiaiQueryResponseDataExtractedDatapointValueUnion 

type AiaiQueryResponseDataExtractedDatapointValueUnion struct {
	// This field will be present if the value is a [string] instead of an object.
	OfString string `json:",inline"`
	// This field will be present if the value is a [float64] instead of an object.
	OfFloat float64 `json:",inline"`
	// This field will be present if the value is a [bool] instead of an object.
	OfBool bool `json:",inline"`
	// This field will be present if the value is a [[]string] instead of an object.
	OfStringArray []string `json:",inline"`
	// This field will be present if the value is a [[]float64] instead of an object.
	OfFloatArray []float64 `json:",inline"`
	// This field will be present if the value is a [[]any] instead of an object.
	OfAnyArray []any `json:",inline"`
	JSON       struct {
		OfString      respjson.Field
		OfFloat       respjson.Field
		OfBool        respjson.Field
		OfStringArray respjson.Field
		OfFloatArray  respjson.Field
		OfAnyArray    respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

AiaiQueryResponseDataExtractedDatapointValueUnion contains all possible properties and values from [string], [float64], [bool], [[]string], [[]float64], [[]any].

Use the methods beginning with 'As' to cast the union to one of its variants.

If the underlying value is not a json object, one of the following properties will be valid: OfString OfFloat OfBool OfStringArray OfFloatArray OfAnyArray]

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsAnyArray 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsAnyArray() (v []any)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsBool 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsBool() (v bool)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsFloat 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsFloat() (v float64)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsFloatArray 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsFloatArray() (v []float64)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsString 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsString() (v string)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) AsStringArray 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) AsStringArray() (v []string)

func (AiaiQueryResponseDataExtractedDatapointValueUnion) RawJSON 

func (u AiaiQueryResponseDataExtractedDatapointValueUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*AiaiQueryResponseDataExtractedDatapointValueUnion) UnmarshalJSON 

func (r *AiaiQueryResponseDataExtractedDatapointValueUnion) UnmarshalJSON(data []byte) error

type BrandGetByEmailParams 

type BrandGetByEmailParams struct {
	// Email address to retrieve brand data for (e.g., 'contact@example.com'). The
	// domain will be extracted from the email. Free email providers (gmail.com,
	// yahoo.com, etc.) and disposable email addresses are not allowed.
	Email string `query:"email" api:"required" format:"email" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandGetByEmailParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetByEmailParams) URLQuery 

func (r BrandGetByEmailParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetByEmailParams's query parameters as `url.Values`.

type BrandGetByEmailParamsForceLanguage 

type BrandGetByEmailParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandGetByEmailParamsForceLanguageAfrikaans      BrandGetByEmailParamsForceLanguage = "afrikaans"
	BrandGetByEmailParamsForceLanguageAlbanian       BrandGetByEmailParamsForceLanguage = "albanian"
	BrandGetByEmailParamsForceLanguageAmharic        BrandGetByEmailParamsForceLanguage = "amharic"
	BrandGetByEmailParamsForceLanguageArabic         BrandGetByEmailParamsForceLanguage = "arabic"
	BrandGetByEmailParamsForceLanguageArmenian       BrandGetByEmailParamsForceLanguage = "armenian"
	BrandGetByEmailParamsForceLanguageAssamese       BrandGetByEmailParamsForceLanguage = "assamese"
	BrandGetByEmailParamsForceLanguageAymara         BrandGetByEmailParamsForceLanguage = "aymara"
	BrandGetByEmailParamsForceLanguageAzeri          BrandGetByEmailParamsForceLanguage = "azeri"
	BrandGetByEmailParamsForceLanguageBasque         BrandGetByEmailParamsForceLanguage = "basque"
	BrandGetByEmailParamsForceLanguageBelarusian     BrandGetByEmailParamsForceLanguage = "belarusian"
	BrandGetByEmailParamsForceLanguageBengali        BrandGetByEmailParamsForceLanguage = "bengali"
	BrandGetByEmailParamsForceLanguageBosnian        BrandGetByEmailParamsForceLanguage = "bosnian"
	BrandGetByEmailParamsForceLanguageBulgarian      BrandGetByEmailParamsForceLanguage = "bulgarian"
	BrandGetByEmailParamsForceLanguageBurmese        BrandGetByEmailParamsForceLanguage = "burmese"
	BrandGetByEmailParamsForceLanguageCantonese      BrandGetByEmailParamsForceLanguage = "cantonese"
	BrandGetByEmailParamsForceLanguageCatalan        BrandGetByEmailParamsForceLanguage = "catalan"
	BrandGetByEmailParamsForceLanguageCebuano        BrandGetByEmailParamsForceLanguage = "cebuano"
	BrandGetByEmailParamsForceLanguageChinese        BrandGetByEmailParamsForceLanguage = "chinese"
	BrandGetByEmailParamsForceLanguageCorsican       BrandGetByEmailParamsForceLanguage = "corsican"
	BrandGetByEmailParamsForceLanguageCroatian       BrandGetByEmailParamsForceLanguage = "croatian"
	BrandGetByEmailParamsForceLanguageCzech          BrandGetByEmailParamsForceLanguage = "czech"
	BrandGetByEmailParamsForceLanguageDanish         BrandGetByEmailParamsForceLanguage = "danish"
	BrandGetByEmailParamsForceLanguageDutch          BrandGetByEmailParamsForceLanguage = "dutch"
	BrandGetByEmailParamsForceLanguageEnglish        BrandGetByEmailParamsForceLanguage = "english"
	BrandGetByEmailParamsForceLanguageEsperanto      BrandGetByEmailParamsForceLanguage = "esperanto"
	BrandGetByEmailParamsForceLanguageEstonian       BrandGetByEmailParamsForceLanguage = "estonian"
	BrandGetByEmailParamsForceLanguageFarsi          BrandGetByEmailParamsForceLanguage = "farsi"
	BrandGetByEmailParamsForceLanguageFijian         BrandGetByEmailParamsForceLanguage = "fijian"
	BrandGetByEmailParamsForceLanguageFinnish        BrandGetByEmailParamsForceLanguage = "finnish"
	BrandGetByEmailParamsForceLanguageFrench         BrandGetByEmailParamsForceLanguage = "french"
	BrandGetByEmailParamsForceLanguageGalician       BrandGetByEmailParamsForceLanguage = "galician"
	BrandGetByEmailParamsForceLanguageGeorgian       BrandGetByEmailParamsForceLanguage = "georgian"
	BrandGetByEmailParamsForceLanguageGerman         BrandGetByEmailParamsForceLanguage = "german"
	BrandGetByEmailParamsForceLanguageGreek          BrandGetByEmailParamsForceLanguage = "greek"
	BrandGetByEmailParamsForceLanguageGuarani        BrandGetByEmailParamsForceLanguage = "guarani"
	BrandGetByEmailParamsForceLanguageGujarati       BrandGetByEmailParamsForceLanguage = "gujarati"
	BrandGetByEmailParamsForceLanguageHaitianCreole  BrandGetByEmailParamsForceLanguage = "haitian-creole"
	BrandGetByEmailParamsForceLanguageHausa          BrandGetByEmailParamsForceLanguage = "hausa"
	BrandGetByEmailParamsForceLanguageHawaiian       BrandGetByEmailParamsForceLanguage = "hawaiian"
	BrandGetByEmailParamsForceLanguageHebrew         BrandGetByEmailParamsForceLanguage = "hebrew"
	BrandGetByEmailParamsForceLanguageHindi          BrandGetByEmailParamsForceLanguage = "hindi"
	BrandGetByEmailParamsForceLanguageHmong          BrandGetByEmailParamsForceLanguage = "hmong"
	BrandGetByEmailParamsForceLanguageHungarian      BrandGetByEmailParamsForceLanguage = "hungarian"
	BrandGetByEmailParamsForceLanguageIcelandic      BrandGetByEmailParamsForceLanguage = "icelandic"
	BrandGetByEmailParamsForceLanguageIgbo           BrandGetByEmailParamsForceLanguage = "igbo"
	BrandGetByEmailParamsForceLanguageIndonesian     BrandGetByEmailParamsForceLanguage = "indonesian"
	BrandGetByEmailParamsForceLanguageIrish          BrandGetByEmailParamsForceLanguage = "irish"
	BrandGetByEmailParamsForceLanguageItalian        BrandGetByEmailParamsForceLanguage = "italian"
	BrandGetByEmailParamsForceLanguageJapanese       BrandGetByEmailParamsForceLanguage = "japanese"
	BrandGetByEmailParamsForceLanguageJavanese       BrandGetByEmailParamsForceLanguage = "javanese"
	BrandGetByEmailParamsForceLanguageKannada        BrandGetByEmailParamsForceLanguage = "kannada"
	BrandGetByEmailParamsForceLanguageKazakh         BrandGetByEmailParamsForceLanguage = "kazakh"
	BrandGetByEmailParamsForceLanguageKhmer          BrandGetByEmailParamsForceLanguage = "khmer"
	BrandGetByEmailParamsForceLanguageKinyarwanda    BrandGetByEmailParamsForceLanguage = "kinyarwanda"
	BrandGetByEmailParamsForceLanguageKorean         BrandGetByEmailParamsForceLanguage = "korean"
	BrandGetByEmailParamsForceLanguageKurdish        BrandGetByEmailParamsForceLanguage = "kurdish"
	BrandGetByEmailParamsForceLanguageKyrgyz         BrandGetByEmailParamsForceLanguage = "kyrgyz"
	BrandGetByEmailParamsForceLanguageLao            BrandGetByEmailParamsForceLanguage = "lao"
	BrandGetByEmailParamsForceLanguageLatin          BrandGetByEmailParamsForceLanguage = "latin"
	BrandGetByEmailParamsForceLanguageLatvian        BrandGetByEmailParamsForceLanguage = "latvian"
	BrandGetByEmailParamsForceLanguageLingala        BrandGetByEmailParamsForceLanguage = "lingala"
	BrandGetByEmailParamsForceLanguageLithuanian     BrandGetByEmailParamsForceLanguage = "lithuanian"
	BrandGetByEmailParamsForceLanguageLuxembourgish  BrandGetByEmailParamsForceLanguage = "luxembourgish"
	BrandGetByEmailParamsForceLanguageMacedonian     BrandGetByEmailParamsForceLanguage = "macedonian"
	BrandGetByEmailParamsForceLanguageMalagasy       BrandGetByEmailParamsForceLanguage = "malagasy"
	BrandGetByEmailParamsForceLanguageMalay          BrandGetByEmailParamsForceLanguage = "malay"
	BrandGetByEmailParamsForceLanguageMalayalam      BrandGetByEmailParamsForceLanguage = "malayalam"
	BrandGetByEmailParamsForceLanguageMaltese        BrandGetByEmailParamsForceLanguage = "maltese"
	BrandGetByEmailParamsForceLanguageMaori          BrandGetByEmailParamsForceLanguage = "maori"
	BrandGetByEmailParamsForceLanguageMarathi        BrandGetByEmailParamsForceLanguage = "marathi"
	BrandGetByEmailParamsForceLanguageMongolian      BrandGetByEmailParamsForceLanguage = "mongolian"
	BrandGetByEmailParamsForceLanguageNepali         BrandGetByEmailParamsForceLanguage = "nepali"
	BrandGetByEmailParamsForceLanguageNorwegian      BrandGetByEmailParamsForceLanguage = "norwegian"
	BrandGetByEmailParamsForceLanguageOdia           BrandGetByEmailParamsForceLanguage = "odia"
	BrandGetByEmailParamsForceLanguageOromo          BrandGetByEmailParamsForceLanguage = "oromo"
	BrandGetByEmailParamsForceLanguagePashto         BrandGetByEmailParamsForceLanguage = "pashto"
	BrandGetByEmailParamsForceLanguagePidgin         BrandGetByEmailParamsForceLanguage = "pidgin"
	BrandGetByEmailParamsForceLanguagePolish         BrandGetByEmailParamsForceLanguage = "polish"
	BrandGetByEmailParamsForceLanguagePortuguese     BrandGetByEmailParamsForceLanguage = "portuguese"
	BrandGetByEmailParamsForceLanguagePunjabi        BrandGetByEmailParamsForceLanguage = "punjabi"
	BrandGetByEmailParamsForceLanguageQuechua        BrandGetByEmailParamsForceLanguage = "quechua"
	BrandGetByEmailParamsForceLanguageRomanian       BrandGetByEmailParamsForceLanguage = "romanian"
	BrandGetByEmailParamsForceLanguageRussian        BrandGetByEmailParamsForceLanguage = "russian"
	BrandGetByEmailParamsForceLanguageSamoan         BrandGetByEmailParamsForceLanguage = "samoan"
	BrandGetByEmailParamsForceLanguageScottishGaelic BrandGetByEmailParamsForceLanguage = "scottish-gaelic"
	BrandGetByEmailParamsForceLanguageSerbian        BrandGetByEmailParamsForceLanguage = "serbian"
	BrandGetByEmailParamsForceLanguageSesotho        BrandGetByEmailParamsForceLanguage = "sesotho"
	BrandGetByEmailParamsForceLanguageShona          BrandGetByEmailParamsForceLanguage = "shona"
	BrandGetByEmailParamsForceLanguageSindhi         BrandGetByEmailParamsForceLanguage = "sindhi"
	BrandGetByEmailParamsForceLanguageSinhala        BrandGetByEmailParamsForceLanguage = "sinhala"
	BrandGetByEmailParamsForceLanguageSlovak         BrandGetByEmailParamsForceLanguage = "slovak"
	BrandGetByEmailParamsForceLanguageSlovene        BrandGetByEmailParamsForceLanguage = "slovene"
	BrandGetByEmailParamsForceLanguageSomali         BrandGetByEmailParamsForceLanguage = "somali"
	BrandGetByEmailParamsForceLanguageSpanish        BrandGetByEmailParamsForceLanguage = "spanish"
	BrandGetByEmailParamsForceLanguageSundanese      BrandGetByEmailParamsForceLanguage = "sundanese"
	BrandGetByEmailParamsForceLanguageSwahili        BrandGetByEmailParamsForceLanguage = "swahili"
	BrandGetByEmailParamsForceLanguageSwedish        BrandGetByEmailParamsForceLanguage = "swedish"
	BrandGetByEmailParamsForceLanguageTagalog        BrandGetByEmailParamsForceLanguage = "tagalog"
	BrandGetByEmailParamsForceLanguageTajik          BrandGetByEmailParamsForceLanguage = "tajik"
	BrandGetByEmailParamsForceLanguageTamil          BrandGetByEmailParamsForceLanguage = "tamil"
	BrandGetByEmailParamsForceLanguageTatar          BrandGetByEmailParamsForceLanguage = "tatar"
	BrandGetByEmailParamsForceLanguageTelugu         BrandGetByEmailParamsForceLanguage = "telugu"
	BrandGetByEmailParamsForceLanguageThai           BrandGetByEmailParamsForceLanguage = "thai"
	BrandGetByEmailParamsForceLanguageTibetan        BrandGetByEmailParamsForceLanguage = "tibetan"
	BrandGetByEmailParamsForceLanguageTigrinya       BrandGetByEmailParamsForceLanguage = "tigrinya"
	BrandGetByEmailParamsForceLanguageTongan         BrandGetByEmailParamsForceLanguage = "tongan"
	BrandGetByEmailParamsForceLanguageTswana         BrandGetByEmailParamsForceLanguage = "tswana"
	BrandGetByEmailParamsForceLanguageTurkish        BrandGetByEmailParamsForceLanguage = "turkish"
	BrandGetByEmailParamsForceLanguageTurkmen        BrandGetByEmailParamsForceLanguage = "turkmen"
	BrandGetByEmailParamsForceLanguageUkrainian      BrandGetByEmailParamsForceLanguage = "ukrainian"
	BrandGetByEmailParamsForceLanguageUrdu           BrandGetByEmailParamsForceLanguage = "urdu"
	BrandGetByEmailParamsForceLanguageUyghur         BrandGetByEmailParamsForceLanguage = "uyghur"
	BrandGetByEmailParamsForceLanguageUzbek          BrandGetByEmailParamsForceLanguage = "uzbek"
	BrandGetByEmailParamsForceLanguageVietnamese     BrandGetByEmailParamsForceLanguage = "vietnamese"
	BrandGetByEmailParamsForceLanguageWelsh          BrandGetByEmailParamsForceLanguage = "welsh"
	BrandGetByEmailParamsForceLanguageWolof          BrandGetByEmailParamsForceLanguage = "wolof"
	BrandGetByEmailParamsForceLanguageXhosa          BrandGetByEmailParamsForceLanguage = "xhosa"
	BrandGetByEmailParamsForceLanguageYiddish        BrandGetByEmailParamsForceLanguage = "yiddish"
	BrandGetByEmailParamsForceLanguageYoruba         BrandGetByEmailParamsForceLanguage = "yoruba"
	BrandGetByEmailParamsForceLanguageZulu           BrandGetByEmailParamsForceLanguage = "zulu"
)

type BrandGetByEmailResponse 

type BrandGetByEmailResponse struct {
	// Detailed brand information
	Brand BrandGetByEmailResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponse) RawJSON 

func (r BrandGetByEmailResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponse) UnmarshalJSON 

func (r *BrandGetByEmailResponse) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrand 

type BrandGetByEmailResponseBrand struct {
	// Physical address of the brand
	Address BrandGetByEmailResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandGetByEmailResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetByEmailResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandGetByEmailResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandGetByEmailResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandGetByEmailResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandGetByEmailResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandGetByEmailResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandGetByEmailResponseBrand) RawJSON 

func (r BrandGetByEmailResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrand) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandAddress 

type BrandGetByEmailResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandGetByEmailResponseBrandAddress) RawJSON 

func (r BrandGetByEmailResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandAddress) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandBackdrop 

type BrandGetByEmailResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetByEmailResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetByEmailResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandBackdrop) RawJSON 

func (r BrandGetByEmailResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandBackdropColor 

type BrandGetByEmailResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandBackdropColor) RawJSON 

func (r BrandGetByEmailResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandBackdropResolution 

type BrandGetByEmailResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetByEmailResponseBrandBackdropResolution) RawJSON 

func (r BrandGetByEmailResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandColor 

type BrandGetByEmailResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandColor) RawJSON 

func (r BrandGetByEmailResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandColor) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandIndustries 

type BrandGetByEmailResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandGetByEmailResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandGetByEmailResponseBrandIndustries) RawJSON 

func (r BrandGetByEmailResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandIndustries) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandIndustriesEic 

type BrandGetByEmailResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandIndustriesEic) RawJSON 

func (r BrandGetByEmailResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandGetByEmailResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandGetByEmailResponseBrandLinks) RawJSON 

func (r BrandGetByEmailResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandLinks) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandGetByEmailResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetByEmailResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetByEmailResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandLogo) RawJSON 

func (r BrandGetByEmailResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandLogoColor 

type BrandGetByEmailResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandLogoColor) RawJSON 

func (r BrandGetByEmailResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandLogoResolution 

type BrandGetByEmailResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetByEmailResponseBrandLogoResolution) RawJSON 

func (r BrandGetByEmailResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandSocial 

type BrandGetByEmailResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByEmailResponseBrandSocial) RawJSON 

func (r BrandGetByEmailResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandSocial) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandGetByEmailResponseBrandStock 

type BrandGetByEmailResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandGetByEmailResponseBrandStock) RawJSON 

func (r BrandGetByEmailResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByEmailResponseBrandStock) UnmarshalJSON 

func (r *BrandGetByEmailResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandGetByIsinParams 

type BrandGetByIsinParams struct {
	// ISIN (International Securities Identification Number) to retrieve brand data for
	// (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
	// followed by 9 alphanumeric characters and ending with a digit.
	Isin string `query:"isin" api:"required" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandGetByIsinParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetByIsinParams) URLQuery 

func (r BrandGetByIsinParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetByIsinParams's query parameters as `url.Values`.

type BrandGetByIsinParamsForceLanguage 

type BrandGetByIsinParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandGetByIsinParamsForceLanguageAfrikaans      BrandGetByIsinParamsForceLanguage = "afrikaans"
	BrandGetByIsinParamsForceLanguageAlbanian       BrandGetByIsinParamsForceLanguage = "albanian"
	BrandGetByIsinParamsForceLanguageAmharic        BrandGetByIsinParamsForceLanguage = "amharic"
	BrandGetByIsinParamsForceLanguageArabic         BrandGetByIsinParamsForceLanguage = "arabic"
	BrandGetByIsinParamsForceLanguageArmenian       BrandGetByIsinParamsForceLanguage = "armenian"
	BrandGetByIsinParamsForceLanguageAssamese       BrandGetByIsinParamsForceLanguage = "assamese"
	BrandGetByIsinParamsForceLanguageAymara         BrandGetByIsinParamsForceLanguage = "aymara"
	BrandGetByIsinParamsForceLanguageAzeri          BrandGetByIsinParamsForceLanguage = "azeri"
	BrandGetByIsinParamsForceLanguageBasque         BrandGetByIsinParamsForceLanguage = "basque"
	BrandGetByIsinParamsForceLanguageBelarusian     BrandGetByIsinParamsForceLanguage = "belarusian"
	BrandGetByIsinParamsForceLanguageBengali        BrandGetByIsinParamsForceLanguage = "bengali"
	BrandGetByIsinParamsForceLanguageBosnian        BrandGetByIsinParamsForceLanguage = "bosnian"
	BrandGetByIsinParamsForceLanguageBulgarian      BrandGetByIsinParamsForceLanguage = "bulgarian"
	BrandGetByIsinParamsForceLanguageBurmese        BrandGetByIsinParamsForceLanguage = "burmese"
	BrandGetByIsinParamsForceLanguageCantonese      BrandGetByIsinParamsForceLanguage = "cantonese"
	BrandGetByIsinParamsForceLanguageCatalan        BrandGetByIsinParamsForceLanguage = "catalan"
	BrandGetByIsinParamsForceLanguageCebuano        BrandGetByIsinParamsForceLanguage = "cebuano"
	BrandGetByIsinParamsForceLanguageChinese        BrandGetByIsinParamsForceLanguage = "chinese"
	BrandGetByIsinParamsForceLanguageCorsican       BrandGetByIsinParamsForceLanguage = "corsican"
	BrandGetByIsinParamsForceLanguageCroatian       BrandGetByIsinParamsForceLanguage = "croatian"
	BrandGetByIsinParamsForceLanguageCzech          BrandGetByIsinParamsForceLanguage = "czech"
	BrandGetByIsinParamsForceLanguageDanish         BrandGetByIsinParamsForceLanguage = "danish"
	BrandGetByIsinParamsForceLanguageDutch          BrandGetByIsinParamsForceLanguage = "dutch"
	BrandGetByIsinParamsForceLanguageEnglish        BrandGetByIsinParamsForceLanguage = "english"
	BrandGetByIsinParamsForceLanguageEsperanto      BrandGetByIsinParamsForceLanguage = "esperanto"
	BrandGetByIsinParamsForceLanguageEstonian       BrandGetByIsinParamsForceLanguage = "estonian"
	BrandGetByIsinParamsForceLanguageFarsi          BrandGetByIsinParamsForceLanguage = "farsi"
	BrandGetByIsinParamsForceLanguageFijian         BrandGetByIsinParamsForceLanguage = "fijian"
	BrandGetByIsinParamsForceLanguageFinnish        BrandGetByIsinParamsForceLanguage = "finnish"
	BrandGetByIsinParamsForceLanguageFrench         BrandGetByIsinParamsForceLanguage = "french"
	BrandGetByIsinParamsForceLanguageGalician       BrandGetByIsinParamsForceLanguage = "galician"
	BrandGetByIsinParamsForceLanguageGeorgian       BrandGetByIsinParamsForceLanguage = "georgian"
	BrandGetByIsinParamsForceLanguageGerman         BrandGetByIsinParamsForceLanguage = "german"
	BrandGetByIsinParamsForceLanguageGreek          BrandGetByIsinParamsForceLanguage = "greek"
	BrandGetByIsinParamsForceLanguageGuarani        BrandGetByIsinParamsForceLanguage = "guarani"
	BrandGetByIsinParamsForceLanguageGujarati       BrandGetByIsinParamsForceLanguage = "gujarati"
	BrandGetByIsinParamsForceLanguageHaitianCreole  BrandGetByIsinParamsForceLanguage = "haitian-creole"
	BrandGetByIsinParamsForceLanguageHausa          BrandGetByIsinParamsForceLanguage = "hausa"
	BrandGetByIsinParamsForceLanguageHawaiian       BrandGetByIsinParamsForceLanguage = "hawaiian"
	BrandGetByIsinParamsForceLanguageHebrew         BrandGetByIsinParamsForceLanguage = "hebrew"
	BrandGetByIsinParamsForceLanguageHindi          BrandGetByIsinParamsForceLanguage = "hindi"
	BrandGetByIsinParamsForceLanguageHmong          BrandGetByIsinParamsForceLanguage = "hmong"
	BrandGetByIsinParamsForceLanguageHungarian      BrandGetByIsinParamsForceLanguage = "hungarian"
	BrandGetByIsinParamsForceLanguageIcelandic      BrandGetByIsinParamsForceLanguage = "icelandic"
	BrandGetByIsinParamsForceLanguageIgbo           BrandGetByIsinParamsForceLanguage = "igbo"
	BrandGetByIsinParamsForceLanguageIndonesian     BrandGetByIsinParamsForceLanguage = "indonesian"
	BrandGetByIsinParamsForceLanguageIrish          BrandGetByIsinParamsForceLanguage = "irish"
	BrandGetByIsinParamsForceLanguageItalian        BrandGetByIsinParamsForceLanguage = "italian"
	BrandGetByIsinParamsForceLanguageJapanese       BrandGetByIsinParamsForceLanguage = "japanese"
	BrandGetByIsinParamsForceLanguageJavanese       BrandGetByIsinParamsForceLanguage = "javanese"
	BrandGetByIsinParamsForceLanguageKannada        BrandGetByIsinParamsForceLanguage = "kannada"
	BrandGetByIsinParamsForceLanguageKazakh         BrandGetByIsinParamsForceLanguage = "kazakh"
	BrandGetByIsinParamsForceLanguageKhmer          BrandGetByIsinParamsForceLanguage = "khmer"
	BrandGetByIsinParamsForceLanguageKinyarwanda    BrandGetByIsinParamsForceLanguage = "kinyarwanda"
	BrandGetByIsinParamsForceLanguageKorean         BrandGetByIsinParamsForceLanguage = "korean"
	BrandGetByIsinParamsForceLanguageKurdish        BrandGetByIsinParamsForceLanguage = "kurdish"
	BrandGetByIsinParamsForceLanguageKyrgyz         BrandGetByIsinParamsForceLanguage = "kyrgyz"
	BrandGetByIsinParamsForceLanguageLao            BrandGetByIsinParamsForceLanguage = "lao"
	BrandGetByIsinParamsForceLanguageLatin          BrandGetByIsinParamsForceLanguage = "latin"
	BrandGetByIsinParamsForceLanguageLatvian        BrandGetByIsinParamsForceLanguage = "latvian"
	BrandGetByIsinParamsForceLanguageLingala        BrandGetByIsinParamsForceLanguage = "lingala"
	BrandGetByIsinParamsForceLanguageLithuanian     BrandGetByIsinParamsForceLanguage = "lithuanian"
	BrandGetByIsinParamsForceLanguageLuxembourgish  BrandGetByIsinParamsForceLanguage = "luxembourgish"
	BrandGetByIsinParamsForceLanguageMacedonian     BrandGetByIsinParamsForceLanguage = "macedonian"
	BrandGetByIsinParamsForceLanguageMalagasy       BrandGetByIsinParamsForceLanguage = "malagasy"
	BrandGetByIsinParamsForceLanguageMalay          BrandGetByIsinParamsForceLanguage = "malay"
	BrandGetByIsinParamsForceLanguageMalayalam      BrandGetByIsinParamsForceLanguage = "malayalam"
	BrandGetByIsinParamsForceLanguageMaltese        BrandGetByIsinParamsForceLanguage = "maltese"
	BrandGetByIsinParamsForceLanguageMaori          BrandGetByIsinParamsForceLanguage = "maori"
	BrandGetByIsinParamsForceLanguageMarathi        BrandGetByIsinParamsForceLanguage = "marathi"
	BrandGetByIsinParamsForceLanguageMongolian      BrandGetByIsinParamsForceLanguage = "mongolian"
	BrandGetByIsinParamsForceLanguageNepali         BrandGetByIsinParamsForceLanguage = "nepali"
	BrandGetByIsinParamsForceLanguageNorwegian      BrandGetByIsinParamsForceLanguage = "norwegian"
	BrandGetByIsinParamsForceLanguageOdia           BrandGetByIsinParamsForceLanguage = "odia"
	BrandGetByIsinParamsForceLanguageOromo          BrandGetByIsinParamsForceLanguage = "oromo"
	BrandGetByIsinParamsForceLanguagePashto         BrandGetByIsinParamsForceLanguage = "pashto"
	BrandGetByIsinParamsForceLanguagePidgin         BrandGetByIsinParamsForceLanguage = "pidgin"
	BrandGetByIsinParamsForceLanguagePolish         BrandGetByIsinParamsForceLanguage = "polish"
	BrandGetByIsinParamsForceLanguagePortuguese     BrandGetByIsinParamsForceLanguage = "portuguese"
	BrandGetByIsinParamsForceLanguagePunjabi        BrandGetByIsinParamsForceLanguage = "punjabi"
	BrandGetByIsinParamsForceLanguageQuechua        BrandGetByIsinParamsForceLanguage = "quechua"
	BrandGetByIsinParamsForceLanguageRomanian       BrandGetByIsinParamsForceLanguage = "romanian"
	BrandGetByIsinParamsForceLanguageRussian        BrandGetByIsinParamsForceLanguage = "russian"
	BrandGetByIsinParamsForceLanguageSamoan         BrandGetByIsinParamsForceLanguage = "samoan"
	BrandGetByIsinParamsForceLanguageScottishGaelic BrandGetByIsinParamsForceLanguage = "scottish-gaelic"
	BrandGetByIsinParamsForceLanguageSerbian        BrandGetByIsinParamsForceLanguage = "serbian"
	BrandGetByIsinParamsForceLanguageSesotho        BrandGetByIsinParamsForceLanguage = "sesotho"
	BrandGetByIsinParamsForceLanguageShona          BrandGetByIsinParamsForceLanguage = "shona"
	BrandGetByIsinParamsForceLanguageSindhi         BrandGetByIsinParamsForceLanguage = "sindhi"
	BrandGetByIsinParamsForceLanguageSinhala        BrandGetByIsinParamsForceLanguage = "sinhala"
	BrandGetByIsinParamsForceLanguageSlovak         BrandGetByIsinParamsForceLanguage = "slovak"
	BrandGetByIsinParamsForceLanguageSlovene        BrandGetByIsinParamsForceLanguage = "slovene"
	BrandGetByIsinParamsForceLanguageSomali         BrandGetByIsinParamsForceLanguage = "somali"
	BrandGetByIsinParamsForceLanguageSpanish        BrandGetByIsinParamsForceLanguage = "spanish"
	BrandGetByIsinParamsForceLanguageSundanese      BrandGetByIsinParamsForceLanguage = "sundanese"
	BrandGetByIsinParamsForceLanguageSwahili        BrandGetByIsinParamsForceLanguage = "swahili"
	BrandGetByIsinParamsForceLanguageSwedish        BrandGetByIsinParamsForceLanguage = "swedish"
	BrandGetByIsinParamsForceLanguageTagalog        BrandGetByIsinParamsForceLanguage = "tagalog"
	BrandGetByIsinParamsForceLanguageTajik          BrandGetByIsinParamsForceLanguage = "tajik"
	BrandGetByIsinParamsForceLanguageTamil          BrandGetByIsinParamsForceLanguage = "tamil"
	BrandGetByIsinParamsForceLanguageTatar          BrandGetByIsinParamsForceLanguage = "tatar"
	BrandGetByIsinParamsForceLanguageTelugu         BrandGetByIsinParamsForceLanguage = "telugu"
	BrandGetByIsinParamsForceLanguageThai           BrandGetByIsinParamsForceLanguage = "thai"
	BrandGetByIsinParamsForceLanguageTibetan        BrandGetByIsinParamsForceLanguage = "tibetan"
	BrandGetByIsinParamsForceLanguageTigrinya       BrandGetByIsinParamsForceLanguage = "tigrinya"
	BrandGetByIsinParamsForceLanguageTongan         BrandGetByIsinParamsForceLanguage = "tongan"
	BrandGetByIsinParamsForceLanguageTswana         BrandGetByIsinParamsForceLanguage = "tswana"
	BrandGetByIsinParamsForceLanguageTurkish        BrandGetByIsinParamsForceLanguage = "turkish"
	BrandGetByIsinParamsForceLanguageTurkmen        BrandGetByIsinParamsForceLanguage = "turkmen"
	BrandGetByIsinParamsForceLanguageUkrainian      BrandGetByIsinParamsForceLanguage = "ukrainian"
	BrandGetByIsinParamsForceLanguageUrdu           BrandGetByIsinParamsForceLanguage = "urdu"
	BrandGetByIsinParamsForceLanguageUyghur         BrandGetByIsinParamsForceLanguage = "uyghur"
	BrandGetByIsinParamsForceLanguageUzbek          BrandGetByIsinParamsForceLanguage = "uzbek"
	BrandGetByIsinParamsForceLanguageVietnamese     BrandGetByIsinParamsForceLanguage = "vietnamese"
	BrandGetByIsinParamsForceLanguageWelsh          BrandGetByIsinParamsForceLanguage = "welsh"
	BrandGetByIsinParamsForceLanguageWolof          BrandGetByIsinParamsForceLanguage = "wolof"
	BrandGetByIsinParamsForceLanguageXhosa          BrandGetByIsinParamsForceLanguage = "xhosa"
	BrandGetByIsinParamsForceLanguageYiddish        BrandGetByIsinParamsForceLanguage = "yiddish"
	BrandGetByIsinParamsForceLanguageYoruba         BrandGetByIsinParamsForceLanguage = "yoruba"
	BrandGetByIsinParamsForceLanguageZulu           BrandGetByIsinParamsForceLanguage = "zulu"
)

type BrandGetByIsinResponse 

type BrandGetByIsinResponse struct {
	// Detailed brand information
	Brand BrandGetByIsinResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponse) RawJSON 

func (r BrandGetByIsinResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponse) UnmarshalJSON 

func (r *BrandGetByIsinResponse) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrand 

type BrandGetByIsinResponseBrand struct {
	// Physical address of the brand
	Address BrandGetByIsinResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandGetByIsinResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetByIsinResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandGetByIsinResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandGetByIsinResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandGetByIsinResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandGetByIsinResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandGetByIsinResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandGetByIsinResponseBrand) RawJSON 

func (r BrandGetByIsinResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrand) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandAddress 

type BrandGetByIsinResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandGetByIsinResponseBrandAddress) RawJSON 

func (r BrandGetByIsinResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandAddress) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandBackdrop 

type BrandGetByIsinResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetByIsinResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetByIsinResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandBackdrop) RawJSON 

func (r BrandGetByIsinResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandBackdropColor 

type BrandGetByIsinResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandBackdropColor) RawJSON 

func (r BrandGetByIsinResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandBackdropResolution 

type BrandGetByIsinResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetByIsinResponseBrandBackdropResolution) RawJSON 

func (r BrandGetByIsinResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandColor 

type BrandGetByIsinResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandColor) RawJSON 

func (r BrandGetByIsinResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandColor) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandIndustries 

type BrandGetByIsinResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandGetByIsinResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandGetByIsinResponseBrandIndustries) RawJSON 

func (r BrandGetByIsinResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandIndustries) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandIndustriesEic 

type BrandGetByIsinResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandIndustriesEic) RawJSON 

func (r BrandGetByIsinResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandGetByIsinResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandGetByIsinResponseBrandLinks) RawJSON 

func (r BrandGetByIsinResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandLinks) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandGetByIsinResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetByIsinResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetByIsinResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandLogo) RawJSON 

func (r BrandGetByIsinResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandLogoColor 

type BrandGetByIsinResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandLogoColor) RawJSON 

func (r BrandGetByIsinResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandLogoResolution 

type BrandGetByIsinResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetByIsinResponseBrandLogoResolution) RawJSON 

func (r BrandGetByIsinResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandSocial 

type BrandGetByIsinResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByIsinResponseBrandSocial) RawJSON 

func (r BrandGetByIsinResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandSocial) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandGetByIsinResponseBrandStock 

type BrandGetByIsinResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandGetByIsinResponseBrandStock) RawJSON 

func (r BrandGetByIsinResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByIsinResponseBrandStock) UnmarshalJSON 

func (r *BrandGetByIsinResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandGetByNameParams 

type BrandGetByNameParams struct {
	// Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
	// Corporation'). Must be 3-30 characters.
	Name string `query:"name" api:"required" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional country code hint (GL parameter) to specify the country for the company
	// name.
	//
	// Any of "ad", "ae", "af", "ag", "ai", "al", "am", "an", "ao", "aq", "ar", "as",
	// "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj",
	// "bm", "bn", "bo", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "cc", "cd",
	// "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cu", "cv", "cx",
	// "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "er",
	// "es", "et", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf",
	// "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy",
	// "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "in", "io", "iq", "ir",
	// "is", "it", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "km", "kn", "kp", "kr",
	// "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv",
	// "ly", "ma", "mc", "md", "mg", "mh", "mk", "ml", "mm", "mn", "mo", "mp", "mq",
	// "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf",
	// "ng", "ni", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg",
	// "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "re", "ro",
	// "rs", "ru", "rw", "sa", "sb", "sc", "sd", "se", "sg", "sh", "si", "sj", "sk",
	// "sl", "sm", "sn", "so", "sr", "st", "sv", "sy", "sz", "tc", "td", "tf", "tg",
	// "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua",
	// "ug", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "wf",
	// "ws", "ye", "yt", "za", "zm", "zw".
	CountryGl BrandGetByNameParamsCountryGl `query:"country_gl,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandGetByNameParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetByNameParams) URLQuery 

func (r BrandGetByNameParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetByNameParams's query parameters as `url.Values`.

type BrandGetByNameParamsCountryGl 

type BrandGetByNameParamsCountryGl string

Optional country code hint (GL parameter) to specify the country for the company name. 

const (
	BrandGetByNameParamsCountryGlAd BrandGetByNameParamsCountryGl = "ad"
	BrandGetByNameParamsCountryGlAe BrandGetByNameParamsCountryGl = "ae"
	BrandGetByNameParamsCountryGlAf BrandGetByNameParamsCountryGl = "af"
	BrandGetByNameParamsCountryGlAg BrandGetByNameParamsCountryGl = "ag"
	BrandGetByNameParamsCountryGlAI BrandGetByNameParamsCountryGl = "ai"
	BrandGetByNameParamsCountryGlAl BrandGetByNameParamsCountryGl = "al"
	BrandGetByNameParamsCountryGlAm BrandGetByNameParamsCountryGl = "am"
	BrandGetByNameParamsCountryGlAn BrandGetByNameParamsCountryGl = "an"
	BrandGetByNameParamsCountryGlAo BrandGetByNameParamsCountryGl = "ao"
	BrandGetByNameParamsCountryGlAq BrandGetByNameParamsCountryGl = "aq"
	BrandGetByNameParamsCountryGlAr BrandGetByNameParamsCountryGl = "ar"
	BrandGetByNameParamsCountryGlAs BrandGetByNameParamsCountryGl = "as"
	BrandGetByNameParamsCountryGlAt BrandGetByNameParamsCountryGl = "at"
	BrandGetByNameParamsCountryGlAu BrandGetByNameParamsCountryGl = "au"
	BrandGetByNameParamsCountryGlAw BrandGetByNameParamsCountryGl = "aw"
	BrandGetByNameParamsCountryGlAz BrandGetByNameParamsCountryGl = "az"
	BrandGetByNameParamsCountryGlBa BrandGetByNameParamsCountryGl = "ba"
	BrandGetByNameParamsCountryGlBb BrandGetByNameParamsCountryGl = "bb"
	BrandGetByNameParamsCountryGlBd BrandGetByNameParamsCountryGl = "bd"
	BrandGetByNameParamsCountryGlBe BrandGetByNameParamsCountryGl = "be"
	BrandGetByNameParamsCountryGlBf BrandGetByNameParamsCountryGl = "bf"
	BrandGetByNameParamsCountryGlBg BrandGetByNameParamsCountryGl = "bg"
	BrandGetByNameParamsCountryGlBh BrandGetByNameParamsCountryGl = "bh"
	BrandGetByNameParamsCountryGlBi BrandGetByNameParamsCountryGl = "bi"
	BrandGetByNameParamsCountryGlBj BrandGetByNameParamsCountryGl = "bj"
	BrandGetByNameParamsCountryGlBm BrandGetByNameParamsCountryGl = "bm"
	BrandGetByNameParamsCountryGlBn BrandGetByNameParamsCountryGl = "bn"
	BrandGetByNameParamsCountryGlBo BrandGetByNameParamsCountryGl = "bo"
	BrandGetByNameParamsCountryGlBr BrandGetByNameParamsCountryGl = "br"
	BrandGetByNameParamsCountryGlBs BrandGetByNameParamsCountryGl = "bs"
	BrandGetByNameParamsCountryGlBt BrandGetByNameParamsCountryGl = "bt"
	BrandGetByNameParamsCountryGlBv BrandGetByNameParamsCountryGl = "bv"
	BrandGetByNameParamsCountryGlBw BrandGetByNameParamsCountryGl = "bw"
	BrandGetByNameParamsCountryGlBy BrandGetByNameParamsCountryGl = "by"
	BrandGetByNameParamsCountryGlBz BrandGetByNameParamsCountryGl = "bz"
	BrandGetByNameParamsCountryGlCa BrandGetByNameParamsCountryGl = "ca"
	BrandGetByNameParamsCountryGlCc BrandGetByNameParamsCountryGl = "cc"
	BrandGetByNameParamsCountryGlCd BrandGetByNameParamsCountryGl = "cd"
	BrandGetByNameParamsCountryGlCf BrandGetByNameParamsCountryGl = "cf"
	BrandGetByNameParamsCountryGlCg BrandGetByNameParamsCountryGl = "cg"
	BrandGetByNameParamsCountryGlCh BrandGetByNameParamsCountryGl = "ch"
	BrandGetByNameParamsCountryGlCi BrandGetByNameParamsCountryGl = "ci"
	BrandGetByNameParamsCountryGlCk BrandGetByNameParamsCountryGl = "ck"
	BrandGetByNameParamsCountryGlCl BrandGetByNameParamsCountryGl = "cl"
	BrandGetByNameParamsCountryGlCm BrandGetByNameParamsCountryGl = "cm"
	BrandGetByNameParamsCountryGlCn BrandGetByNameParamsCountryGl = "cn"
	BrandGetByNameParamsCountryGlCo BrandGetByNameParamsCountryGl = "co"
	BrandGetByNameParamsCountryGlCr BrandGetByNameParamsCountryGl = "cr"
	BrandGetByNameParamsCountryGlCu BrandGetByNameParamsCountryGl = "cu"
	BrandGetByNameParamsCountryGlCv BrandGetByNameParamsCountryGl = "cv"
	BrandGetByNameParamsCountryGlCx BrandGetByNameParamsCountryGl = "cx"
	BrandGetByNameParamsCountryGlCy BrandGetByNameParamsCountryGl = "cy"
	BrandGetByNameParamsCountryGlCz BrandGetByNameParamsCountryGl = "cz"
	BrandGetByNameParamsCountryGlDe BrandGetByNameParamsCountryGl = "de"
	BrandGetByNameParamsCountryGlDj BrandGetByNameParamsCountryGl = "dj"
	BrandGetByNameParamsCountryGlDk BrandGetByNameParamsCountryGl = "dk"
	BrandGetByNameParamsCountryGlDm BrandGetByNameParamsCountryGl = "dm"
	BrandGetByNameParamsCountryGlDo BrandGetByNameParamsCountryGl = "do"
	BrandGetByNameParamsCountryGlDz BrandGetByNameParamsCountryGl = "dz"
	BrandGetByNameParamsCountryGlEc BrandGetByNameParamsCountryGl = "ec"
	BrandGetByNameParamsCountryGlEe BrandGetByNameParamsCountryGl = "ee"
	BrandGetByNameParamsCountryGlEg BrandGetByNameParamsCountryGl = "eg"
	BrandGetByNameParamsCountryGlEh BrandGetByNameParamsCountryGl = "eh"
	BrandGetByNameParamsCountryGlEr BrandGetByNameParamsCountryGl = "er"
	BrandGetByNameParamsCountryGlEs BrandGetByNameParamsCountryGl = "es"
	BrandGetByNameParamsCountryGlEt BrandGetByNameParamsCountryGl = "et"
	BrandGetByNameParamsCountryGlFi BrandGetByNameParamsCountryGl = "fi"
	BrandGetByNameParamsCountryGlFj BrandGetByNameParamsCountryGl = "fj"
	BrandGetByNameParamsCountryGlFk BrandGetByNameParamsCountryGl = "fk"
	BrandGetByNameParamsCountryGlFm BrandGetByNameParamsCountryGl = "fm"
	BrandGetByNameParamsCountryGlFo BrandGetByNameParamsCountryGl = "fo"
	BrandGetByNameParamsCountryGlFr BrandGetByNameParamsCountryGl = "fr"
	BrandGetByNameParamsCountryGlGa BrandGetByNameParamsCountryGl = "ga"
	BrandGetByNameParamsCountryGlGB BrandGetByNameParamsCountryGl = "gb"
	BrandGetByNameParamsCountryGlGd BrandGetByNameParamsCountryGl = "gd"
	BrandGetByNameParamsCountryGlGe BrandGetByNameParamsCountryGl = "ge"
	BrandGetByNameParamsCountryGlGf BrandGetByNameParamsCountryGl = "gf"
	BrandGetByNameParamsCountryGlGh BrandGetByNameParamsCountryGl = "gh"
	BrandGetByNameParamsCountryGlGi BrandGetByNameParamsCountryGl = "gi"
	BrandGetByNameParamsCountryGlGl BrandGetByNameParamsCountryGl = "gl"
	BrandGetByNameParamsCountryGlGm BrandGetByNameParamsCountryGl = "gm"
	BrandGetByNameParamsCountryGlGn BrandGetByNameParamsCountryGl = "gn"
	BrandGetByNameParamsCountryGlGp BrandGetByNameParamsCountryGl = "gp"
	BrandGetByNameParamsCountryGlGq BrandGetByNameParamsCountryGl = "gq"
	BrandGetByNameParamsCountryGlGr BrandGetByNameParamsCountryGl = "gr"
	BrandGetByNameParamsCountryGlGs BrandGetByNameParamsCountryGl = "gs"
	BrandGetByNameParamsCountryGlGt BrandGetByNameParamsCountryGl = "gt"
	BrandGetByNameParamsCountryGlGu BrandGetByNameParamsCountryGl = "gu"
	BrandGetByNameParamsCountryGlGw BrandGetByNameParamsCountryGl = "gw"
	BrandGetByNameParamsCountryGlGy BrandGetByNameParamsCountryGl = "gy"
	BrandGetByNameParamsCountryGlHk BrandGetByNameParamsCountryGl = "hk"
	BrandGetByNameParamsCountryGlHm BrandGetByNameParamsCountryGl = "hm"
	BrandGetByNameParamsCountryGlHn BrandGetByNameParamsCountryGl = "hn"
	BrandGetByNameParamsCountryGlHr BrandGetByNameParamsCountryGl = "hr"
	BrandGetByNameParamsCountryGlHt BrandGetByNameParamsCountryGl = "ht"
	BrandGetByNameParamsCountryGlHu BrandGetByNameParamsCountryGl = "hu"
	BrandGetByNameParamsCountryGlID BrandGetByNameParamsCountryGl = "id"
	BrandGetByNameParamsCountryGlIe BrandGetByNameParamsCountryGl = "ie"
	BrandGetByNameParamsCountryGlIl BrandGetByNameParamsCountryGl = "il"
	BrandGetByNameParamsCountryGlIn BrandGetByNameParamsCountryGl = "in"
	BrandGetByNameParamsCountryGlIo BrandGetByNameParamsCountryGl = "io"
	BrandGetByNameParamsCountryGlIq BrandGetByNameParamsCountryGl = "iq"
	BrandGetByNameParamsCountryGlIr BrandGetByNameParamsCountryGl = "ir"
	BrandGetByNameParamsCountryGlIs BrandGetByNameParamsCountryGl = "is"
	BrandGetByNameParamsCountryGlIt BrandGetByNameParamsCountryGl = "it"
	BrandGetByNameParamsCountryGlJm BrandGetByNameParamsCountryGl = "jm"
	BrandGetByNameParamsCountryGlJo BrandGetByNameParamsCountryGl = "jo"
	BrandGetByNameParamsCountryGlJp BrandGetByNameParamsCountryGl = "jp"
	BrandGetByNameParamsCountryGlKe BrandGetByNameParamsCountryGl = "ke"
	BrandGetByNameParamsCountryGlKg BrandGetByNameParamsCountryGl = "kg"
	BrandGetByNameParamsCountryGlKh BrandGetByNameParamsCountryGl = "kh"
	BrandGetByNameParamsCountryGlKi BrandGetByNameParamsCountryGl = "ki"
	BrandGetByNameParamsCountryGlKm BrandGetByNameParamsCountryGl = "km"
	BrandGetByNameParamsCountryGlKn BrandGetByNameParamsCountryGl = "kn"
	BrandGetByNameParamsCountryGlKp BrandGetByNameParamsCountryGl = "kp"
	BrandGetByNameParamsCountryGlKr BrandGetByNameParamsCountryGl = "kr"
	BrandGetByNameParamsCountryGlKw BrandGetByNameParamsCountryGl = "kw"
	BrandGetByNameParamsCountryGlKy BrandGetByNameParamsCountryGl = "ky"
	BrandGetByNameParamsCountryGlKz BrandGetByNameParamsCountryGl = "kz"
	BrandGetByNameParamsCountryGlLa BrandGetByNameParamsCountryGl = "la"
	BrandGetByNameParamsCountryGlLb BrandGetByNameParamsCountryGl = "lb"
	BrandGetByNameParamsCountryGlLc BrandGetByNameParamsCountryGl = "lc"
	BrandGetByNameParamsCountryGlLi BrandGetByNameParamsCountryGl = "li"
	BrandGetByNameParamsCountryGlLk BrandGetByNameParamsCountryGl = "lk"
	BrandGetByNameParamsCountryGlLr BrandGetByNameParamsCountryGl = "lr"
	BrandGetByNameParamsCountryGlLs BrandGetByNameParamsCountryGl = "ls"
	BrandGetByNameParamsCountryGlLt BrandGetByNameParamsCountryGl = "lt"
	BrandGetByNameParamsCountryGlLu BrandGetByNameParamsCountryGl = "lu"
	BrandGetByNameParamsCountryGlLv BrandGetByNameParamsCountryGl = "lv"
	BrandGetByNameParamsCountryGlLy BrandGetByNameParamsCountryGl = "ly"
	BrandGetByNameParamsCountryGlMa BrandGetByNameParamsCountryGl = "ma"
	BrandGetByNameParamsCountryGlMc BrandGetByNameParamsCountryGl = "mc"
	BrandGetByNameParamsCountryGlMd BrandGetByNameParamsCountryGl = "md"
	BrandGetByNameParamsCountryGlMg BrandGetByNameParamsCountryGl = "mg"
	BrandGetByNameParamsCountryGlMh BrandGetByNameParamsCountryGl = "mh"
	BrandGetByNameParamsCountryGlMk BrandGetByNameParamsCountryGl = "mk"
	BrandGetByNameParamsCountryGlMl BrandGetByNameParamsCountryGl = "ml"
	BrandGetByNameParamsCountryGlMm BrandGetByNameParamsCountryGl = "mm"
	BrandGetByNameParamsCountryGlMn BrandGetByNameParamsCountryGl = "mn"
	BrandGetByNameParamsCountryGlMo BrandGetByNameParamsCountryGl = "mo"
	BrandGetByNameParamsCountryGlMp BrandGetByNameParamsCountryGl = "mp"
	BrandGetByNameParamsCountryGlMq BrandGetByNameParamsCountryGl = "mq"
	BrandGetByNameParamsCountryGlMr BrandGetByNameParamsCountryGl = "mr"
	BrandGetByNameParamsCountryGlMs BrandGetByNameParamsCountryGl = "ms"
	BrandGetByNameParamsCountryGlMt BrandGetByNameParamsCountryGl = "mt"
	BrandGetByNameParamsCountryGlMu BrandGetByNameParamsCountryGl = "mu"
	BrandGetByNameParamsCountryGlMv BrandGetByNameParamsCountryGl = "mv"
	BrandGetByNameParamsCountryGlMw BrandGetByNameParamsCountryGl = "mw"
	BrandGetByNameParamsCountryGlMx BrandGetByNameParamsCountryGl = "mx"
	BrandGetByNameParamsCountryGlMy BrandGetByNameParamsCountryGl = "my"
	BrandGetByNameParamsCountryGlMz BrandGetByNameParamsCountryGl = "mz"
	BrandGetByNameParamsCountryGlNa BrandGetByNameParamsCountryGl = "na"
	BrandGetByNameParamsCountryGlNc BrandGetByNameParamsCountryGl = "nc"
	BrandGetByNameParamsCountryGlNe BrandGetByNameParamsCountryGl = "ne"
	BrandGetByNameParamsCountryGlNf BrandGetByNameParamsCountryGl = "nf"
	BrandGetByNameParamsCountryGlNg BrandGetByNameParamsCountryGl = "ng"
	BrandGetByNameParamsCountryGlNi BrandGetByNameParamsCountryGl = "ni"
	BrandGetByNameParamsCountryGlNl BrandGetByNameParamsCountryGl = "nl"
	BrandGetByNameParamsCountryGlNo BrandGetByNameParamsCountryGl = "no"
	BrandGetByNameParamsCountryGlNp BrandGetByNameParamsCountryGl = "np"
	BrandGetByNameParamsCountryGlNr BrandGetByNameParamsCountryGl = "nr"
	BrandGetByNameParamsCountryGlNu BrandGetByNameParamsCountryGl = "nu"
	BrandGetByNameParamsCountryGlNz BrandGetByNameParamsCountryGl = "nz"
	BrandGetByNameParamsCountryGlOm BrandGetByNameParamsCountryGl = "om"
	BrandGetByNameParamsCountryGlPa BrandGetByNameParamsCountryGl = "pa"
	BrandGetByNameParamsCountryGlPe BrandGetByNameParamsCountryGl = "pe"
	BrandGetByNameParamsCountryGlPf BrandGetByNameParamsCountryGl = "pf"
	BrandGetByNameParamsCountryGlPg BrandGetByNameParamsCountryGl = "pg"
	BrandGetByNameParamsCountryGlPh BrandGetByNameParamsCountryGl = "ph"
	BrandGetByNameParamsCountryGlPk BrandGetByNameParamsCountryGl = "pk"
	BrandGetByNameParamsCountryGlPl BrandGetByNameParamsCountryGl = "pl"
	BrandGetByNameParamsCountryGlPm BrandGetByNameParamsCountryGl = "pm"
	BrandGetByNameParamsCountryGlPn BrandGetByNameParamsCountryGl = "pn"
	BrandGetByNameParamsCountryGlPr BrandGetByNameParamsCountryGl = "pr"
	BrandGetByNameParamsCountryGlPs BrandGetByNameParamsCountryGl = "ps"
	BrandGetByNameParamsCountryGlPt BrandGetByNameParamsCountryGl = "pt"
	BrandGetByNameParamsCountryGlPw BrandGetByNameParamsCountryGl = "pw"
	BrandGetByNameParamsCountryGlPy BrandGetByNameParamsCountryGl = "py"
	BrandGetByNameParamsCountryGlQa BrandGetByNameParamsCountryGl = "qa"
	BrandGetByNameParamsCountryGlRe BrandGetByNameParamsCountryGl = "re"
	BrandGetByNameParamsCountryGlRo BrandGetByNameParamsCountryGl = "ro"
	BrandGetByNameParamsCountryGlRs BrandGetByNameParamsCountryGl = "rs"
	BrandGetByNameParamsCountryGlRu BrandGetByNameParamsCountryGl = "ru"
	BrandGetByNameParamsCountryGlRw BrandGetByNameParamsCountryGl = "rw"
	BrandGetByNameParamsCountryGlSa BrandGetByNameParamsCountryGl = "sa"
	BrandGetByNameParamsCountryGlSb BrandGetByNameParamsCountryGl = "sb"
	BrandGetByNameParamsCountryGlSc BrandGetByNameParamsCountryGl = "sc"
	BrandGetByNameParamsCountryGlSd BrandGetByNameParamsCountryGl = "sd"
	BrandGetByNameParamsCountryGlSe BrandGetByNameParamsCountryGl = "se"
	BrandGetByNameParamsCountryGlSg BrandGetByNameParamsCountryGl = "sg"
	BrandGetByNameParamsCountryGlSh BrandGetByNameParamsCountryGl = "sh"
	BrandGetByNameParamsCountryGlSi BrandGetByNameParamsCountryGl = "si"
	BrandGetByNameParamsCountryGlSj BrandGetByNameParamsCountryGl = "sj"
	BrandGetByNameParamsCountryGlSk BrandGetByNameParamsCountryGl = "sk"
	BrandGetByNameParamsCountryGlSl BrandGetByNameParamsCountryGl = "sl"
	BrandGetByNameParamsCountryGlSm BrandGetByNameParamsCountryGl = "sm"
	BrandGetByNameParamsCountryGlSn BrandGetByNameParamsCountryGl = "sn"
	BrandGetByNameParamsCountryGlSo BrandGetByNameParamsCountryGl = "so"
	BrandGetByNameParamsCountryGlSr BrandGetByNameParamsCountryGl = "sr"
	BrandGetByNameParamsCountryGlSt BrandGetByNameParamsCountryGl = "st"
	BrandGetByNameParamsCountryGlSv BrandGetByNameParamsCountryGl = "sv"
	BrandGetByNameParamsCountryGlSy BrandGetByNameParamsCountryGl = "sy"
	BrandGetByNameParamsCountryGlSz BrandGetByNameParamsCountryGl = "sz"
	BrandGetByNameParamsCountryGlTc BrandGetByNameParamsCountryGl = "tc"
	BrandGetByNameParamsCountryGlTd BrandGetByNameParamsCountryGl = "td"
	BrandGetByNameParamsCountryGlTf BrandGetByNameParamsCountryGl = "tf"
	BrandGetByNameParamsCountryGlTg BrandGetByNameParamsCountryGl = "tg"
	BrandGetByNameParamsCountryGlTh BrandGetByNameParamsCountryGl = "th"
	BrandGetByNameParamsCountryGlTj BrandGetByNameParamsCountryGl = "tj"
	BrandGetByNameParamsCountryGlTk BrandGetByNameParamsCountryGl = "tk"
	BrandGetByNameParamsCountryGlTl BrandGetByNameParamsCountryGl = "tl"
	BrandGetByNameParamsCountryGlTm BrandGetByNameParamsCountryGl = "tm"
	BrandGetByNameParamsCountryGlTn BrandGetByNameParamsCountryGl = "tn"
	BrandGetByNameParamsCountryGlTo BrandGetByNameParamsCountryGl = "to"
	BrandGetByNameParamsCountryGlTr BrandGetByNameParamsCountryGl = "tr"
	BrandGetByNameParamsCountryGlTt BrandGetByNameParamsCountryGl = "tt"
	BrandGetByNameParamsCountryGlTv BrandGetByNameParamsCountryGl = "tv"
	BrandGetByNameParamsCountryGlTw BrandGetByNameParamsCountryGl = "tw"
	BrandGetByNameParamsCountryGlTz BrandGetByNameParamsCountryGl = "tz"
	BrandGetByNameParamsCountryGlUa BrandGetByNameParamsCountryGl = "ua"
	BrandGetByNameParamsCountryGlUg BrandGetByNameParamsCountryGl = "ug"
	BrandGetByNameParamsCountryGlUm BrandGetByNameParamsCountryGl = "um"
	BrandGetByNameParamsCountryGlUs BrandGetByNameParamsCountryGl = "us"
	BrandGetByNameParamsCountryGlUy BrandGetByNameParamsCountryGl = "uy"
	BrandGetByNameParamsCountryGlUz BrandGetByNameParamsCountryGl = "uz"
	BrandGetByNameParamsCountryGlVa BrandGetByNameParamsCountryGl = "va"
	BrandGetByNameParamsCountryGlVc BrandGetByNameParamsCountryGl = "vc"
	BrandGetByNameParamsCountryGlVe BrandGetByNameParamsCountryGl = "ve"
	BrandGetByNameParamsCountryGlVg BrandGetByNameParamsCountryGl = "vg"
	BrandGetByNameParamsCountryGlVi BrandGetByNameParamsCountryGl = "vi"
	BrandGetByNameParamsCountryGlVn BrandGetByNameParamsCountryGl = "vn"
	BrandGetByNameParamsCountryGlVu BrandGetByNameParamsCountryGl = "vu"
	BrandGetByNameParamsCountryGlWf BrandGetByNameParamsCountryGl = "wf"
	BrandGetByNameParamsCountryGlWs BrandGetByNameParamsCountryGl = "ws"
	BrandGetByNameParamsCountryGlYe BrandGetByNameParamsCountryGl = "ye"
	BrandGetByNameParamsCountryGlYt BrandGetByNameParamsCountryGl = "yt"
	BrandGetByNameParamsCountryGlZa BrandGetByNameParamsCountryGl = "za"
	BrandGetByNameParamsCountryGlZm BrandGetByNameParamsCountryGl = "zm"
	BrandGetByNameParamsCountryGlZw BrandGetByNameParamsCountryGl = "zw"
)

type BrandGetByNameParamsForceLanguage 

type BrandGetByNameParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandGetByNameParamsForceLanguageAfrikaans      BrandGetByNameParamsForceLanguage = "afrikaans"
	BrandGetByNameParamsForceLanguageAlbanian       BrandGetByNameParamsForceLanguage = "albanian"
	BrandGetByNameParamsForceLanguageAmharic        BrandGetByNameParamsForceLanguage = "amharic"
	BrandGetByNameParamsForceLanguageArabic         BrandGetByNameParamsForceLanguage = "arabic"
	BrandGetByNameParamsForceLanguageArmenian       BrandGetByNameParamsForceLanguage = "armenian"
	BrandGetByNameParamsForceLanguageAssamese       BrandGetByNameParamsForceLanguage = "assamese"
	BrandGetByNameParamsForceLanguageAymara         BrandGetByNameParamsForceLanguage = "aymara"
	BrandGetByNameParamsForceLanguageAzeri          BrandGetByNameParamsForceLanguage = "azeri"
	BrandGetByNameParamsForceLanguageBasque         BrandGetByNameParamsForceLanguage = "basque"
	BrandGetByNameParamsForceLanguageBelarusian     BrandGetByNameParamsForceLanguage = "belarusian"
	BrandGetByNameParamsForceLanguageBengali        BrandGetByNameParamsForceLanguage = "bengali"
	BrandGetByNameParamsForceLanguageBosnian        BrandGetByNameParamsForceLanguage = "bosnian"
	BrandGetByNameParamsForceLanguageBulgarian      BrandGetByNameParamsForceLanguage = "bulgarian"
	BrandGetByNameParamsForceLanguageBurmese        BrandGetByNameParamsForceLanguage = "burmese"
	BrandGetByNameParamsForceLanguageCantonese      BrandGetByNameParamsForceLanguage = "cantonese"
	BrandGetByNameParamsForceLanguageCatalan        BrandGetByNameParamsForceLanguage = "catalan"
	BrandGetByNameParamsForceLanguageCebuano        BrandGetByNameParamsForceLanguage = "cebuano"
	BrandGetByNameParamsForceLanguageChinese        BrandGetByNameParamsForceLanguage = "chinese"
	BrandGetByNameParamsForceLanguageCorsican       BrandGetByNameParamsForceLanguage = "corsican"
	BrandGetByNameParamsForceLanguageCroatian       BrandGetByNameParamsForceLanguage = "croatian"
	BrandGetByNameParamsForceLanguageCzech          BrandGetByNameParamsForceLanguage = "czech"
	BrandGetByNameParamsForceLanguageDanish         BrandGetByNameParamsForceLanguage = "danish"
	BrandGetByNameParamsForceLanguageDutch          BrandGetByNameParamsForceLanguage = "dutch"
	BrandGetByNameParamsForceLanguageEnglish        BrandGetByNameParamsForceLanguage = "english"
	BrandGetByNameParamsForceLanguageEsperanto      BrandGetByNameParamsForceLanguage = "esperanto"
	BrandGetByNameParamsForceLanguageEstonian       BrandGetByNameParamsForceLanguage = "estonian"
	BrandGetByNameParamsForceLanguageFarsi          BrandGetByNameParamsForceLanguage = "farsi"
	BrandGetByNameParamsForceLanguageFijian         BrandGetByNameParamsForceLanguage = "fijian"
	BrandGetByNameParamsForceLanguageFinnish        BrandGetByNameParamsForceLanguage = "finnish"
	BrandGetByNameParamsForceLanguageFrench         BrandGetByNameParamsForceLanguage = "french"
	BrandGetByNameParamsForceLanguageGalician       BrandGetByNameParamsForceLanguage = "galician"
	BrandGetByNameParamsForceLanguageGeorgian       BrandGetByNameParamsForceLanguage = "georgian"
	BrandGetByNameParamsForceLanguageGerman         BrandGetByNameParamsForceLanguage = "german"
	BrandGetByNameParamsForceLanguageGreek          BrandGetByNameParamsForceLanguage = "greek"
	BrandGetByNameParamsForceLanguageGuarani        BrandGetByNameParamsForceLanguage = "guarani"
	BrandGetByNameParamsForceLanguageGujarati       BrandGetByNameParamsForceLanguage = "gujarati"
	BrandGetByNameParamsForceLanguageHaitianCreole  BrandGetByNameParamsForceLanguage = "haitian-creole"
	BrandGetByNameParamsForceLanguageHausa          BrandGetByNameParamsForceLanguage = "hausa"
	BrandGetByNameParamsForceLanguageHawaiian       BrandGetByNameParamsForceLanguage = "hawaiian"
	BrandGetByNameParamsForceLanguageHebrew         BrandGetByNameParamsForceLanguage = "hebrew"
	BrandGetByNameParamsForceLanguageHindi          BrandGetByNameParamsForceLanguage = "hindi"
	BrandGetByNameParamsForceLanguageHmong          BrandGetByNameParamsForceLanguage = "hmong"
	BrandGetByNameParamsForceLanguageHungarian      BrandGetByNameParamsForceLanguage = "hungarian"
	BrandGetByNameParamsForceLanguageIcelandic      BrandGetByNameParamsForceLanguage = "icelandic"
	BrandGetByNameParamsForceLanguageIgbo           BrandGetByNameParamsForceLanguage = "igbo"
	BrandGetByNameParamsForceLanguageIndonesian     BrandGetByNameParamsForceLanguage = "indonesian"
	BrandGetByNameParamsForceLanguageIrish          BrandGetByNameParamsForceLanguage = "irish"
	BrandGetByNameParamsForceLanguageItalian        BrandGetByNameParamsForceLanguage = "italian"
	BrandGetByNameParamsForceLanguageJapanese       BrandGetByNameParamsForceLanguage = "japanese"
	BrandGetByNameParamsForceLanguageJavanese       BrandGetByNameParamsForceLanguage = "javanese"
	BrandGetByNameParamsForceLanguageKannada        BrandGetByNameParamsForceLanguage = "kannada"
	BrandGetByNameParamsForceLanguageKazakh         BrandGetByNameParamsForceLanguage = "kazakh"
	BrandGetByNameParamsForceLanguageKhmer          BrandGetByNameParamsForceLanguage = "khmer"
	BrandGetByNameParamsForceLanguageKinyarwanda    BrandGetByNameParamsForceLanguage = "kinyarwanda"
	BrandGetByNameParamsForceLanguageKorean         BrandGetByNameParamsForceLanguage = "korean"
	BrandGetByNameParamsForceLanguageKurdish        BrandGetByNameParamsForceLanguage = "kurdish"
	BrandGetByNameParamsForceLanguageKyrgyz         BrandGetByNameParamsForceLanguage = "kyrgyz"
	BrandGetByNameParamsForceLanguageLao            BrandGetByNameParamsForceLanguage = "lao"
	BrandGetByNameParamsForceLanguageLatin          BrandGetByNameParamsForceLanguage = "latin"
	BrandGetByNameParamsForceLanguageLatvian        BrandGetByNameParamsForceLanguage = "latvian"
	BrandGetByNameParamsForceLanguageLingala        BrandGetByNameParamsForceLanguage = "lingala"
	BrandGetByNameParamsForceLanguageLithuanian     BrandGetByNameParamsForceLanguage = "lithuanian"
	BrandGetByNameParamsForceLanguageLuxembourgish  BrandGetByNameParamsForceLanguage = "luxembourgish"
	BrandGetByNameParamsForceLanguageMacedonian     BrandGetByNameParamsForceLanguage = "macedonian"
	BrandGetByNameParamsForceLanguageMalagasy       BrandGetByNameParamsForceLanguage = "malagasy"
	BrandGetByNameParamsForceLanguageMalay          BrandGetByNameParamsForceLanguage = "malay"
	BrandGetByNameParamsForceLanguageMalayalam      BrandGetByNameParamsForceLanguage = "malayalam"
	BrandGetByNameParamsForceLanguageMaltese        BrandGetByNameParamsForceLanguage = "maltese"
	BrandGetByNameParamsForceLanguageMaori          BrandGetByNameParamsForceLanguage = "maori"
	BrandGetByNameParamsForceLanguageMarathi        BrandGetByNameParamsForceLanguage = "marathi"
	BrandGetByNameParamsForceLanguageMongolian      BrandGetByNameParamsForceLanguage = "mongolian"
	BrandGetByNameParamsForceLanguageNepali         BrandGetByNameParamsForceLanguage = "nepali"
	BrandGetByNameParamsForceLanguageNorwegian      BrandGetByNameParamsForceLanguage = "norwegian"
	BrandGetByNameParamsForceLanguageOdia           BrandGetByNameParamsForceLanguage = "odia"
	BrandGetByNameParamsForceLanguageOromo          BrandGetByNameParamsForceLanguage = "oromo"
	BrandGetByNameParamsForceLanguagePashto         BrandGetByNameParamsForceLanguage = "pashto"
	BrandGetByNameParamsForceLanguagePidgin         BrandGetByNameParamsForceLanguage = "pidgin"
	BrandGetByNameParamsForceLanguagePolish         BrandGetByNameParamsForceLanguage = "polish"
	BrandGetByNameParamsForceLanguagePortuguese     BrandGetByNameParamsForceLanguage = "portuguese"
	BrandGetByNameParamsForceLanguagePunjabi        BrandGetByNameParamsForceLanguage = "punjabi"
	BrandGetByNameParamsForceLanguageQuechua        BrandGetByNameParamsForceLanguage = "quechua"
	BrandGetByNameParamsForceLanguageRomanian       BrandGetByNameParamsForceLanguage = "romanian"
	BrandGetByNameParamsForceLanguageRussian        BrandGetByNameParamsForceLanguage = "russian"
	BrandGetByNameParamsForceLanguageSamoan         BrandGetByNameParamsForceLanguage = "samoan"
	BrandGetByNameParamsForceLanguageScottishGaelic BrandGetByNameParamsForceLanguage = "scottish-gaelic"
	BrandGetByNameParamsForceLanguageSerbian        BrandGetByNameParamsForceLanguage = "serbian"
	BrandGetByNameParamsForceLanguageSesotho        BrandGetByNameParamsForceLanguage = "sesotho"
	BrandGetByNameParamsForceLanguageShona          BrandGetByNameParamsForceLanguage = "shona"
	BrandGetByNameParamsForceLanguageSindhi         BrandGetByNameParamsForceLanguage = "sindhi"
	BrandGetByNameParamsForceLanguageSinhala        BrandGetByNameParamsForceLanguage = "sinhala"
	BrandGetByNameParamsForceLanguageSlovak         BrandGetByNameParamsForceLanguage = "slovak"
	BrandGetByNameParamsForceLanguageSlovene        BrandGetByNameParamsForceLanguage = "slovene"
	BrandGetByNameParamsForceLanguageSomali         BrandGetByNameParamsForceLanguage = "somali"
	BrandGetByNameParamsForceLanguageSpanish        BrandGetByNameParamsForceLanguage = "spanish"
	BrandGetByNameParamsForceLanguageSundanese      BrandGetByNameParamsForceLanguage = "sundanese"
	BrandGetByNameParamsForceLanguageSwahili        BrandGetByNameParamsForceLanguage = "swahili"
	BrandGetByNameParamsForceLanguageSwedish        BrandGetByNameParamsForceLanguage = "swedish"
	BrandGetByNameParamsForceLanguageTagalog        BrandGetByNameParamsForceLanguage = "tagalog"
	BrandGetByNameParamsForceLanguageTajik          BrandGetByNameParamsForceLanguage = "tajik"
	BrandGetByNameParamsForceLanguageTamil          BrandGetByNameParamsForceLanguage = "tamil"
	BrandGetByNameParamsForceLanguageTatar          BrandGetByNameParamsForceLanguage = "tatar"
	BrandGetByNameParamsForceLanguageTelugu         BrandGetByNameParamsForceLanguage = "telugu"
	BrandGetByNameParamsForceLanguageThai           BrandGetByNameParamsForceLanguage = "thai"
	BrandGetByNameParamsForceLanguageTibetan        BrandGetByNameParamsForceLanguage = "tibetan"
	BrandGetByNameParamsForceLanguageTigrinya       BrandGetByNameParamsForceLanguage = "tigrinya"
	BrandGetByNameParamsForceLanguageTongan         BrandGetByNameParamsForceLanguage = "tongan"
	BrandGetByNameParamsForceLanguageTswana         BrandGetByNameParamsForceLanguage = "tswana"
	BrandGetByNameParamsForceLanguageTurkish        BrandGetByNameParamsForceLanguage = "turkish"
	BrandGetByNameParamsForceLanguageTurkmen        BrandGetByNameParamsForceLanguage = "turkmen"
	BrandGetByNameParamsForceLanguageUkrainian      BrandGetByNameParamsForceLanguage = "ukrainian"
	BrandGetByNameParamsForceLanguageUrdu           BrandGetByNameParamsForceLanguage = "urdu"
	BrandGetByNameParamsForceLanguageUyghur         BrandGetByNameParamsForceLanguage = "uyghur"
	BrandGetByNameParamsForceLanguageUzbek          BrandGetByNameParamsForceLanguage = "uzbek"
	BrandGetByNameParamsForceLanguageVietnamese     BrandGetByNameParamsForceLanguage = "vietnamese"
	BrandGetByNameParamsForceLanguageWelsh          BrandGetByNameParamsForceLanguage = "welsh"
	BrandGetByNameParamsForceLanguageWolof          BrandGetByNameParamsForceLanguage = "wolof"
	BrandGetByNameParamsForceLanguageXhosa          BrandGetByNameParamsForceLanguage = "xhosa"
	BrandGetByNameParamsForceLanguageYiddish        BrandGetByNameParamsForceLanguage = "yiddish"
	BrandGetByNameParamsForceLanguageYoruba         BrandGetByNameParamsForceLanguage = "yoruba"
	BrandGetByNameParamsForceLanguageZulu           BrandGetByNameParamsForceLanguage = "zulu"
)

type BrandGetByNameResponse 

type BrandGetByNameResponse struct {
	// Detailed brand information
	Brand BrandGetByNameResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponse) RawJSON 

func (r BrandGetByNameResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponse) UnmarshalJSON 

func (r *BrandGetByNameResponse) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrand 

type BrandGetByNameResponseBrand struct {
	// Physical address of the brand
	Address BrandGetByNameResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandGetByNameResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetByNameResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandGetByNameResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandGetByNameResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandGetByNameResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandGetByNameResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandGetByNameResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandGetByNameResponseBrand) RawJSON 

func (r BrandGetByNameResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrand) UnmarshalJSON 

func (r *BrandGetByNameResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandAddress 

type BrandGetByNameResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandGetByNameResponseBrandAddress) RawJSON 

func (r BrandGetByNameResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandAddress) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandBackdrop 

type BrandGetByNameResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetByNameResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetByNameResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandBackdrop) RawJSON 

func (r BrandGetByNameResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandBackdropColor 

type BrandGetByNameResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandBackdropColor) RawJSON 

func (r BrandGetByNameResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandBackdropResolution 

type BrandGetByNameResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetByNameResponseBrandBackdropResolution) RawJSON 

func (r BrandGetByNameResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandColor 

type BrandGetByNameResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandColor) RawJSON 

func (r BrandGetByNameResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandColor) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandIndustries 

type BrandGetByNameResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandGetByNameResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandGetByNameResponseBrandIndustries) RawJSON 

func (r BrandGetByNameResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandIndustries) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandIndustriesEic 

type BrandGetByNameResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandIndustriesEic) RawJSON 

func (r BrandGetByNameResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandGetByNameResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandGetByNameResponseBrandLinks) RawJSON 

func (r BrandGetByNameResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandLinks) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandGetByNameResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetByNameResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetByNameResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandLogo) RawJSON 

func (r BrandGetByNameResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandLogoColor 

type BrandGetByNameResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandLogoColor) RawJSON 

func (r BrandGetByNameResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandLogoResolution 

type BrandGetByNameResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetByNameResponseBrandLogoResolution) RawJSON 

func (r BrandGetByNameResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandSocial 

type BrandGetByNameResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByNameResponseBrandSocial) RawJSON 

func (r BrandGetByNameResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandSocial) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandGetByNameResponseBrandStock 

type BrandGetByNameResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandGetByNameResponseBrandStock) RawJSON 

func (r BrandGetByNameResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByNameResponseBrandStock) UnmarshalJSON 

func (r *BrandGetByNameResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandGetByTickerParams 

type BrandGetByTickerParams struct {
	// Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
	// Must be 1-15 characters, letters/numbers/dots only.
	Ticker string `query:"ticker" api:"required" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandGetByTickerParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
	//
	// Any of "AMEX", "AMS", "AQS", "ASX", "ATH", "BER", "BME", "BRU", "BSE", "BUD",
	// "BUE", "BVC", "CBOE", "CNQ", "CPH", "DFM", "DOH", "DUB", "DUS", "DXE", "EGX",
	// "FSX", "HAM", "HEL", "HKSE", "HOSE", "ICE", "IOB", "IST", "JKT", "JNB", "JPX",
	// "KLS", "KOE", "KSC", "KUW", "LIS", "LSE", "MCX", "MEX", "MIL", "MUN", "NASDAQ",
	// "NEO", "NSE", "NYSE", "NZE", "OSL", "OTC", "PAR", "PNK", "PRA", "RIS", "SAO",
	// "SAU", "SES", "SET", "SGO", "SHH", "SHZ", "SIX", "STO", "STU", "TAI", "TAL",
	// "TLV", "TSX", "TSXV", "TWO", "VIE", "WSE", "XETRA".
	TickerExchange BrandGetByTickerParamsTickerExchange `query:"ticker_exchange,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetByTickerParams) URLQuery 

func (r BrandGetByTickerParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetByTickerParams's query parameters as `url.Values`.

type BrandGetByTickerParamsForceLanguage 

type BrandGetByTickerParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandGetByTickerParamsForceLanguageAfrikaans      BrandGetByTickerParamsForceLanguage = "afrikaans"
	BrandGetByTickerParamsForceLanguageAlbanian       BrandGetByTickerParamsForceLanguage = "albanian"
	BrandGetByTickerParamsForceLanguageAmharic        BrandGetByTickerParamsForceLanguage = "amharic"
	BrandGetByTickerParamsForceLanguageArabic         BrandGetByTickerParamsForceLanguage = "arabic"
	BrandGetByTickerParamsForceLanguageArmenian       BrandGetByTickerParamsForceLanguage = "armenian"
	BrandGetByTickerParamsForceLanguageAssamese       BrandGetByTickerParamsForceLanguage = "assamese"
	BrandGetByTickerParamsForceLanguageAymara         BrandGetByTickerParamsForceLanguage = "aymara"
	BrandGetByTickerParamsForceLanguageAzeri          BrandGetByTickerParamsForceLanguage = "azeri"
	BrandGetByTickerParamsForceLanguageBasque         BrandGetByTickerParamsForceLanguage = "basque"
	BrandGetByTickerParamsForceLanguageBelarusian     BrandGetByTickerParamsForceLanguage = "belarusian"
	BrandGetByTickerParamsForceLanguageBengali        BrandGetByTickerParamsForceLanguage = "bengali"
	BrandGetByTickerParamsForceLanguageBosnian        BrandGetByTickerParamsForceLanguage = "bosnian"
	BrandGetByTickerParamsForceLanguageBulgarian      BrandGetByTickerParamsForceLanguage = "bulgarian"
	BrandGetByTickerParamsForceLanguageBurmese        BrandGetByTickerParamsForceLanguage = "burmese"
	BrandGetByTickerParamsForceLanguageCantonese      BrandGetByTickerParamsForceLanguage = "cantonese"
	BrandGetByTickerParamsForceLanguageCatalan        BrandGetByTickerParamsForceLanguage = "catalan"
	BrandGetByTickerParamsForceLanguageCebuano        BrandGetByTickerParamsForceLanguage = "cebuano"
	BrandGetByTickerParamsForceLanguageChinese        BrandGetByTickerParamsForceLanguage = "chinese"
	BrandGetByTickerParamsForceLanguageCorsican       BrandGetByTickerParamsForceLanguage = "corsican"
	BrandGetByTickerParamsForceLanguageCroatian       BrandGetByTickerParamsForceLanguage = "croatian"
	BrandGetByTickerParamsForceLanguageCzech          BrandGetByTickerParamsForceLanguage = "czech"
	BrandGetByTickerParamsForceLanguageDanish         BrandGetByTickerParamsForceLanguage = "danish"
	BrandGetByTickerParamsForceLanguageDutch          BrandGetByTickerParamsForceLanguage = "dutch"
	BrandGetByTickerParamsForceLanguageEnglish        BrandGetByTickerParamsForceLanguage = "english"
	BrandGetByTickerParamsForceLanguageEsperanto      BrandGetByTickerParamsForceLanguage = "esperanto"
	BrandGetByTickerParamsForceLanguageEstonian       BrandGetByTickerParamsForceLanguage = "estonian"
	BrandGetByTickerParamsForceLanguageFarsi          BrandGetByTickerParamsForceLanguage = "farsi"
	BrandGetByTickerParamsForceLanguageFijian         BrandGetByTickerParamsForceLanguage = "fijian"
	BrandGetByTickerParamsForceLanguageFinnish        BrandGetByTickerParamsForceLanguage = "finnish"
	BrandGetByTickerParamsForceLanguageFrench         BrandGetByTickerParamsForceLanguage = "french"
	BrandGetByTickerParamsForceLanguageGalician       BrandGetByTickerParamsForceLanguage = "galician"
	BrandGetByTickerParamsForceLanguageGeorgian       BrandGetByTickerParamsForceLanguage = "georgian"
	BrandGetByTickerParamsForceLanguageGerman         BrandGetByTickerParamsForceLanguage = "german"
	BrandGetByTickerParamsForceLanguageGreek          BrandGetByTickerParamsForceLanguage = "greek"
	BrandGetByTickerParamsForceLanguageGuarani        BrandGetByTickerParamsForceLanguage = "guarani"
	BrandGetByTickerParamsForceLanguageGujarati       BrandGetByTickerParamsForceLanguage = "gujarati"
	BrandGetByTickerParamsForceLanguageHaitianCreole  BrandGetByTickerParamsForceLanguage = "haitian-creole"
	BrandGetByTickerParamsForceLanguageHausa          BrandGetByTickerParamsForceLanguage = "hausa"
	BrandGetByTickerParamsForceLanguageHawaiian       BrandGetByTickerParamsForceLanguage = "hawaiian"
	BrandGetByTickerParamsForceLanguageHebrew         BrandGetByTickerParamsForceLanguage = "hebrew"
	BrandGetByTickerParamsForceLanguageHindi          BrandGetByTickerParamsForceLanguage = "hindi"
	BrandGetByTickerParamsForceLanguageHmong          BrandGetByTickerParamsForceLanguage = "hmong"
	BrandGetByTickerParamsForceLanguageHungarian      BrandGetByTickerParamsForceLanguage = "hungarian"
	BrandGetByTickerParamsForceLanguageIcelandic      BrandGetByTickerParamsForceLanguage = "icelandic"
	BrandGetByTickerParamsForceLanguageIgbo           BrandGetByTickerParamsForceLanguage = "igbo"
	BrandGetByTickerParamsForceLanguageIndonesian     BrandGetByTickerParamsForceLanguage = "indonesian"
	BrandGetByTickerParamsForceLanguageIrish          BrandGetByTickerParamsForceLanguage = "irish"
	BrandGetByTickerParamsForceLanguageItalian        BrandGetByTickerParamsForceLanguage = "italian"
	BrandGetByTickerParamsForceLanguageJapanese       BrandGetByTickerParamsForceLanguage = "japanese"
	BrandGetByTickerParamsForceLanguageJavanese       BrandGetByTickerParamsForceLanguage = "javanese"
	BrandGetByTickerParamsForceLanguageKannada        BrandGetByTickerParamsForceLanguage = "kannada"
	BrandGetByTickerParamsForceLanguageKazakh         BrandGetByTickerParamsForceLanguage = "kazakh"
	BrandGetByTickerParamsForceLanguageKhmer          BrandGetByTickerParamsForceLanguage = "khmer"
	BrandGetByTickerParamsForceLanguageKinyarwanda    BrandGetByTickerParamsForceLanguage = "kinyarwanda"
	BrandGetByTickerParamsForceLanguageKorean         BrandGetByTickerParamsForceLanguage = "korean"
	BrandGetByTickerParamsForceLanguageKurdish        BrandGetByTickerParamsForceLanguage = "kurdish"
	BrandGetByTickerParamsForceLanguageKyrgyz         BrandGetByTickerParamsForceLanguage = "kyrgyz"
	BrandGetByTickerParamsForceLanguageLao            BrandGetByTickerParamsForceLanguage = "lao"
	BrandGetByTickerParamsForceLanguageLatin          BrandGetByTickerParamsForceLanguage = "latin"
	BrandGetByTickerParamsForceLanguageLatvian        BrandGetByTickerParamsForceLanguage = "latvian"
	BrandGetByTickerParamsForceLanguageLingala        BrandGetByTickerParamsForceLanguage = "lingala"
	BrandGetByTickerParamsForceLanguageLithuanian     BrandGetByTickerParamsForceLanguage = "lithuanian"
	BrandGetByTickerParamsForceLanguageLuxembourgish  BrandGetByTickerParamsForceLanguage = "luxembourgish"
	BrandGetByTickerParamsForceLanguageMacedonian     BrandGetByTickerParamsForceLanguage = "macedonian"
	BrandGetByTickerParamsForceLanguageMalagasy       BrandGetByTickerParamsForceLanguage = "malagasy"
	BrandGetByTickerParamsForceLanguageMalay          BrandGetByTickerParamsForceLanguage = "malay"
	BrandGetByTickerParamsForceLanguageMalayalam      BrandGetByTickerParamsForceLanguage = "malayalam"
	BrandGetByTickerParamsForceLanguageMaltese        BrandGetByTickerParamsForceLanguage = "maltese"
	BrandGetByTickerParamsForceLanguageMaori          BrandGetByTickerParamsForceLanguage = "maori"
	BrandGetByTickerParamsForceLanguageMarathi        BrandGetByTickerParamsForceLanguage = "marathi"
	BrandGetByTickerParamsForceLanguageMongolian      BrandGetByTickerParamsForceLanguage = "mongolian"
	BrandGetByTickerParamsForceLanguageNepali         BrandGetByTickerParamsForceLanguage = "nepali"
	BrandGetByTickerParamsForceLanguageNorwegian      BrandGetByTickerParamsForceLanguage = "norwegian"
	BrandGetByTickerParamsForceLanguageOdia           BrandGetByTickerParamsForceLanguage = "odia"
	BrandGetByTickerParamsForceLanguageOromo          BrandGetByTickerParamsForceLanguage = "oromo"
	BrandGetByTickerParamsForceLanguagePashto         BrandGetByTickerParamsForceLanguage = "pashto"
	BrandGetByTickerParamsForceLanguagePidgin         BrandGetByTickerParamsForceLanguage = "pidgin"
	BrandGetByTickerParamsForceLanguagePolish         BrandGetByTickerParamsForceLanguage = "polish"
	BrandGetByTickerParamsForceLanguagePortuguese     BrandGetByTickerParamsForceLanguage = "portuguese"
	BrandGetByTickerParamsForceLanguagePunjabi        BrandGetByTickerParamsForceLanguage = "punjabi"
	BrandGetByTickerParamsForceLanguageQuechua        BrandGetByTickerParamsForceLanguage = "quechua"
	BrandGetByTickerParamsForceLanguageRomanian       BrandGetByTickerParamsForceLanguage = "romanian"
	BrandGetByTickerParamsForceLanguageRussian        BrandGetByTickerParamsForceLanguage = "russian"
	BrandGetByTickerParamsForceLanguageSamoan         BrandGetByTickerParamsForceLanguage = "samoan"
	BrandGetByTickerParamsForceLanguageScottishGaelic BrandGetByTickerParamsForceLanguage = "scottish-gaelic"
	BrandGetByTickerParamsForceLanguageSerbian        BrandGetByTickerParamsForceLanguage = "serbian"
	BrandGetByTickerParamsForceLanguageSesotho        BrandGetByTickerParamsForceLanguage = "sesotho"
	BrandGetByTickerParamsForceLanguageShona          BrandGetByTickerParamsForceLanguage = "shona"
	BrandGetByTickerParamsForceLanguageSindhi         BrandGetByTickerParamsForceLanguage = "sindhi"
	BrandGetByTickerParamsForceLanguageSinhala        BrandGetByTickerParamsForceLanguage = "sinhala"
	BrandGetByTickerParamsForceLanguageSlovak         BrandGetByTickerParamsForceLanguage = "slovak"
	BrandGetByTickerParamsForceLanguageSlovene        BrandGetByTickerParamsForceLanguage = "slovene"
	BrandGetByTickerParamsForceLanguageSomali         BrandGetByTickerParamsForceLanguage = "somali"
	BrandGetByTickerParamsForceLanguageSpanish        BrandGetByTickerParamsForceLanguage = "spanish"
	BrandGetByTickerParamsForceLanguageSundanese      BrandGetByTickerParamsForceLanguage = "sundanese"
	BrandGetByTickerParamsForceLanguageSwahili        BrandGetByTickerParamsForceLanguage = "swahili"
	BrandGetByTickerParamsForceLanguageSwedish        BrandGetByTickerParamsForceLanguage = "swedish"
	BrandGetByTickerParamsForceLanguageTagalog        BrandGetByTickerParamsForceLanguage = "tagalog"
	BrandGetByTickerParamsForceLanguageTajik          BrandGetByTickerParamsForceLanguage = "tajik"
	BrandGetByTickerParamsForceLanguageTamil          BrandGetByTickerParamsForceLanguage = "tamil"
	BrandGetByTickerParamsForceLanguageTatar          BrandGetByTickerParamsForceLanguage = "tatar"
	BrandGetByTickerParamsForceLanguageTelugu         BrandGetByTickerParamsForceLanguage = "telugu"
	BrandGetByTickerParamsForceLanguageThai           BrandGetByTickerParamsForceLanguage = "thai"
	BrandGetByTickerParamsForceLanguageTibetan        BrandGetByTickerParamsForceLanguage = "tibetan"
	BrandGetByTickerParamsForceLanguageTigrinya       BrandGetByTickerParamsForceLanguage = "tigrinya"
	BrandGetByTickerParamsForceLanguageTongan         BrandGetByTickerParamsForceLanguage = "tongan"
	BrandGetByTickerParamsForceLanguageTswana         BrandGetByTickerParamsForceLanguage = "tswana"
	BrandGetByTickerParamsForceLanguageTurkish        BrandGetByTickerParamsForceLanguage = "turkish"
	BrandGetByTickerParamsForceLanguageTurkmen        BrandGetByTickerParamsForceLanguage = "turkmen"
	BrandGetByTickerParamsForceLanguageUkrainian      BrandGetByTickerParamsForceLanguage = "ukrainian"
	BrandGetByTickerParamsForceLanguageUrdu           BrandGetByTickerParamsForceLanguage = "urdu"
	BrandGetByTickerParamsForceLanguageUyghur         BrandGetByTickerParamsForceLanguage = "uyghur"
	BrandGetByTickerParamsForceLanguageUzbek          BrandGetByTickerParamsForceLanguage = "uzbek"
	BrandGetByTickerParamsForceLanguageVietnamese     BrandGetByTickerParamsForceLanguage = "vietnamese"
	BrandGetByTickerParamsForceLanguageWelsh          BrandGetByTickerParamsForceLanguage = "welsh"
	BrandGetByTickerParamsForceLanguageWolof          BrandGetByTickerParamsForceLanguage = "wolof"
	BrandGetByTickerParamsForceLanguageXhosa          BrandGetByTickerParamsForceLanguage = "xhosa"
	BrandGetByTickerParamsForceLanguageYiddish        BrandGetByTickerParamsForceLanguage = "yiddish"
	BrandGetByTickerParamsForceLanguageYoruba         BrandGetByTickerParamsForceLanguage = "yoruba"
	BrandGetByTickerParamsForceLanguageZulu           BrandGetByTickerParamsForceLanguage = "zulu"
)

type BrandGetByTickerParamsTickerExchange 

type BrandGetByTickerParamsTickerExchange string

Optional stock exchange for the ticker. Defaults to NASDAQ if not specified. 

const (
	BrandGetByTickerParamsTickerExchangeAmex   BrandGetByTickerParamsTickerExchange = "AMEX"
	BrandGetByTickerParamsTickerExchangeAms    BrandGetByTickerParamsTickerExchange = "AMS"
	BrandGetByTickerParamsTickerExchangeAqs    BrandGetByTickerParamsTickerExchange = "AQS"
	BrandGetByTickerParamsTickerExchangeAsx    BrandGetByTickerParamsTickerExchange = "ASX"
	BrandGetByTickerParamsTickerExchangeAth    BrandGetByTickerParamsTickerExchange = "ATH"
	BrandGetByTickerParamsTickerExchangeBer    BrandGetByTickerParamsTickerExchange = "BER"
	BrandGetByTickerParamsTickerExchangeBme    BrandGetByTickerParamsTickerExchange = "BME"
	BrandGetByTickerParamsTickerExchangeBru    BrandGetByTickerParamsTickerExchange = "BRU"
	BrandGetByTickerParamsTickerExchangeBse    BrandGetByTickerParamsTickerExchange = "BSE"
	BrandGetByTickerParamsTickerExchangeBud    BrandGetByTickerParamsTickerExchange = "BUD"
	BrandGetByTickerParamsTickerExchangeBue    BrandGetByTickerParamsTickerExchange = "BUE"
	BrandGetByTickerParamsTickerExchangeBvc    BrandGetByTickerParamsTickerExchange = "BVC"
	BrandGetByTickerParamsTickerExchangeCboe   BrandGetByTickerParamsTickerExchange = "CBOE"
	BrandGetByTickerParamsTickerExchangeCnq    BrandGetByTickerParamsTickerExchange = "CNQ"
	BrandGetByTickerParamsTickerExchangeCph    BrandGetByTickerParamsTickerExchange = "CPH"
	BrandGetByTickerParamsTickerExchangeDfm    BrandGetByTickerParamsTickerExchange = "DFM"
	BrandGetByTickerParamsTickerExchangeDoh    BrandGetByTickerParamsTickerExchange = "DOH"
	BrandGetByTickerParamsTickerExchangeDub    BrandGetByTickerParamsTickerExchange = "DUB"
	BrandGetByTickerParamsTickerExchangeDus    BrandGetByTickerParamsTickerExchange = "DUS"
	BrandGetByTickerParamsTickerExchangeDxe    BrandGetByTickerParamsTickerExchange = "DXE"
	BrandGetByTickerParamsTickerExchangeEgx    BrandGetByTickerParamsTickerExchange = "EGX"
	BrandGetByTickerParamsTickerExchangeFsx    BrandGetByTickerParamsTickerExchange = "FSX"
	BrandGetByTickerParamsTickerExchangeHam    BrandGetByTickerParamsTickerExchange = "HAM"
	BrandGetByTickerParamsTickerExchangeHel    BrandGetByTickerParamsTickerExchange = "HEL"
	BrandGetByTickerParamsTickerExchangeHkse   BrandGetByTickerParamsTickerExchange = "HKSE"
	BrandGetByTickerParamsTickerExchangeHose   BrandGetByTickerParamsTickerExchange = "HOSE"
	BrandGetByTickerParamsTickerExchangeIce    BrandGetByTickerParamsTickerExchange = "ICE"
	BrandGetByTickerParamsTickerExchangeIob    BrandGetByTickerParamsTickerExchange = "IOB"
	BrandGetByTickerParamsTickerExchangeIst    BrandGetByTickerParamsTickerExchange = "IST"
	BrandGetByTickerParamsTickerExchangeJkt    BrandGetByTickerParamsTickerExchange = "JKT"
	BrandGetByTickerParamsTickerExchangeJnb    BrandGetByTickerParamsTickerExchange = "JNB"
	BrandGetByTickerParamsTickerExchangeJpx    BrandGetByTickerParamsTickerExchange = "JPX"
	BrandGetByTickerParamsTickerExchangeKls    BrandGetByTickerParamsTickerExchange = "KLS"
	BrandGetByTickerParamsTickerExchangeKoe    BrandGetByTickerParamsTickerExchange = "KOE"
	BrandGetByTickerParamsTickerExchangeKsc    BrandGetByTickerParamsTickerExchange = "KSC"
	BrandGetByTickerParamsTickerExchangeKuw    BrandGetByTickerParamsTickerExchange = "KUW"
	BrandGetByTickerParamsTickerExchangeLis    BrandGetByTickerParamsTickerExchange = "LIS"
	BrandGetByTickerParamsTickerExchangeLse    BrandGetByTickerParamsTickerExchange = "LSE"
	BrandGetByTickerParamsTickerExchangeMcx    BrandGetByTickerParamsTickerExchange = "MCX"
	BrandGetByTickerParamsTickerExchangeMex    BrandGetByTickerParamsTickerExchange = "MEX"
	BrandGetByTickerParamsTickerExchangeMil    BrandGetByTickerParamsTickerExchange = "MIL"
	BrandGetByTickerParamsTickerExchangeMun    BrandGetByTickerParamsTickerExchange = "MUN"
	BrandGetByTickerParamsTickerExchangeNasdaq BrandGetByTickerParamsTickerExchange = "NASDAQ"
	BrandGetByTickerParamsTickerExchangeNeo    BrandGetByTickerParamsTickerExchange = "NEO"
	BrandGetByTickerParamsTickerExchangeNse    BrandGetByTickerParamsTickerExchange = "NSE"
	BrandGetByTickerParamsTickerExchangeNyse   BrandGetByTickerParamsTickerExchange = "NYSE"
	BrandGetByTickerParamsTickerExchangeNze    BrandGetByTickerParamsTickerExchange = "NZE"
	BrandGetByTickerParamsTickerExchangeOsl    BrandGetByTickerParamsTickerExchange = "OSL"
	BrandGetByTickerParamsTickerExchangeOtc    BrandGetByTickerParamsTickerExchange = "OTC"
	BrandGetByTickerParamsTickerExchangePar    BrandGetByTickerParamsTickerExchange = "PAR"
	BrandGetByTickerParamsTickerExchangePnk    BrandGetByTickerParamsTickerExchange = "PNK"
	BrandGetByTickerParamsTickerExchangePra    BrandGetByTickerParamsTickerExchange = "PRA"
	BrandGetByTickerParamsTickerExchangeRis    BrandGetByTickerParamsTickerExchange = "RIS"
	BrandGetByTickerParamsTickerExchangeSao    BrandGetByTickerParamsTickerExchange = "SAO"
	BrandGetByTickerParamsTickerExchangeSau    BrandGetByTickerParamsTickerExchange = "SAU"
	BrandGetByTickerParamsTickerExchangeSes    BrandGetByTickerParamsTickerExchange = "SES"
	BrandGetByTickerParamsTickerExchangeSet    BrandGetByTickerParamsTickerExchange = "SET"
	BrandGetByTickerParamsTickerExchangeSgo    BrandGetByTickerParamsTickerExchange = "SGO"
	BrandGetByTickerParamsTickerExchangeShh    BrandGetByTickerParamsTickerExchange = "SHH"
	BrandGetByTickerParamsTickerExchangeShz    BrandGetByTickerParamsTickerExchange = "SHZ"
	BrandGetByTickerParamsTickerExchangeSix    BrandGetByTickerParamsTickerExchange = "SIX"
	BrandGetByTickerParamsTickerExchangeSto    BrandGetByTickerParamsTickerExchange = "STO"
	BrandGetByTickerParamsTickerExchangeStu    BrandGetByTickerParamsTickerExchange = "STU"
	BrandGetByTickerParamsTickerExchangeTai    BrandGetByTickerParamsTickerExchange = "TAI"
	BrandGetByTickerParamsTickerExchangeTal    BrandGetByTickerParamsTickerExchange = "TAL"
	BrandGetByTickerParamsTickerExchangeTlv    BrandGetByTickerParamsTickerExchange = "TLV"
	BrandGetByTickerParamsTickerExchangeTsx    BrandGetByTickerParamsTickerExchange = "TSX"
	BrandGetByTickerParamsTickerExchangeTsxv   BrandGetByTickerParamsTickerExchange = "TSXV"
	BrandGetByTickerParamsTickerExchangeTwo    BrandGetByTickerParamsTickerExchange = "TWO"
	BrandGetByTickerParamsTickerExchangeVie    BrandGetByTickerParamsTickerExchange = "VIE"
	BrandGetByTickerParamsTickerExchangeWse    BrandGetByTickerParamsTickerExchange = "WSE"
	BrandGetByTickerParamsTickerExchangeXetra  BrandGetByTickerParamsTickerExchange = "XETRA"
)

type BrandGetByTickerResponse 

type BrandGetByTickerResponse struct {
	// Detailed brand information
	Brand BrandGetByTickerResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponse) RawJSON 

func (r BrandGetByTickerResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponse) UnmarshalJSON 

func (r *BrandGetByTickerResponse) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrand 

type BrandGetByTickerResponseBrand struct {
	// Physical address of the brand
	Address BrandGetByTickerResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandGetByTickerResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetByTickerResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandGetByTickerResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandGetByTickerResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandGetByTickerResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandGetByTickerResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandGetByTickerResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandGetByTickerResponseBrand) RawJSON 

func (r BrandGetByTickerResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrand) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandAddress 

type BrandGetByTickerResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandGetByTickerResponseBrandAddress) RawJSON 

func (r BrandGetByTickerResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandAddress) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandBackdrop 

type BrandGetByTickerResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetByTickerResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetByTickerResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandBackdrop) RawJSON 

func (r BrandGetByTickerResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandBackdropColor 

type BrandGetByTickerResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandBackdropColor) RawJSON 

func (r BrandGetByTickerResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandBackdropResolution 

type BrandGetByTickerResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetByTickerResponseBrandBackdropResolution) RawJSON 

func (r BrandGetByTickerResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandColor 

type BrandGetByTickerResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandColor) RawJSON 

func (r BrandGetByTickerResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandColor) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandIndustries 

type BrandGetByTickerResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandGetByTickerResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandGetByTickerResponseBrandIndustries) RawJSON 

func (r BrandGetByTickerResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandIndustries) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandIndustriesEic 

type BrandGetByTickerResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandIndustriesEic) RawJSON 

func (r BrandGetByTickerResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandGetByTickerResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandGetByTickerResponseBrandLinks) RawJSON 

func (r BrandGetByTickerResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandLinks) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandGetByTickerResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetByTickerResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetByTickerResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandLogo) RawJSON 

func (r BrandGetByTickerResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandLogoColor 

type BrandGetByTickerResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandLogoColor) RawJSON 

func (r BrandGetByTickerResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandLogoResolution 

type BrandGetByTickerResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetByTickerResponseBrandLogoResolution) RawJSON 

func (r BrandGetByTickerResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandSocial 

type BrandGetByTickerResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetByTickerResponseBrandSocial) RawJSON 

func (r BrandGetByTickerResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandSocial) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandGetByTickerResponseBrandStock 

type BrandGetByTickerResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandGetByTickerResponseBrandStock) RawJSON 

func (r BrandGetByTickerResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetByTickerResponseBrandStock) UnmarshalJSON 

func (r *BrandGetByTickerResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandGetParams 

type BrandGetParams struct {
	// Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
	// Cannot be used with name or ticker parameters.
	Domain string `query:"domain" api:"required" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data. Works with all three lookup methods.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandGetParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetParams) URLQuery 

func (r BrandGetParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetParams's query parameters as `url.Values`.

type BrandGetParamsForceLanguage 

type BrandGetParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandGetParamsForceLanguageAfrikaans      BrandGetParamsForceLanguage = "afrikaans"
	BrandGetParamsForceLanguageAlbanian       BrandGetParamsForceLanguage = "albanian"
	BrandGetParamsForceLanguageAmharic        BrandGetParamsForceLanguage = "amharic"
	BrandGetParamsForceLanguageArabic         BrandGetParamsForceLanguage = "arabic"
	BrandGetParamsForceLanguageArmenian       BrandGetParamsForceLanguage = "armenian"
	BrandGetParamsForceLanguageAssamese       BrandGetParamsForceLanguage = "assamese"
	BrandGetParamsForceLanguageAymara         BrandGetParamsForceLanguage = "aymara"
	BrandGetParamsForceLanguageAzeri          BrandGetParamsForceLanguage = "azeri"
	BrandGetParamsForceLanguageBasque         BrandGetParamsForceLanguage = "basque"
	BrandGetParamsForceLanguageBelarusian     BrandGetParamsForceLanguage = "belarusian"
	BrandGetParamsForceLanguageBengali        BrandGetParamsForceLanguage = "bengali"
	BrandGetParamsForceLanguageBosnian        BrandGetParamsForceLanguage = "bosnian"
	BrandGetParamsForceLanguageBulgarian      BrandGetParamsForceLanguage = "bulgarian"
	BrandGetParamsForceLanguageBurmese        BrandGetParamsForceLanguage = "burmese"
	BrandGetParamsForceLanguageCantonese      BrandGetParamsForceLanguage = "cantonese"
	BrandGetParamsForceLanguageCatalan        BrandGetParamsForceLanguage = "catalan"
	BrandGetParamsForceLanguageCebuano        BrandGetParamsForceLanguage = "cebuano"
	BrandGetParamsForceLanguageChinese        BrandGetParamsForceLanguage = "chinese"
	BrandGetParamsForceLanguageCorsican       BrandGetParamsForceLanguage = "corsican"
	BrandGetParamsForceLanguageCroatian       BrandGetParamsForceLanguage = "croatian"
	BrandGetParamsForceLanguageCzech          BrandGetParamsForceLanguage = "czech"
	BrandGetParamsForceLanguageDanish         BrandGetParamsForceLanguage = "danish"
	BrandGetParamsForceLanguageDutch          BrandGetParamsForceLanguage = "dutch"
	BrandGetParamsForceLanguageEnglish        BrandGetParamsForceLanguage = "english"
	BrandGetParamsForceLanguageEsperanto      BrandGetParamsForceLanguage = "esperanto"
	BrandGetParamsForceLanguageEstonian       BrandGetParamsForceLanguage = "estonian"
	BrandGetParamsForceLanguageFarsi          BrandGetParamsForceLanguage = "farsi"
	BrandGetParamsForceLanguageFijian         BrandGetParamsForceLanguage = "fijian"
	BrandGetParamsForceLanguageFinnish        BrandGetParamsForceLanguage = "finnish"
	BrandGetParamsForceLanguageFrench         BrandGetParamsForceLanguage = "french"
	BrandGetParamsForceLanguageGalician       BrandGetParamsForceLanguage = "galician"
	BrandGetParamsForceLanguageGeorgian       BrandGetParamsForceLanguage = "georgian"
	BrandGetParamsForceLanguageGerman         BrandGetParamsForceLanguage = "german"
	BrandGetParamsForceLanguageGreek          BrandGetParamsForceLanguage = "greek"
	BrandGetParamsForceLanguageGuarani        BrandGetParamsForceLanguage = "guarani"
	BrandGetParamsForceLanguageGujarati       BrandGetParamsForceLanguage = "gujarati"
	BrandGetParamsForceLanguageHaitianCreole  BrandGetParamsForceLanguage = "haitian-creole"
	BrandGetParamsForceLanguageHausa          BrandGetParamsForceLanguage = "hausa"
	BrandGetParamsForceLanguageHawaiian       BrandGetParamsForceLanguage = "hawaiian"
	BrandGetParamsForceLanguageHebrew         BrandGetParamsForceLanguage = "hebrew"
	BrandGetParamsForceLanguageHindi          BrandGetParamsForceLanguage = "hindi"
	BrandGetParamsForceLanguageHmong          BrandGetParamsForceLanguage = "hmong"
	BrandGetParamsForceLanguageHungarian      BrandGetParamsForceLanguage = "hungarian"
	BrandGetParamsForceLanguageIcelandic      BrandGetParamsForceLanguage = "icelandic"
	BrandGetParamsForceLanguageIgbo           BrandGetParamsForceLanguage = "igbo"
	BrandGetParamsForceLanguageIndonesian     BrandGetParamsForceLanguage = "indonesian"
	BrandGetParamsForceLanguageIrish          BrandGetParamsForceLanguage = "irish"
	BrandGetParamsForceLanguageItalian        BrandGetParamsForceLanguage = "italian"
	BrandGetParamsForceLanguageJapanese       BrandGetParamsForceLanguage = "japanese"
	BrandGetParamsForceLanguageJavanese       BrandGetParamsForceLanguage = "javanese"
	BrandGetParamsForceLanguageKannada        BrandGetParamsForceLanguage = "kannada"
	BrandGetParamsForceLanguageKazakh         BrandGetParamsForceLanguage = "kazakh"
	BrandGetParamsForceLanguageKhmer          BrandGetParamsForceLanguage = "khmer"
	BrandGetParamsForceLanguageKinyarwanda    BrandGetParamsForceLanguage = "kinyarwanda"
	BrandGetParamsForceLanguageKorean         BrandGetParamsForceLanguage = "korean"
	BrandGetParamsForceLanguageKurdish        BrandGetParamsForceLanguage = "kurdish"
	BrandGetParamsForceLanguageKyrgyz         BrandGetParamsForceLanguage = "kyrgyz"
	BrandGetParamsForceLanguageLao            BrandGetParamsForceLanguage = "lao"
	BrandGetParamsForceLanguageLatin          BrandGetParamsForceLanguage = "latin"
	BrandGetParamsForceLanguageLatvian        BrandGetParamsForceLanguage = "latvian"
	BrandGetParamsForceLanguageLingala        BrandGetParamsForceLanguage = "lingala"
	BrandGetParamsForceLanguageLithuanian     BrandGetParamsForceLanguage = "lithuanian"
	BrandGetParamsForceLanguageLuxembourgish  BrandGetParamsForceLanguage = "luxembourgish"
	BrandGetParamsForceLanguageMacedonian     BrandGetParamsForceLanguage = "macedonian"
	BrandGetParamsForceLanguageMalagasy       BrandGetParamsForceLanguage = "malagasy"
	BrandGetParamsForceLanguageMalay          BrandGetParamsForceLanguage = "malay"
	BrandGetParamsForceLanguageMalayalam      BrandGetParamsForceLanguage = "malayalam"
	BrandGetParamsForceLanguageMaltese        BrandGetParamsForceLanguage = "maltese"
	BrandGetParamsForceLanguageMaori          BrandGetParamsForceLanguage = "maori"
	BrandGetParamsForceLanguageMarathi        BrandGetParamsForceLanguage = "marathi"
	BrandGetParamsForceLanguageMongolian      BrandGetParamsForceLanguage = "mongolian"
	BrandGetParamsForceLanguageNepali         BrandGetParamsForceLanguage = "nepali"
	BrandGetParamsForceLanguageNorwegian      BrandGetParamsForceLanguage = "norwegian"
	BrandGetParamsForceLanguageOdia           BrandGetParamsForceLanguage = "odia"
	BrandGetParamsForceLanguageOromo          BrandGetParamsForceLanguage = "oromo"
	BrandGetParamsForceLanguagePashto         BrandGetParamsForceLanguage = "pashto"
	BrandGetParamsForceLanguagePidgin         BrandGetParamsForceLanguage = "pidgin"
	BrandGetParamsForceLanguagePolish         BrandGetParamsForceLanguage = "polish"
	BrandGetParamsForceLanguagePortuguese     BrandGetParamsForceLanguage = "portuguese"
	BrandGetParamsForceLanguagePunjabi        BrandGetParamsForceLanguage = "punjabi"
	BrandGetParamsForceLanguageQuechua        BrandGetParamsForceLanguage = "quechua"
	BrandGetParamsForceLanguageRomanian       BrandGetParamsForceLanguage = "romanian"
	BrandGetParamsForceLanguageRussian        BrandGetParamsForceLanguage = "russian"
	BrandGetParamsForceLanguageSamoan         BrandGetParamsForceLanguage = "samoan"
	BrandGetParamsForceLanguageScottishGaelic BrandGetParamsForceLanguage = "scottish-gaelic"
	BrandGetParamsForceLanguageSerbian        BrandGetParamsForceLanguage = "serbian"
	BrandGetParamsForceLanguageSesotho        BrandGetParamsForceLanguage = "sesotho"
	BrandGetParamsForceLanguageShona          BrandGetParamsForceLanguage = "shona"
	BrandGetParamsForceLanguageSindhi         BrandGetParamsForceLanguage = "sindhi"
	BrandGetParamsForceLanguageSinhala        BrandGetParamsForceLanguage = "sinhala"
	BrandGetParamsForceLanguageSlovak         BrandGetParamsForceLanguage = "slovak"
	BrandGetParamsForceLanguageSlovene        BrandGetParamsForceLanguage = "slovene"
	BrandGetParamsForceLanguageSomali         BrandGetParamsForceLanguage = "somali"
	BrandGetParamsForceLanguageSpanish        BrandGetParamsForceLanguage = "spanish"
	BrandGetParamsForceLanguageSundanese      BrandGetParamsForceLanguage = "sundanese"
	BrandGetParamsForceLanguageSwahili        BrandGetParamsForceLanguage = "swahili"
	BrandGetParamsForceLanguageSwedish        BrandGetParamsForceLanguage = "swedish"
	BrandGetParamsForceLanguageTagalog        BrandGetParamsForceLanguage = "tagalog"
	BrandGetParamsForceLanguageTajik          BrandGetParamsForceLanguage = "tajik"
	BrandGetParamsForceLanguageTamil          BrandGetParamsForceLanguage = "tamil"
	BrandGetParamsForceLanguageTatar          BrandGetParamsForceLanguage = "tatar"
	BrandGetParamsForceLanguageTelugu         BrandGetParamsForceLanguage = "telugu"
	BrandGetParamsForceLanguageThai           BrandGetParamsForceLanguage = "thai"
	BrandGetParamsForceLanguageTibetan        BrandGetParamsForceLanguage = "tibetan"
	BrandGetParamsForceLanguageTigrinya       BrandGetParamsForceLanguage = "tigrinya"
	BrandGetParamsForceLanguageTongan         BrandGetParamsForceLanguage = "tongan"
	BrandGetParamsForceLanguageTswana         BrandGetParamsForceLanguage = "tswana"
	BrandGetParamsForceLanguageTurkish        BrandGetParamsForceLanguage = "turkish"
	BrandGetParamsForceLanguageTurkmen        BrandGetParamsForceLanguage = "turkmen"
	BrandGetParamsForceLanguageUkrainian      BrandGetParamsForceLanguage = "ukrainian"
	BrandGetParamsForceLanguageUrdu           BrandGetParamsForceLanguage = "urdu"
	BrandGetParamsForceLanguageUyghur         BrandGetParamsForceLanguage = "uyghur"
	BrandGetParamsForceLanguageUzbek          BrandGetParamsForceLanguage = "uzbek"
	BrandGetParamsForceLanguageVietnamese     BrandGetParamsForceLanguage = "vietnamese"
	BrandGetParamsForceLanguageWelsh          BrandGetParamsForceLanguage = "welsh"
	BrandGetParamsForceLanguageWolof          BrandGetParamsForceLanguage = "wolof"
	BrandGetParamsForceLanguageXhosa          BrandGetParamsForceLanguage = "xhosa"
	BrandGetParamsForceLanguageYiddish        BrandGetParamsForceLanguage = "yiddish"
	BrandGetParamsForceLanguageYoruba         BrandGetParamsForceLanguage = "yoruba"
	BrandGetParamsForceLanguageZulu           BrandGetParamsForceLanguage = "zulu"
)

type BrandGetResponse 

type BrandGetResponse struct {
	// Detailed brand information
	Brand BrandGetResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponse) RawJSON 

func (r BrandGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponse) UnmarshalJSON 

func (r *BrandGetResponse) UnmarshalJSON(data []byte) error

type BrandGetResponseBrand 

type BrandGetResponseBrand struct {
	// Physical address of the brand
	Address BrandGetResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandGetResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandGetResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandGetResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandGetResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandGetResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandGetResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandGetResponseBrand) RawJSON 

func (r BrandGetResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrand) UnmarshalJSON 

func (r *BrandGetResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandAddress 

type BrandGetResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandGetResponseBrandAddress) RawJSON 

func (r BrandGetResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandAddress) UnmarshalJSON 

func (r *BrandGetResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandBackdrop 

type BrandGetResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandBackdrop) RawJSON 

func (r BrandGetResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandBackdropColor 

type BrandGetResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandBackdropColor) RawJSON 

func (r BrandGetResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandBackdropResolution 

type BrandGetResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetResponseBrandBackdropResolution) RawJSON 

func (r BrandGetResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandColor 

type BrandGetResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandColor) RawJSON 

func (r BrandGetResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandColor) UnmarshalJSON 

func (r *BrandGetResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandIndustries 

type BrandGetResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandGetResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandGetResponseBrandIndustries) RawJSON 

func (r BrandGetResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandIndustries) UnmarshalJSON 

func (r *BrandGetResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandIndustriesEic 

type BrandGetResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandIndustriesEic) RawJSON 

func (r BrandGetResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandGetResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandGetResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandGetResponseBrandLinks) RawJSON 

func (r BrandGetResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandLinks) UnmarshalJSON 

func (r *BrandGetResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandGetResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandLogo) RawJSON 

func (r BrandGetResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandLogoColor 

type BrandGetResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandLogoColor) RawJSON 

func (r BrandGetResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandLogoResolution 

type BrandGetResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetResponseBrandLogoResolution) RawJSON 

func (r BrandGetResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandSocial 

type BrandGetResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetResponseBrandSocial) RawJSON 

func (r BrandGetResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandSocial) UnmarshalJSON 

func (r *BrandGetResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandGetResponseBrandStock 

type BrandGetResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandGetResponseBrandStock) RawJSON 

func (r BrandGetResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetResponseBrandStock) UnmarshalJSON 

func (r *BrandGetResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedParams 

type BrandGetSimplifiedParams struct {
	// Domain name to retrieve simplified brand data for
	Domain string `query:"domain" api:"required" json:"-"`
	// Maximum age in milliseconds for cached brand data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandGetSimplifiedParams) URLQuery 

func (r BrandGetSimplifiedParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandGetSimplifiedParams's query parameters as `url.Values`.

type BrandGetSimplifiedResponse 

type BrandGetSimplifiedResponse struct {
	// Simplified brand information
	Brand BrandGetSimplifiedResponseBrand `json:"brand"`
	// HTTP status code of the response
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponse) RawJSON 

func (r BrandGetSimplifiedResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponse) UnmarshalJSON 

func (r *BrandGetSimplifiedResponse) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrand 

type BrandGetSimplifiedResponseBrand struct {
	// An array of backdrop images for the brand
	Backdrops []BrandGetSimplifiedResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandGetSimplifiedResponseBrandColor `json:"colors"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// An array of logos associated with the brand
	Logos []BrandGetSimplifiedResponseBrandLogo `json:"logos"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Backdrops   respjson.Field
		Colors      respjson.Field
		Domain      respjson.Field
		Logos       respjson.Field
		Title       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Simplified brand information

func (BrandGetSimplifiedResponseBrand) RawJSON 

func (r BrandGetSimplifiedResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrand) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrand) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandBackdrop 

type BrandGetSimplifiedResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandGetSimplifiedResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandGetSimplifiedResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponseBrandBackdrop) RawJSON 

func (r BrandGetSimplifiedResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandBackdropColor 

type BrandGetSimplifiedResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponseBrandBackdropColor) RawJSON 

func (r BrandGetSimplifiedResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandBackdropResolution 

type BrandGetSimplifiedResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandGetSimplifiedResponseBrandBackdropResolution) RawJSON 

func (r BrandGetSimplifiedResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandColor 

type BrandGetSimplifiedResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponseBrandColor) RawJSON 

func (r BrandGetSimplifiedResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandColor) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandColor) UnmarshalJSON(data []byte) error
type BrandGetSimplifiedResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandGetSimplifiedResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandGetSimplifiedResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponseBrandLogo) RawJSON 

func (r BrandGetSimplifiedResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandLogo) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandLogoColor 

type BrandGetSimplifiedResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandGetSimplifiedResponseBrandLogoColor) RawJSON 

func (r BrandGetSimplifiedResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandGetSimplifiedResponseBrandLogoResolution 

type BrandGetSimplifiedResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandGetSimplifiedResponseBrandLogoResolution) RawJSON 

func (r BrandGetSimplifiedResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandGetSimplifiedResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandGetSimplifiedResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionParams 

type BrandIdentifyFromTransactionParams struct {
	// Transaction information to identify the brand
	TransactionInfo string `query:"transaction_info" api:"required" json:"-"`
	// Optional city name to prioritize when searching for the brand.
	City param.Opt[string] `query:"city,omitzero" json:"-"`
	// When set to true, the API will perform an additional verification steps to
	// ensure the identified brand matches the transaction with high confidence.
	HighConfidenceOnly param.Opt[bool] `query:"high_confidence_only,omitzero" json:"-"`
	// Optional parameter to optimize the API call for maximum speed. When set to true,
	// the API will skip time-consuming operations for faster response at the cost of
	// less comprehensive data.
	MaxSpeed param.Opt[bool] `query:"maxSpeed,omitzero" json:"-"`
	// Optional Merchant Category Code (MCC) to help identify the business
	// category/industry.
	Mcc param.Opt[string] `query:"mcc,omitzero" json:"-"`
	// Optional phone number from the transaction to help verify brand match.
	Phone param.Opt[float64] `query:"phone,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional country code (GL parameter) to specify the country. This affects the
	// geographic location used for search queries.
	//
	// Any of "ad", "ae", "af", "ag", "ai", "al", "am", "an", "ao", "aq", "ar", "as",
	// "at", "au", "aw", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj",
	// "bm", "bn", "bo", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "cc", "cd",
	// "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cu", "cv", "cx",
	// "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "er",
	// "es", "et", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf",
	// "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy",
	// "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "in", "io", "iq", "ir",
	// "is", "it", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "km", "kn", "kp", "kr",
	// "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv",
	// "ly", "ma", "mc", "md", "mg", "mh", "mk", "ml", "mm", "mn", "mo", "mp", "mq",
	// "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf",
	// "ng", "ni", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg",
	// "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "re", "ro",
	// "rs", "ru", "rw", "sa", "sb", "sc", "sd", "se", "sg", "sh", "si", "sj", "sk",
	// "sl", "sm", "sn", "so", "sr", "st", "sv", "sy", "sz", "tc", "td", "tf", "tg",
	// "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua",
	// "ug", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "wf",
	// "ws", "ye", "yt", "za", "zm", "zw".
	CountryGl BrandIdentifyFromTransactionParamsCountryGl `query:"country_gl,omitzero" json:"-"`
	// Optional parameter to force the language of the retrieved brand data.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	ForceLanguage BrandIdentifyFromTransactionParamsForceLanguage `query:"force_language,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BrandIdentifyFromTransactionParams) URLQuery 

func (r BrandIdentifyFromTransactionParams) URLQuery() (v url.Values, err error)

URLQuery serializes BrandIdentifyFromTransactionParams's query parameters as `url.Values`.

type BrandIdentifyFromTransactionParamsCountryGl 

type BrandIdentifyFromTransactionParamsCountryGl string

Optional country code (GL parameter) to specify the country. This affects the geographic location used for search queries. 

const (
	BrandIdentifyFromTransactionParamsCountryGlAd BrandIdentifyFromTransactionParamsCountryGl = "ad"
	BrandIdentifyFromTransactionParamsCountryGlAe BrandIdentifyFromTransactionParamsCountryGl = "ae"
	BrandIdentifyFromTransactionParamsCountryGlAf BrandIdentifyFromTransactionParamsCountryGl = "af"
	BrandIdentifyFromTransactionParamsCountryGlAg BrandIdentifyFromTransactionParamsCountryGl = "ag"
	BrandIdentifyFromTransactionParamsCountryGlAI BrandIdentifyFromTransactionParamsCountryGl = "ai"
	BrandIdentifyFromTransactionParamsCountryGlAl BrandIdentifyFromTransactionParamsCountryGl = "al"
	BrandIdentifyFromTransactionParamsCountryGlAm BrandIdentifyFromTransactionParamsCountryGl = "am"
	BrandIdentifyFromTransactionParamsCountryGlAn BrandIdentifyFromTransactionParamsCountryGl = "an"
	BrandIdentifyFromTransactionParamsCountryGlAo BrandIdentifyFromTransactionParamsCountryGl = "ao"
	BrandIdentifyFromTransactionParamsCountryGlAq BrandIdentifyFromTransactionParamsCountryGl = "aq"
	BrandIdentifyFromTransactionParamsCountryGlAr BrandIdentifyFromTransactionParamsCountryGl = "ar"
	BrandIdentifyFromTransactionParamsCountryGlAs BrandIdentifyFromTransactionParamsCountryGl = "as"
	BrandIdentifyFromTransactionParamsCountryGlAt BrandIdentifyFromTransactionParamsCountryGl = "at"
	BrandIdentifyFromTransactionParamsCountryGlAu BrandIdentifyFromTransactionParamsCountryGl = "au"
	BrandIdentifyFromTransactionParamsCountryGlAw BrandIdentifyFromTransactionParamsCountryGl = "aw"
	BrandIdentifyFromTransactionParamsCountryGlAz BrandIdentifyFromTransactionParamsCountryGl = "az"
	BrandIdentifyFromTransactionParamsCountryGlBa BrandIdentifyFromTransactionParamsCountryGl = "ba"
	BrandIdentifyFromTransactionParamsCountryGlBb BrandIdentifyFromTransactionParamsCountryGl = "bb"
	BrandIdentifyFromTransactionParamsCountryGlBd BrandIdentifyFromTransactionParamsCountryGl = "bd"
	BrandIdentifyFromTransactionParamsCountryGlBe BrandIdentifyFromTransactionParamsCountryGl = "be"
	BrandIdentifyFromTransactionParamsCountryGlBf BrandIdentifyFromTransactionParamsCountryGl = "bf"
	BrandIdentifyFromTransactionParamsCountryGlBg BrandIdentifyFromTransactionParamsCountryGl = "bg"
	BrandIdentifyFromTransactionParamsCountryGlBh BrandIdentifyFromTransactionParamsCountryGl = "bh"
	BrandIdentifyFromTransactionParamsCountryGlBi BrandIdentifyFromTransactionParamsCountryGl = "bi"
	BrandIdentifyFromTransactionParamsCountryGlBj BrandIdentifyFromTransactionParamsCountryGl = "bj"
	BrandIdentifyFromTransactionParamsCountryGlBm BrandIdentifyFromTransactionParamsCountryGl = "bm"
	BrandIdentifyFromTransactionParamsCountryGlBn BrandIdentifyFromTransactionParamsCountryGl = "bn"
	BrandIdentifyFromTransactionParamsCountryGlBo BrandIdentifyFromTransactionParamsCountryGl = "bo"
	BrandIdentifyFromTransactionParamsCountryGlBr BrandIdentifyFromTransactionParamsCountryGl = "br"
	BrandIdentifyFromTransactionParamsCountryGlBs BrandIdentifyFromTransactionParamsCountryGl = "bs"
	BrandIdentifyFromTransactionParamsCountryGlBt BrandIdentifyFromTransactionParamsCountryGl = "bt"
	BrandIdentifyFromTransactionParamsCountryGlBv BrandIdentifyFromTransactionParamsCountryGl = "bv"
	BrandIdentifyFromTransactionParamsCountryGlBw BrandIdentifyFromTransactionParamsCountryGl = "bw"
	BrandIdentifyFromTransactionParamsCountryGlBy BrandIdentifyFromTransactionParamsCountryGl = "by"
	BrandIdentifyFromTransactionParamsCountryGlBz BrandIdentifyFromTransactionParamsCountryGl = "bz"
	BrandIdentifyFromTransactionParamsCountryGlCa BrandIdentifyFromTransactionParamsCountryGl = "ca"
	BrandIdentifyFromTransactionParamsCountryGlCc BrandIdentifyFromTransactionParamsCountryGl = "cc"
	BrandIdentifyFromTransactionParamsCountryGlCd BrandIdentifyFromTransactionParamsCountryGl = "cd"
	BrandIdentifyFromTransactionParamsCountryGlCf BrandIdentifyFromTransactionParamsCountryGl = "cf"
	BrandIdentifyFromTransactionParamsCountryGlCg BrandIdentifyFromTransactionParamsCountryGl = "cg"
	BrandIdentifyFromTransactionParamsCountryGlCh BrandIdentifyFromTransactionParamsCountryGl = "ch"
	BrandIdentifyFromTransactionParamsCountryGlCi BrandIdentifyFromTransactionParamsCountryGl = "ci"
	BrandIdentifyFromTransactionParamsCountryGlCk BrandIdentifyFromTransactionParamsCountryGl = "ck"
	BrandIdentifyFromTransactionParamsCountryGlCl BrandIdentifyFromTransactionParamsCountryGl = "cl"
	BrandIdentifyFromTransactionParamsCountryGlCm BrandIdentifyFromTransactionParamsCountryGl = "cm"
	BrandIdentifyFromTransactionParamsCountryGlCn BrandIdentifyFromTransactionParamsCountryGl = "cn"
	BrandIdentifyFromTransactionParamsCountryGlCo BrandIdentifyFromTransactionParamsCountryGl = "co"
	BrandIdentifyFromTransactionParamsCountryGlCr BrandIdentifyFromTransactionParamsCountryGl = "cr"
	BrandIdentifyFromTransactionParamsCountryGlCu BrandIdentifyFromTransactionParamsCountryGl = "cu"
	BrandIdentifyFromTransactionParamsCountryGlCv BrandIdentifyFromTransactionParamsCountryGl = "cv"
	BrandIdentifyFromTransactionParamsCountryGlCx BrandIdentifyFromTransactionParamsCountryGl = "cx"
	BrandIdentifyFromTransactionParamsCountryGlCy BrandIdentifyFromTransactionParamsCountryGl = "cy"
	BrandIdentifyFromTransactionParamsCountryGlCz BrandIdentifyFromTransactionParamsCountryGl = "cz"
	BrandIdentifyFromTransactionParamsCountryGlDe BrandIdentifyFromTransactionParamsCountryGl = "de"
	BrandIdentifyFromTransactionParamsCountryGlDj BrandIdentifyFromTransactionParamsCountryGl = "dj"
	BrandIdentifyFromTransactionParamsCountryGlDk BrandIdentifyFromTransactionParamsCountryGl = "dk"
	BrandIdentifyFromTransactionParamsCountryGlDm BrandIdentifyFromTransactionParamsCountryGl = "dm"
	BrandIdentifyFromTransactionParamsCountryGlDo BrandIdentifyFromTransactionParamsCountryGl = "do"
	BrandIdentifyFromTransactionParamsCountryGlDz BrandIdentifyFromTransactionParamsCountryGl = "dz"
	BrandIdentifyFromTransactionParamsCountryGlEc BrandIdentifyFromTransactionParamsCountryGl = "ec"
	BrandIdentifyFromTransactionParamsCountryGlEe BrandIdentifyFromTransactionParamsCountryGl = "ee"
	BrandIdentifyFromTransactionParamsCountryGlEg BrandIdentifyFromTransactionParamsCountryGl = "eg"
	BrandIdentifyFromTransactionParamsCountryGlEh BrandIdentifyFromTransactionParamsCountryGl = "eh"
	BrandIdentifyFromTransactionParamsCountryGlEr BrandIdentifyFromTransactionParamsCountryGl = "er"
	BrandIdentifyFromTransactionParamsCountryGlEs BrandIdentifyFromTransactionParamsCountryGl = "es"
	BrandIdentifyFromTransactionParamsCountryGlEt BrandIdentifyFromTransactionParamsCountryGl = "et"
	BrandIdentifyFromTransactionParamsCountryGlFi BrandIdentifyFromTransactionParamsCountryGl = "fi"
	BrandIdentifyFromTransactionParamsCountryGlFj BrandIdentifyFromTransactionParamsCountryGl = "fj"
	BrandIdentifyFromTransactionParamsCountryGlFk BrandIdentifyFromTransactionParamsCountryGl = "fk"
	BrandIdentifyFromTransactionParamsCountryGlFm BrandIdentifyFromTransactionParamsCountryGl = "fm"
	BrandIdentifyFromTransactionParamsCountryGlFo BrandIdentifyFromTransactionParamsCountryGl = "fo"
	BrandIdentifyFromTransactionParamsCountryGlFr BrandIdentifyFromTransactionParamsCountryGl = "fr"
	BrandIdentifyFromTransactionParamsCountryGlGa BrandIdentifyFromTransactionParamsCountryGl = "ga"
	BrandIdentifyFromTransactionParamsCountryGlGB BrandIdentifyFromTransactionParamsCountryGl = "gb"
	BrandIdentifyFromTransactionParamsCountryGlGd BrandIdentifyFromTransactionParamsCountryGl = "gd"
	BrandIdentifyFromTransactionParamsCountryGlGe BrandIdentifyFromTransactionParamsCountryGl = "ge"
	BrandIdentifyFromTransactionParamsCountryGlGf BrandIdentifyFromTransactionParamsCountryGl = "gf"
	BrandIdentifyFromTransactionParamsCountryGlGh BrandIdentifyFromTransactionParamsCountryGl = "gh"
	BrandIdentifyFromTransactionParamsCountryGlGi BrandIdentifyFromTransactionParamsCountryGl = "gi"
	BrandIdentifyFromTransactionParamsCountryGlGl BrandIdentifyFromTransactionParamsCountryGl = "gl"
	BrandIdentifyFromTransactionParamsCountryGlGm BrandIdentifyFromTransactionParamsCountryGl = "gm"
	BrandIdentifyFromTransactionParamsCountryGlGn BrandIdentifyFromTransactionParamsCountryGl = "gn"
	BrandIdentifyFromTransactionParamsCountryGlGp BrandIdentifyFromTransactionParamsCountryGl = "gp"
	BrandIdentifyFromTransactionParamsCountryGlGq BrandIdentifyFromTransactionParamsCountryGl = "gq"
	BrandIdentifyFromTransactionParamsCountryGlGr BrandIdentifyFromTransactionParamsCountryGl = "gr"
	BrandIdentifyFromTransactionParamsCountryGlGs BrandIdentifyFromTransactionParamsCountryGl = "gs"
	BrandIdentifyFromTransactionParamsCountryGlGt BrandIdentifyFromTransactionParamsCountryGl = "gt"
	BrandIdentifyFromTransactionParamsCountryGlGu BrandIdentifyFromTransactionParamsCountryGl = "gu"
	BrandIdentifyFromTransactionParamsCountryGlGw BrandIdentifyFromTransactionParamsCountryGl = "gw"
	BrandIdentifyFromTransactionParamsCountryGlGy BrandIdentifyFromTransactionParamsCountryGl = "gy"
	BrandIdentifyFromTransactionParamsCountryGlHk BrandIdentifyFromTransactionParamsCountryGl = "hk"
	BrandIdentifyFromTransactionParamsCountryGlHm BrandIdentifyFromTransactionParamsCountryGl = "hm"
	BrandIdentifyFromTransactionParamsCountryGlHn BrandIdentifyFromTransactionParamsCountryGl = "hn"
	BrandIdentifyFromTransactionParamsCountryGlHr BrandIdentifyFromTransactionParamsCountryGl = "hr"
	BrandIdentifyFromTransactionParamsCountryGlHt BrandIdentifyFromTransactionParamsCountryGl = "ht"
	BrandIdentifyFromTransactionParamsCountryGlHu BrandIdentifyFromTransactionParamsCountryGl = "hu"
	BrandIdentifyFromTransactionParamsCountryGlID BrandIdentifyFromTransactionParamsCountryGl = "id"
	BrandIdentifyFromTransactionParamsCountryGlIe BrandIdentifyFromTransactionParamsCountryGl = "ie"
	BrandIdentifyFromTransactionParamsCountryGlIl BrandIdentifyFromTransactionParamsCountryGl = "il"
	BrandIdentifyFromTransactionParamsCountryGlIn BrandIdentifyFromTransactionParamsCountryGl = "in"
	BrandIdentifyFromTransactionParamsCountryGlIo BrandIdentifyFromTransactionParamsCountryGl = "io"
	BrandIdentifyFromTransactionParamsCountryGlIq BrandIdentifyFromTransactionParamsCountryGl = "iq"
	BrandIdentifyFromTransactionParamsCountryGlIr BrandIdentifyFromTransactionParamsCountryGl = "ir"
	BrandIdentifyFromTransactionParamsCountryGlIs BrandIdentifyFromTransactionParamsCountryGl = "is"
	BrandIdentifyFromTransactionParamsCountryGlIt BrandIdentifyFromTransactionParamsCountryGl = "it"
	BrandIdentifyFromTransactionParamsCountryGlJm BrandIdentifyFromTransactionParamsCountryGl = "jm"
	BrandIdentifyFromTransactionParamsCountryGlJo BrandIdentifyFromTransactionParamsCountryGl = "jo"
	BrandIdentifyFromTransactionParamsCountryGlJp BrandIdentifyFromTransactionParamsCountryGl = "jp"
	BrandIdentifyFromTransactionParamsCountryGlKe BrandIdentifyFromTransactionParamsCountryGl = "ke"
	BrandIdentifyFromTransactionParamsCountryGlKg BrandIdentifyFromTransactionParamsCountryGl = "kg"
	BrandIdentifyFromTransactionParamsCountryGlKh BrandIdentifyFromTransactionParamsCountryGl = "kh"
	BrandIdentifyFromTransactionParamsCountryGlKi BrandIdentifyFromTransactionParamsCountryGl = "ki"
	BrandIdentifyFromTransactionParamsCountryGlKm BrandIdentifyFromTransactionParamsCountryGl = "km"
	BrandIdentifyFromTransactionParamsCountryGlKn BrandIdentifyFromTransactionParamsCountryGl = "kn"
	BrandIdentifyFromTransactionParamsCountryGlKp BrandIdentifyFromTransactionParamsCountryGl = "kp"
	BrandIdentifyFromTransactionParamsCountryGlKr BrandIdentifyFromTransactionParamsCountryGl = "kr"
	BrandIdentifyFromTransactionParamsCountryGlKw BrandIdentifyFromTransactionParamsCountryGl = "kw"
	BrandIdentifyFromTransactionParamsCountryGlKy BrandIdentifyFromTransactionParamsCountryGl = "ky"
	BrandIdentifyFromTransactionParamsCountryGlKz BrandIdentifyFromTransactionParamsCountryGl = "kz"
	BrandIdentifyFromTransactionParamsCountryGlLa BrandIdentifyFromTransactionParamsCountryGl = "la"
	BrandIdentifyFromTransactionParamsCountryGlLb BrandIdentifyFromTransactionParamsCountryGl = "lb"
	BrandIdentifyFromTransactionParamsCountryGlLc BrandIdentifyFromTransactionParamsCountryGl = "lc"
	BrandIdentifyFromTransactionParamsCountryGlLi BrandIdentifyFromTransactionParamsCountryGl = "li"
	BrandIdentifyFromTransactionParamsCountryGlLk BrandIdentifyFromTransactionParamsCountryGl = "lk"
	BrandIdentifyFromTransactionParamsCountryGlLr BrandIdentifyFromTransactionParamsCountryGl = "lr"
	BrandIdentifyFromTransactionParamsCountryGlLs BrandIdentifyFromTransactionParamsCountryGl = "ls"
	BrandIdentifyFromTransactionParamsCountryGlLt BrandIdentifyFromTransactionParamsCountryGl = "lt"
	BrandIdentifyFromTransactionParamsCountryGlLu BrandIdentifyFromTransactionParamsCountryGl = "lu"
	BrandIdentifyFromTransactionParamsCountryGlLv BrandIdentifyFromTransactionParamsCountryGl = "lv"
	BrandIdentifyFromTransactionParamsCountryGlLy BrandIdentifyFromTransactionParamsCountryGl = "ly"
	BrandIdentifyFromTransactionParamsCountryGlMa BrandIdentifyFromTransactionParamsCountryGl = "ma"
	BrandIdentifyFromTransactionParamsCountryGlMc BrandIdentifyFromTransactionParamsCountryGl = "mc"
	BrandIdentifyFromTransactionParamsCountryGlMd BrandIdentifyFromTransactionParamsCountryGl = "md"
	BrandIdentifyFromTransactionParamsCountryGlMg BrandIdentifyFromTransactionParamsCountryGl = "mg"
	BrandIdentifyFromTransactionParamsCountryGlMh BrandIdentifyFromTransactionParamsCountryGl = "mh"
	BrandIdentifyFromTransactionParamsCountryGlMk BrandIdentifyFromTransactionParamsCountryGl = "mk"
	BrandIdentifyFromTransactionParamsCountryGlMl BrandIdentifyFromTransactionParamsCountryGl = "ml"
	BrandIdentifyFromTransactionParamsCountryGlMm BrandIdentifyFromTransactionParamsCountryGl = "mm"
	BrandIdentifyFromTransactionParamsCountryGlMn BrandIdentifyFromTransactionParamsCountryGl = "mn"
	BrandIdentifyFromTransactionParamsCountryGlMo BrandIdentifyFromTransactionParamsCountryGl = "mo"
	BrandIdentifyFromTransactionParamsCountryGlMp BrandIdentifyFromTransactionParamsCountryGl = "mp"
	BrandIdentifyFromTransactionParamsCountryGlMq BrandIdentifyFromTransactionParamsCountryGl = "mq"
	BrandIdentifyFromTransactionParamsCountryGlMr BrandIdentifyFromTransactionParamsCountryGl = "mr"
	BrandIdentifyFromTransactionParamsCountryGlMs BrandIdentifyFromTransactionParamsCountryGl = "ms"
	BrandIdentifyFromTransactionParamsCountryGlMt BrandIdentifyFromTransactionParamsCountryGl = "mt"
	BrandIdentifyFromTransactionParamsCountryGlMu BrandIdentifyFromTransactionParamsCountryGl = "mu"
	BrandIdentifyFromTransactionParamsCountryGlMv BrandIdentifyFromTransactionParamsCountryGl = "mv"
	BrandIdentifyFromTransactionParamsCountryGlMw BrandIdentifyFromTransactionParamsCountryGl = "mw"
	BrandIdentifyFromTransactionParamsCountryGlMx BrandIdentifyFromTransactionParamsCountryGl = "mx"
	BrandIdentifyFromTransactionParamsCountryGlMy BrandIdentifyFromTransactionParamsCountryGl = "my"
	BrandIdentifyFromTransactionParamsCountryGlMz BrandIdentifyFromTransactionParamsCountryGl = "mz"
	BrandIdentifyFromTransactionParamsCountryGlNa BrandIdentifyFromTransactionParamsCountryGl = "na"
	BrandIdentifyFromTransactionParamsCountryGlNc BrandIdentifyFromTransactionParamsCountryGl = "nc"
	BrandIdentifyFromTransactionParamsCountryGlNe BrandIdentifyFromTransactionParamsCountryGl = "ne"
	BrandIdentifyFromTransactionParamsCountryGlNf BrandIdentifyFromTransactionParamsCountryGl = "nf"
	BrandIdentifyFromTransactionParamsCountryGlNg BrandIdentifyFromTransactionParamsCountryGl = "ng"
	BrandIdentifyFromTransactionParamsCountryGlNi BrandIdentifyFromTransactionParamsCountryGl = "ni"
	BrandIdentifyFromTransactionParamsCountryGlNl BrandIdentifyFromTransactionParamsCountryGl = "nl"
	BrandIdentifyFromTransactionParamsCountryGlNo BrandIdentifyFromTransactionParamsCountryGl = "no"
	BrandIdentifyFromTransactionParamsCountryGlNp BrandIdentifyFromTransactionParamsCountryGl = "np"
	BrandIdentifyFromTransactionParamsCountryGlNr BrandIdentifyFromTransactionParamsCountryGl = "nr"
	BrandIdentifyFromTransactionParamsCountryGlNu BrandIdentifyFromTransactionParamsCountryGl = "nu"
	BrandIdentifyFromTransactionParamsCountryGlNz BrandIdentifyFromTransactionParamsCountryGl = "nz"
	BrandIdentifyFromTransactionParamsCountryGlOm BrandIdentifyFromTransactionParamsCountryGl = "om"
	BrandIdentifyFromTransactionParamsCountryGlPa BrandIdentifyFromTransactionParamsCountryGl = "pa"
	BrandIdentifyFromTransactionParamsCountryGlPe BrandIdentifyFromTransactionParamsCountryGl = "pe"
	BrandIdentifyFromTransactionParamsCountryGlPf BrandIdentifyFromTransactionParamsCountryGl = "pf"
	BrandIdentifyFromTransactionParamsCountryGlPg BrandIdentifyFromTransactionParamsCountryGl = "pg"
	BrandIdentifyFromTransactionParamsCountryGlPh BrandIdentifyFromTransactionParamsCountryGl = "ph"
	BrandIdentifyFromTransactionParamsCountryGlPk BrandIdentifyFromTransactionParamsCountryGl = "pk"
	BrandIdentifyFromTransactionParamsCountryGlPl BrandIdentifyFromTransactionParamsCountryGl = "pl"
	BrandIdentifyFromTransactionParamsCountryGlPm BrandIdentifyFromTransactionParamsCountryGl = "pm"
	BrandIdentifyFromTransactionParamsCountryGlPn BrandIdentifyFromTransactionParamsCountryGl = "pn"
	BrandIdentifyFromTransactionParamsCountryGlPr BrandIdentifyFromTransactionParamsCountryGl = "pr"
	BrandIdentifyFromTransactionParamsCountryGlPs BrandIdentifyFromTransactionParamsCountryGl = "ps"
	BrandIdentifyFromTransactionParamsCountryGlPt BrandIdentifyFromTransactionParamsCountryGl = "pt"
	BrandIdentifyFromTransactionParamsCountryGlPw BrandIdentifyFromTransactionParamsCountryGl = "pw"
	BrandIdentifyFromTransactionParamsCountryGlPy BrandIdentifyFromTransactionParamsCountryGl = "py"
	BrandIdentifyFromTransactionParamsCountryGlQa BrandIdentifyFromTransactionParamsCountryGl = "qa"
	BrandIdentifyFromTransactionParamsCountryGlRe BrandIdentifyFromTransactionParamsCountryGl = "re"
	BrandIdentifyFromTransactionParamsCountryGlRo BrandIdentifyFromTransactionParamsCountryGl = "ro"
	BrandIdentifyFromTransactionParamsCountryGlRs BrandIdentifyFromTransactionParamsCountryGl = "rs"
	BrandIdentifyFromTransactionParamsCountryGlRu BrandIdentifyFromTransactionParamsCountryGl = "ru"
	BrandIdentifyFromTransactionParamsCountryGlRw BrandIdentifyFromTransactionParamsCountryGl = "rw"
	BrandIdentifyFromTransactionParamsCountryGlSa BrandIdentifyFromTransactionParamsCountryGl = "sa"
	BrandIdentifyFromTransactionParamsCountryGlSb BrandIdentifyFromTransactionParamsCountryGl = "sb"
	BrandIdentifyFromTransactionParamsCountryGlSc BrandIdentifyFromTransactionParamsCountryGl = "sc"
	BrandIdentifyFromTransactionParamsCountryGlSd BrandIdentifyFromTransactionParamsCountryGl = "sd"
	BrandIdentifyFromTransactionParamsCountryGlSe BrandIdentifyFromTransactionParamsCountryGl = "se"
	BrandIdentifyFromTransactionParamsCountryGlSg BrandIdentifyFromTransactionParamsCountryGl = "sg"
	BrandIdentifyFromTransactionParamsCountryGlSh BrandIdentifyFromTransactionParamsCountryGl = "sh"
	BrandIdentifyFromTransactionParamsCountryGlSi BrandIdentifyFromTransactionParamsCountryGl = "si"
	BrandIdentifyFromTransactionParamsCountryGlSj BrandIdentifyFromTransactionParamsCountryGl = "sj"
	BrandIdentifyFromTransactionParamsCountryGlSk BrandIdentifyFromTransactionParamsCountryGl = "sk"
	BrandIdentifyFromTransactionParamsCountryGlSl BrandIdentifyFromTransactionParamsCountryGl = "sl"
	BrandIdentifyFromTransactionParamsCountryGlSm BrandIdentifyFromTransactionParamsCountryGl = "sm"
	BrandIdentifyFromTransactionParamsCountryGlSn BrandIdentifyFromTransactionParamsCountryGl = "sn"
	BrandIdentifyFromTransactionParamsCountryGlSo BrandIdentifyFromTransactionParamsCountryGl = "so"
	BrandIdentifyFromTransactionParamsCountryGlSr BrandIdentifyFromTransactionParamsCountryGl = "sr"
	BrandIdentifyFromTransactionParamsCountryGlSt BrandIdentifyFromTransactionParamsCountryGl = "st"
	BrandIdentifyFromTransactionParamsCountryGlSv BrandIdentifyFromTransactionParamsCountryGl = "sv"
	BrandIdentifyFromTransactionParamsCountryGlSy BrandIdentifyFromTransactionParamsCountryGl = "sy"
	BrandIdentifyFromTransactionParamsCountryGlSz BrandIdentifyFromTransactionParamsCountryGl = "sz"
	BrandIdentifyFromTransactionParamsCountryGlTc BrandIdentifyFromTransactionParamsCountryGl = "tc"
	BrandIdentifyFromTransactionParamsCountryGlTd BrandIdentifyFromTransactionParamsCountryGl = "td"
	BrandIdentifyFromTransactionParamsCountryGlTf BrandIdentifyFromTransactionParamsCountryGl = "tf"
	BrandIdentifyFromTransactionParamsCountryGlTg BrandIdentifyFromTransactionParamsCountryGl = "tg"
	BrandIdentifyFromTransactionParamsCountryGlTh BrandIdentifyFromTransactionParamsCountryGl = "th"
	BrandIdentifyFromTransactionParamsCountryGlTj BrandIdentifyFromTransactionParamsCountryGl = "tj"
	BrandIdentifyFromTransactionParamsCountryGlTk BrandIdentifyFromTransactionParamsCountryGl = "tk"
	BrandIdentifyFromTransactionParamsCountryGlTl BrandIdentifyFromTransactionParamsCountryGl = "tl"
	BrandIdentifyFromTransactionParamsCountryGlTm BrandIdentifyFromTransactionParamsCountryGl = "tm"
	BrandIdentifyFromTransactionParamsCountryGlTn BrandIdentifyFromTransactionParamsCountryGl = "tn"
	BrandIdentifyFromTransactionParamsCountryGlTo BrandIdentifyFromTransactionParamsCountryGl = "to"
	BrandIdentifyFromTransactionParamsCountryGlTr BrandIdentifyFromTransactionParamsCountryGl = "tr"
	BrandIdentifyFromTransactionParamsCountryGlTt BrandIdentifyFromTransactionParamsCountryGl = "tt"
	BrandIdentifyFromTransactionParamsCountryGlTv BrandIdentifyFromTransactionParamsCountryGl = "tv"
	BrandIdentifyFromTransactionParamsCountryGlTw BrandIdentifyFromTransactionParamsCountryGl = "tw"
	BrandIdentifyFromTransactionParamsCountryGlTz BrandIdentifyFromTransactionParamsCountryGl = "tz"
	BrandIdentifyFromTransactionParamsCountryGlUa BrandIdentifyFromTransactionParamsCountryGl = "ua"
	BrandIdentifyFromTransactionParamsCountryGlUg BrandIdentifyFromTransactionParamsCountryGl = "ug"
	BrandIdentifyFromTransactionParamsCountryGlUm BrandIdentifyFromTransactionParamsCountryGl = "um"
	BrandIdentifyFromTransactionParamsCountryGlUs BrandIdentifyFromTransactionParamsCountryGl = "us"
	BrandIdentifyFromTransactionParamsCountryGlUy BrandIdentifyFromTransactionParamsCountryGl = "uy"
	BrandIdentifyFromTransactionParamsCountryGlUz BrandIdentifyFromTransactionParamsCountryGl = "uz"
	BrandIdentifyFromTransactionParamsCountryGlVa BrandIdentifyFromTransactionParamsCountryGl = "va"
	BrandIdentifyFromTransactionParamsCountryGlVc BrandIdentifyFromTransactionParamsCountryGl = "vc"
	BrandIdentifyFromTransactionParamsCountryGlVe BrandIdentifyFromTransactionParamsCountryGl = "ve"
	BrandIdentifyFromTransactionParamsCountryGlVg BrandIdentifyFromTransactionParamsCountryGl = "vg"
	BrandIdentifyFromTransactionParamsCountryGlVi BrandIdentifyFromTransactionParamsCountryGl = "vi"
	BrandIdentifyFromTransactionParamsCountryGlVn BrandIdentifyFromTransactionParamsCountryGl = "vn"
	BrandIdentifyFromTransactionParamsCountryGlVu BrandIdentifyFromTransactionParamsCountryGl = "vu"
	BrandIdentifyFromTransactionParamsCountryGlWf BrandIdentifyFromTransactionParamsCountryGl = "wf"
	BrandIdentifyFromTransactionParamsCountryGlWs BrandIdentifyFromTransactionParamsCountryGl = "ws"
	BrandIdentifyFromTransactionParamsCountryGlYe BrandIdentifyFromTransactionParamsCountryGl = "ye"
	BrandIdentifyFromTransactionParamsCountryGlYt BrandIdentifyFromTransactionParamsCountryGl = "yt"
	BrandIdentifyFromTransactionParamsCountryGlZa BrandIdentifyFromTransactionParamsCountryGl = "za"
	BrandIdentifyFromTransactionParamsCountryGlZm BrandIdentifyFromTransactionParamsCountryGl = "zm"
	BrandIdentifyFromTransactionParamsCountryGlZw BrandIdentifyFromTransactionParamsCountryGl = "zw"
)

type BrandIdentifyFromTransactionParamsForceLanguage 

type BrandIdentifyFromTransactionParamsForceLanguage string

Optional parameter to force the language of the retrieved brand data. 

const (
	BrandIdentifyFromTransactionParamsForceLanguageAfrikaans      BrandIdentifyFromTransactionParamsForceLanguage = "afrikaans"
	BrandIdentifyFromTransactionParamsForceLanguageAlbanian       BrandIdentifyFromTransactionParamsForceLanguage = "albanian"
	BrandIdentifyFromTransactionParamsForceLanguageAmharic        BrandIdentifyFromTransactionParamsForceLanguage = "amharic"
	BrandIdentifyFromTransactionParamsForceLanguageArabic         BrandIdentifyFromTransactionParamsForceLanguage = "arabic"
	BrandIdentifyFromTransactionParamsForceLanguageArmenian       BrandIdentifyFromTransactionParamsForceLanguage = "armenian"
	BrandIdentifyFromTransactionParamsForceLanguageAssamese       BrandIdentifyFromTransactionParamsForceLanguage = "assamese"
	BrandIdentifyFromTransactionParamsForceLanguageAymara         BrandIdentifyFromTransactionParamsForceLanguage = "aymara"
	BrandIdentifyFromTransactionParamsForceLanguageAzeri          BrandIdentifyFromTransactionParamsForceLanguage = "azeri"
	BrandIdentifyFromTransactionParamsForceLanguageBasque         BrandIdentifyFromTransactionParamsForceLanguage = "basque"
	BrandIdentifyFromTransactionParamsForceLanguageBelarusian     BrandIdentifyFromTransactionParamsForceLanguage = "belarusian"
	BrandIdentifyFromTransactionParamsForceLanguageBengali        BrandIdentifyFromTransactionParamsForceLanguage = "bengali"
	BrandIdentifyFromTransactionParamsForceLanguageBosnian        BrandIdentifyFromTransactionParamsForceLanguage = "bosnian"
	BrandIdentifyFromTransactionParamsForceLanguageBulgarian      BrandIdentifyFromTransactionParamsForceLanguage = "bulgarian"
	BrandIdentifyFromTransactionParamsForceLanguageBurmese        BrandIdentifyFromTransactionParamsForceLanguage = "burmese"
	BrandIdentifyFromTransactionParamsForceLanguageCantonese      BrandIdentifyFromTransactionParamsForceLanguage = "cantonese"
	BrandIdentifyFromTransactionParamsForceLanguageCatalan        BrandIdentifyFromTransactionParamsForceLanguage = "catalan"
	BrandIdentifyFromTransactionParamsForceLanguageCebuano        BrandIdentifyFromTransactionParamsForceLanguage = "cebuano"
	BrandIdentifyFromTransactionParamsForceLanguageChinese        BrandIdentifyFromTransactionParamsForceLanguage = "chinese"
	BrandIdentifyFromTransactionParamsForceLanguageCorsican       BrandIdentifyFromTransactionParamsForceLanguage = "corsican"
	BrandIdentifyFromTransactionParamsForceLanguageCroatian       BrandIdentifyFromTransactionParamsForceLanguage = "croatian"
	BrandIdentifyFromTransactionParamsForceLanguageCzech          BrandIdentifyFromTransactionParamsForceLanguage = "czech"
	BrandIdentifyFromTransactionParamsForceLanguageDanish         BrandIdentifyFromTransactionParamsForceLanguage = "danish"
	BrandIdentifyFromTransactionParamsForceLanguageDutch          BrandIdentifyFromTransactionParamsForceLanguage = "dutch"
	BrandIdentifyFromTransactionParamsForceLanguageEnglish        BrandIdentifyFromTransactionParamsForceLanguage = "english"
	BrandIdentifyFromTransactionParamsForceLanguageEsperanto      BrandIdentifyFromTransactionParamsForceLanguage = "esperanto"
	BrandIdentifyFromTransactionParamsForceLanguageEstonian       BrandIdentifyFromTransactionParamsForceLanguage = "estonian"
	BrandIdentifyFromTransactionParamsForceLanguageFarsi          BrandIdentifyFromTransactionParamsForceLanguage = "farsi"
	BrandIdentifyFromTransactionParamsForceLanguageFijian         BrandIdentifyFromTransactionParamsForceLanguage = "fijian"
	BrandIdentifyFromTransactionParamsForceLanguageFinnish        BrandIdentifyFromTransactionParamsForceLanguage = "finnish"
	BrandIdentifyFromTransactionParamsForceLanguageFrench         BrandIdentifyFromTransactionParamsForceLanguage = "french"
	BrandIdentifyFromTransactionParamsForceLanguageGalician       BrandIdentifyFromTransactionParamsForceLanguage = "galician"
	BrandIdentifyFromTransactionParamsForceLanguageGeorgian       BrandIdentifyFromTransactionParamsForceLanguage = "georgian"
	BrandIdentifyFromTransactionParamsForceLanguageGerman         BrandIdentifyFromTransactionParamsForceLanguage = "german"
	BrandIdentifyFromTransactionParamsForceLanguageGreek          BrandIdentifyFromTransactionParamsForceLanguage = "greek"
	BrandIdentifyFromTransactionParamsForceLanguageGuarani        BrandIdentifyFromTransactionParamsForceLanguage = "guarani"
	BrandIdentifyFromTransactionParamsForceLanguageGujarati       BrandIdentifyFromTransactionParamsForceLanguage = "gujarati"
	BrandIdentifyFromTransactionParamsForceLanguageHaitianCreole  BrandIdentifyFromTransactionParamsForceLanguage = "haitian-creole"
	BrandIdentifyFromTransactionParamsForceLanguageHausa          BrandIdentifyFromTransactionParamsForceLanguage = "hausa"
	BrandIdentifyFromTransactionParamsForceLanguageHawaiian       BrandIdentifyFromTransactionParamsForceLanguage = "hawaiian"
	BrandIdentifyFromTransactionParamsForceLanguageHebrew         BrandIdentifyFromTransactionParamsForceLanguage = "hebrew"
	BrandIdentifyFromTransactionParamsForceLanguageHindi          BrandIdentifyFromTransactionParamsForceLanguage = "hindi"
	BrandIdentifyFromTransactionParamsForceLanguageHmong          BrandIdentifyFromTransactionParamsForceLanguage = "hmong"
	BrandIdentifyFromTransactionParamsForceLanguageHungarian      BrandIdentifyFromTransactionParamsForceLanguage = "hungarian"
	BrandIdentifyFromTransactionParamsForceLanguageIcelandic      BrandIdentifyFromTransactionParamsForceLanguage = "icelandic"
	BrandIdentifyFromTransactionParamsForceLanguageIgbo           BrandIdentifyFromTransactionParamsForceLanguage = "igbo"
	BrandIdentifyFromTransactionParamsForceLanguageIndonesian     BrandIdentifyFromTransactionParamsForceLanguage = "indonesian"
	BrandIdentifyFromTransactionParamsForceLanguageIrish          BrandIdentifyFromTransactionParamsForceLanguage = "irish"
	BrandIdentifyFromTransactionParamsForceLanguageItalian        BrandIdentifyFromTransactionParamsForceLanguage = "italian"
	BrandIdentifyFromTransactionParamsForceLanguageJapanese       BrandIdentifyFromTransactionParamsForceLanguage = "japanese"
	BrandIdentifyFromTransactionParamsForceLanguageJavanese       BrandIdentifyFromTransactionParamsForceLanguage = "javanese"
	BrandIdentifyFromTransactionParamsForceLanguageKannada        BrandIdentifyFromTransactionParamsForceLanguage = "kannada"
	BrandIdentifyFromTransactionParamsForceLanguageKazakh         BrandIdentifyFromTransactionParamsForceLanguage = "kazakh"
	BrandIdentifyFromTransactionParamsForceLanguageKhmer          BrandIdentifyFromTransactionParamsForceLanguage = "khmer"
	BrandIdentifyFromTransactionParamsForceLanguageKinyarwanda    BrandIdentifyFromTransactionParamsForceLanguage = "kinyarwanda"
	BrandIdentifyFromTransactionParamsForceLanguageKorean         BrandIdentifyFromTransactionParamsForceLanguage = "korean"
	BrandIdentifyFromTransactionParamsForceLanguageKurdish        BrandIdentifyFromTransactionParamsForceLanguage = "kurdish"
	BrandIdentifyFromTransactionParamsForceLanguageKyrgyz         BrandIdentifyFromTransactionParamsForceLanguage = "kyrgyz"
	BrandIdentifyFromTransactionParamsForceLanguageLao            BrandIdentifyFromTransactionParamsForceLanguage = "lao"
	BrandIdentifyFromTransactionParamsForceLanguageLatin          BrandIdentifyFromTransactionParamsForceLanguage = "latin"
	BrandIdentifyFromTransactionParamsForceLanguageLatvian        BrandIdentifyFromTransactionParamsForceLanguage = "latvian"
	BrandIdentifyFromTransactionParamsForceLanguageLingala        BrandIdentifyFromTransactionParamsForceLanguage = "lingala"
	BrandIdentifyFromTransactionParamsForceLanguageLithuanian     BrandIdentifyFromTransactionParamsForceLanguage = "lithuanian"
	BrandIdentifyFromTransactionParamsForceLanguageLuxembourgish  BrandIdentifyFromTransactionParamsForceLanguage = "luxembourgish"
	BrandIdentifyFromTransactionParamsForceLanguageMacedonian     BrandIdentifyFromTransactionParamsForceLanguage = "macedonian"
	BrandIdentifyFromTransactionParamsForceLanguageMalagasy       BrandIdentifyFromTransactionParamsForceLanguage = "malagasy"
	BrandIdentifyFromTransactionParamsForceLanguageMalay          BrandIdentifyFromTransactionParamsForceLanguage = "malay"
	BrandIdentifyFromTransactionParamsForceLanguageMalayalam      BrandIdentifyFromTransactionParamsForceLanguage = "malayalam"
	BrandIdentifyFromTransactionParamsForceLanguageMaltese        BrandIdentifyFromTransactionParamsForceLanguage = "maltese"
	BrandIdentifyFromTransactionParamsForceLanguageMaori          BrandIdentifyFromTransactionParamsForceLanguage = "maori"
	BrandIdentifyFromTransactionParamsForceLanguageMarathi        BrandIdentifyFromTransactionParamsForceLanguage = "marathi"
	BrandIdentifyFromTransactionParamsForceLanguageMongolian      BrandIdentifyFromTransactionParamsForceLanguage = "mongolian"
	BrandIdentifyFromTransactionParamsForceLanguageNepali         BrandIdentifyFromTransactionParamsForceLanguage = "nepali"
	BrandIdentifyFromTransactionParamsForceLanguageNorwegian      BrandIdentifyFromTransactionParamsForceLanguage = "norwegian"
	BrandIdentifyFromTransactionParamsForceLanguageOdia           BrandIdentifyFromTransactionParamsForceLanguage = "odia"
	BrandIdentifyFromTransactionParamsForceLanguageOromo          BrandIdentifyFromTransactionParamsForceLanguage = "oromo"
	BrandIdentifyFromTransactionParamsForceLanguagePashto         BrandIdentifyFromTransactionParamsForceLanguage = "pashto"
	BrandIdentifyFromTransactionParamsForceLanguagePidgin         BrandIdentifyFromTransactionParamsForceLanguage = "pidgin"
	BrandIdentifyFromTransactionParamsForceLanguagePolish         BrandIdentifyFromTransactionParamsForceLanguage = "polish"
	BrandIdentifyFromTransactionParamsForceLanguagePortuguese     BrandIdentifyFromTransactionParamsForceLanguage = "portuguese"
	BrandIdentifyFromTransactionParamsForceLanguagePunjabi        BrandIdentifyFromTransactionParamsForceLanguage = "punjabi"
	BrandIdentifyFromTransactionParamsForceLanguageQuechua        BrandIdentifyFromTransactionParamsForceLanguage = "quechua"
	BrandIdentifyFromTransactionParamsForceLanguageRomanian       BrandIdentifyFromTransactionParamsForceLanguage = "romanian"
	BrandIdentifyFromTransactionParamsForceLanguageRussian        BrandIdentifyFromTransactionParamsForceLanguage = "russian"
	BrandIdentifyFromTransactionParamsForceLanguageSamoan         BrandIdentifyFromTransactionParamsForceLanguage = "samoan"
	BrandIdentifyFromTransactionParamsForceLanguageScottishGaelic BrandIdentifyFromTransactionParamsForceLanguage = "scottish-gaelic"
	BrandIdentifyFromTransactionParamsForceLanguageSerbian        BrandIdentifyFromTransactionParamsForceLanguage = "serbian"
	BrandIdentifyFromTransactionParamsForceLanguageSesotho        BrandIdentifyFromTransactionParamsForceLanguage = "sesotho"
	BrandIdentifyFromTransactionParamsForceLanguageShona          BrandIdentifyFromTransactionParamsForceLanguage = "shona"
	BrandIdentifyFromTransactionParamsForceLanguageSindhi         BrandIdentifyFromTransactionParamsForceLanguage = "sindhi"
	BrandIdentifyFromTransactionParamsForceLanguageSinhala        BrandIdentifyFromTransactionParamsForceLanguage = "sinhala"
	BrandIdentifyFromTransactionParamsForceLanguageSlovak         BrandIdentifyFromTransactionParamsForceLanguage = "slovak"
	BrandIdentifyFromTransactionParamsForceLanguageSlovene        BrandIdentifyFromTransactionParamsForceLanguage = "slovene"
	BrandIdentifyFromTransactionParamsForceLanguageSomali         BrandIdentifyFromTransactionParamsForceLanguage = "somali"
	BrandIdentifyFromTransactionParamsForceLanguageSpanish        BrandIdentifyFromTransactionParamsForceLanguage = "spanish"
	BrandIdentifyFromTransactionParamsForceLanguageSundanese      BrandIdentifyFromTransactionParamsForceLanguage = "sundanese"
	BrandIdentifyFromTransactionParamsForceLanguageSwahili        BrandIdentifyFromTransactionParamsForceLanguage = "swahili"
	BrandIdentifyFromTransactionParamsForceLanguageSwedish        BrandIdentifyFromTransactionParamsForceLanguage = "swedish"
	BrandIdentifyFromTransactionParamsForceLanguageTagalog        BrandIdentifyFromTransactionParamsForceLanguage = "tagalog"
	BrandIdentifyFromTransactionParamsForceLanguageTajik          BrandIdentifyFromTransactionParamsForceLanguage = "tajik"
	BrandIdentifyFromTransactionParamsForceLanguageTamil          BrandIdentifyFromTransactionParamsForceLanguage = "tamil"
	BrandIdentifyFromTransactionParamsForceLanguageTatar          BrandIdentifyFromTransactionParamsForceLanguage = "tatar"
	BrandIdentifyFromTransactionParamsForceLanguageTelugu         BrandIdentifyFromTransactionParamsForceLanguage = "telugu"
	BrandIdentifyFromTransactionParamsForceLanguageThai           BrandIdentifyFromTransactionParamsForceLanguage = "thai"
	BrandIdentifyFromTransactionParamsForceLanguageTibetan        BrandIdentifyFromTransactionParamsForceLanguage = "tibetan"
	BrandIdentifyFromTransactionParamsForceLanguageTigrinya       BrandIdentifyFromTransactionParamsForceLanguage = "tigrinya"
	BrandIdentifyFromTransactionParamsForceLanguageTongan         BrandIdentifyFromTransactionParamsForceLanguage = "tongan"
	BrandIdentifyFromTransactionParamsForceLanguageTswana         BrandIdentifyFromTransactionParamsForceLanguage = "tswana"
	BrandIdentifyFromTransactionParamsForceLanguageTurkish        BrandIdentifyFromTransactionParamsForceLanguage = "turkish"
	BrandIdentifyFromTransactionParamsForceLanguageTurkmen        BrandIdentifyFromTransactionParamsForceLanguage = "turkmen"
	BrandIdentifyFromTransactionParamsForceLanguageUkrainian      BrandIdentifyFromTransactionParamsForceLanguage = "ukrainian"
	BrandIdentifyFromTransactionParamsForceLanguageUrdu           BrandIdentifyFromTransactionParamsForceLanguage = "urdu"
	BrandIdentifyFromTransactionParamsForceLanguageUyghur         BrandIdentifyFromTransactionParamsForceLanguage = "uyghur"
	BrandIdentifyFromTransactionParamsForceLanguageUzbek          BrandIdentifyFromTransactionParamsForceLanguage = "uzbek"
	BrandIdentifyFromTransactionParamsForceLanguageVietnamese     BrandIdentifyFromTransactionParamsForceLanguage = "vietnamese"
	BrandIdentifyFromTransactionParamsForceLanguageWelsh          BrandIdentifyFromTransactionParamsForceLanguage = "welsh"
	BrandIdentifyFromTransactionParamsForceLanguageWolof          BrandIdentifyFromTransactionParamsForceLanguage = "wolof"
	BrandIdentifyFromTransactionParamsForceLanguageXhosa          BrandIdentifyFromTransactionParamsForceLanguage = "xhosa"
	BrandIdentifyFromTransactionParamsForceLanguageYiddish        BrandIdentifyFromTransactionParamsForceLanguage = "yiddish"
	BrandIdentifyFromTransactionParamsForceLanguageYoruba         BrandIdentifyFromTransactionParamsForceLanguage = "yoruba"
	BrandIdentifyFromTransactionParamsForceLanguageZulu           BrandIdentifyFromTransactionParamsForceLanguage = "zulu"
)

type BrandIdentifyFromTransactionResponse 

type BrandIdentifyFromTransactionResponse struct {
	// Detailed brand information
	Brand BrandIdentifyFromTransactionResponseBrand `json:"brand"`
	// HTTP status code
	Code int64 `json:"code"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Brand       respjson.Field
		Code        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponse) RawJSON 

func (r BrandIdentifyFromTransactionResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponse) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponse) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrand 

type BrandIdentifyFromTransactionResponseBrand struct {
	// Physical address of the brand
	Address BrandIdentifyFromTransactionResponseBrandAddress `json:"address"`
	// An array of backdrop images for the brand
	Backdrops []BrandIdentifyFromTransactionResponseBrandBackdrop `json:"backdrops"`
	// An array of brand colors
	Colors []BrandIdentifyFromTransactionResponseBrandColor `json:"colors"`
	// A brief description of the brand
	Description string `json:"description"`
	// The domain name of the brand
	Domain string `json:"domain"`
	// Company email address
	Email string `json:"email"`
	// Industry classification information for the brand
	Industries BrandIdentifyFromTransactionResponseBrandIndustries `json:"industries"`
	// Indicates whether the brand content is not safe for work (NSFW)
	IsNsfw bool `json:"is_nsfw"`
	// Important website links for the brand
	Links BrandIdentifyFromTransactionResponseBrandLinks `json:"links"`
	// An array of logos associated with the brand
	Logos []BrandIdentifyFromTransactionResponseBrandLogo `json:"logos"`
	// Company phone number
	Phone string `json:"phone"`
	// The primary language of the brand's website content. Detected from the HTML lang
	// tag, page content analysis, or social media descriptions.
	//
	// Any of "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese",
	// "aymara", "azeri", "basque", "belarusian", "bengali", "bosnian", "bulgarian",
	// "burmese", "cantonese", "catalan", "cebuano", "chinese", "corsican", "croatian",
	// "czech", "danish", "dutch", "english", "esperanto", "estonian", "farsi",
	// "fijian", "finnish", "french", "galician", "georgian", "german", "greek",
	// "guarani", "gujarati", "haitian-creole", "hausa", "hawaiian", "hebrew", "hindi",
	// "hmong", "hungarian", "icelandic", "igbo", "indonesian", "irish", "italian",
	// "japanese", "javanese", "kannada", "kazakh", "khmer", "kinyarwanda", "korean",
	// "kurdish", "kyrgyz", "lao", "latin", "latvian", "lingala", "lithuanian",
	// "luxembourgish", "macedonian", "malagasy", "malay", "malayalam", "maltese",
	// "maori", "marathi", "mongolian", "nepali", "norwegian", "odia", "oromo",
	// "pashto", "pidgin", "polish", "portuguese", "punjabi", "quechua", "romanian",
	// "russian", "samoan", "scottish-gaelic", "serbian", "sesotho", "shona", "sindhi",
	// "sinhala", "slovak", "slovene", "somali", "spanish", "sundanese", "swahili",
	// "swedish", "tagalog", "tajik", "tamil", "tatar", "telugu", "thai", "tibetan",
	// "tigrinya", "tongan", "tswana", "turkish", "turkmen", "ukrainian", "urdu",
	// "uyghur", "uzbek", "vietnamese", "welsh", "wolof", "xhosa", "yiddish", "yoruba",
	// "zulu".
	PrimaryLanguage string `json:"primary_language" api:"nullable"`
	// The brand's slogan
	Slogan string `json:"slogan"`
	// An array of social media links for the brand
	Socials []BrandIdentifyFromTransactionResponseBrandSocial `json:"socials"`
	// Stock market information for this brand (will be null if not a publicly traded
	// company)
	Stock BrandIdentifyFromTransactionResponseBrandStock `json:"stock"`
	// The title or name of the brand
	Title string `json:"title"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address         respjson.Field
		Backdrops       respjson.Field
		Colors          respjson.Field
		Description     respjson.Field
		Domain          respjson.Field
		Email           respjson.Field
		Industries      respjson.Field
		IsNsfw          respjson.Field
		Links           respjson.Field
		Logos           respjson.Field
		Phone           respjson.Field
		PrimaryLanguage respjson.Field
		Slogan          respjson.Field
		Socials         respjson.Field
		Stock           respjson.Field
		Title           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Detailed brand information

func (BrandIdentifyFromTransactionResponseBrand) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrand) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrand) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrand) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandAddress 

type BrandIdentifyFromTransactionResponseBrandAddress struct {
	// City name
	City string `json:"city"`
	// Country name
	Country string `json:"country"`
	// Country code
	CountryCode string `json:"country_code"`
	// Postal or ZIP code
	PostalCode string `json:"postal_code"`
	// State or province code
	StateCode string `json:"state_code"`
	// State or province name
	StateProvince string `json:"state_province"`
	// Street address
	Street string `json:"street"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		City          respjson.Field
		Country       respjson.Field
		CountryCode   respjson.Field
		PostalCode    respjson.Field
		StateCode     respjson.Field
		StateProvince respjson.Field
		Street        respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Physical address of the brand

func (BrandIdentifyFromTransactionResponseBrandAddress) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandAddress) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandAddress) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandBackdrop 

type BrandIdentifyFromTransactionResponseBrandBackdrop struct {
	// Array of colors in the backdrop image
	Colors []BrandIdentifyFromTransactionResponseBrandBackdropColor `json:"colors"`
	// Resolution of the backdrop image
	Resolution BrandIdentifyFromTransactionResponseBrandBackdropResolution `json:"resolution"`
	// URL of the backdrop image
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Resolution  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandBackdrop) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandBackdrop) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandBackdrop) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandBackdrop) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandBackdropColor 

type BrandIdentifyFromTransactionResponseBrandBackdropColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandBackdropColor) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandBackdropColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandBackdropColor) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandBackdropColor) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandBackdropResolution 

type BrandIdentifyFromTransactionResponseBrandBackdropResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the backdrop image

func (BrandIdentifyFromTransactionResponseBrandBackdropResolution) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandBackdropResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandBackdropResolution) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandBackdropResolution) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandColor 

type BrandIdentifyFromTransactionResponseBrandColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandColor) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandColor) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandColor) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandIndustries 

type BrandIdentifyFromTransactionResponseBrandIndustries struct {
	// Easy Industry Classification - array of industry and subindustry pairs
	Eic []BrandIdentifyFromTransactionResponseBrandIndustriesEic `json:"eic"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Eic         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Industry classification information for the brand

func (BrandIdentifyFromTransactionResponseBrandIndustries) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandIndustries) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandIndustries) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandIndustries) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandIndustriesEic 

type BrandIdentifyFromTransactionResponseBrandIndustriesEic struct {
	// Industry classification enum
	//
	// Any of "Aerospace & Defense", "Technology", "Finance", "Healthcare", "Retail &
	// E-commerce", "Entertainment", "Education", "Government & Nonprofit", "Industrial
	// & Energy", "Automotive & Transportation", "Lifestyle & Leisure", "Luxury &
	// Fashion", "News & Media", "Sports", "Real Estate & PropTech", "Legal &
	// Compliance", "Telecommunications", "Agriculture & Food", "Professional Services
	// & Agencies", "Chemicals & Materials", "Logistics & Supply Chain", "Hospitality &
	// Tourism", "Construction & Built Environment", "Consumer Packaged Goods (CPG)".
	Industry string `json:"industry" api:"required"`
	// Subindustry classification enum
	//
	// Any of "Defense Systems & Military Hardware", "Aerospace Manufacturing",
	// "Avionics & Navigation Technology", "Subsea & Naval Defense Systems", "Space &
	// Satellite Technology", "Defense IT & Systems Integration", "Software (B2B)",
	// "Software (B2C)", "Cloud Infrastructure & DevOps", "Cybersecurity", "Artificial
	// Intelligence & Machine Learning", "Data Infrastructure & Analytics", "Hardware &
	// Semiconductors", "Fintech Infrastructure", "eCommerce & Marketplace Platforms",
	// "Developer Tools & APIs", "Web3 & Blockchain", "XR & Spatial Computing",
	// "Banking & Lending", "Investment Management & WealthTech", "Insurance &
	// InsurTech", "Payments & Money Movement", "Accounting, Tax & Financial Planning
	// Tools", "Capital Markets & Trading Platforms", "Financial Infrastructure &
	// APIs", "Credit Scoring & Risk Management", "Cryptocurrency & Digital Assets",
	// "BNPL & Alternative Financing", "Healthcare Providers & Services",
	// "Pharmaceuticals & Drug Development", "Medical Devices & Diagnostics",
	// "Biotechnology & Genomics", "Digital Health & Telemedicine", "Health Insurance &
	// Benefits Tech", "Clinical Trials & Research Platforms", "Mental Health &
	// Wellness", "Healthcare IT & EHR Systems", "Consumer Health & Wellness Products",
	// "Online Marketplaces", "Direct-to-Consumer (DTC) Brands", "Retail Tech &
	// Point-of-Sale Systems", "Omnichannel & In-Store Retail", "E-commerce Enablement
	// & Infrastructure", "Subscription & Membership Commerce", "Social Commerce &
	// Influencer Platforms", "Fashion & Apparel Retail", "Food, Beverage & Grocery
	// E-commerce", "Streaming Platforms (Video, Music, Audio)", "Gaming & Interactive
	// Entertainment", "Creator Economy & Influencer Platforms", "Advertising, Adtech &
	// Media Buying", "Film, TV & Production Studios", "Events, Venues & Live
	// Entertainment", "Virtual Worlds & Metaverse Experiences", "K-12 Education
	// Platforms & Tools", "Higher Education & University Tech", "Online Learning &
	// MOOCs", "Test Prep & Certification", "Corporate Training & Upskilling",
	// "Tutoring & Supplemental Learning", "Education Management Systems (LMS/SIS)",
	// "Language Learning", "Creator-Led & Cohort-Based Courses", "Special Education &
	// Accessibility Tools", "Government Technology & Digital Services", "Civic
	// Engagement & Policy Platforms", "International Development & Humanitarian Aid",
	// "Philanthropy & Grantmaking", "Nonprofit Operations & Fundraising Tools",
	// "Public Health & Social Services", "Education & Youth Development Programs",
	// "Environmental & Climate Action Organizations", "Legal Aid & Social Justice
	// Advocacy", "Municipal & Infrastructure Services", "Manufacturing & Industrial
	// Automation", "Energy Production (Oil, Gas, Nuclear)", "Renewable Energy &
	// Cleantech", "Utilities & Grid Infrastructure", "Industrial IoT & Monitoring
	// Systems", "Construction & Heavy Equipment", "Mining & Natural Resources",
	// "Environmental Engineering & Sustainability", "Energy Storage & Battery
	// Technology", "Automotive OEMs & Vehicle Manufacturing", "Electric Vehicles (EVs)
	// & Charging Infrastructure", "Mobility-as-a-Service (MaaS)", "Fleet Management",
	// "Public Transit & Urban Mobility", "Autonomous Vehicles & ADAS", "Aftermarket
	// Parts & Services", "Telematics & Vehicle Connectivity", "Aviation & Aerospace
	// Transport", "Maritime Shipping", "Fitness & Wellness", "Beauty & Personal Care",
	// "Home & Living", "Dating & Relationships", "Hobbies, Crafts & DIY", "Outdoor &
	// Recreational Gear", "Events, Experiences & Ticketing Platforms", "Designer &
	// Luxury Apparel", "Accessories, Jewelry & Watches", "Footwear & Leather Goods",
	// "Beauty, Fragrance & Skincare", "Fashion Marketplaces & Retail Platforms",
	// "Sustainable & Ethical Fashion", "Resale, Vintage & Circular Fashion", "Fashion
	// Tech & Virtual Try-Ons", "Streetwear & Emerging Luxury", "Couture &
	// Made-to-Measure", "News Publishing & Journalism", "Digital Media & Content
	// Platforms", "Broadcasting (TV & Radio)", "Podcasting & Audio Media", "News
	// Aggregators & Curation Tools", "Independent & Creator-Led Media", "Newsletters &
	// Substack-Style Platforms", "Political & Investigative Media", "Trade & Niche
	// Publications", "Media Monitoring & Analytics", "Professional Teams & Leagues",
	// "Sports Media & Broadcasting", "Sports Betting & Fantasy Sports", "Fitness &
	// Athletic Training Platforms", "Sportswear & Equipment", "Esports & Competitive
	// Gaming", "Sports Venues & Event Management", "Athlete Management & Talent
	// Agencies", "Sports Tech & Performance Analytics", "Youth, Amateur & Collegiate
	// Sports", "Real Estate Marketplaces", "Property Management Software", "Rental
	// Platforms", "Mortgage & Lending Tech", "Real Estate Investment Platforms", "Law
	// Firms & Legal Services", "Legal Tech & Automation", "Regulatory Compliance",
	// "E-Discovery & Litigation Tools", "Contract Management", "Governance, Risk &
	// Compliance (GRC)", "IP & Trademark Management", "Legal Research & Intelligence",
	// "Compliance Training & Certification", "Whistleblower & Ethics Reporting",
	// "Mobile & Wireless Networks (3G/4G/5G)", "Broadband & Fiber Internet",
	// "Satellite & Space-Based Communications", "Network Equipment & Infrastructure",
	// "Telecom Billing & OSS/BSS Systems", "VoIP & Unified Communications", "Internet
	// Service Providers (ISPs)", "Edge Computing & Network Virtualization", "IoT
	// Connectivity Platforms", "Precision Agriculture & AgTech", "Crop & Livestock
	// Production", "Food & Beverage Manufacturing & Processing", "Food Distribution",
	// "Restaurants & Food Service", "Agricultural Inputs & Equipment", "Sustainable &
	// Regenerative Agriculture", "Seafood & Aquaculture", "Management Consulting",
	// "Marketing & Advertising Agencies", "Design, Branding & Creative Studios", "IT
	// Services & Managed Services", "Staffing, Recruiting & Talent", "Accounting & Tax
	// Firms", "Public Relations & Communications", "Business Process Outsourcing
	// (BPO)", "Professional Training & Coaching", "Specialty Chemicals", "Commodity &
	// Petrochemicals", "Polymers, Plastics & Rubber", "Coatings, Adhesives &
	// Sealants", "Industrial Gases", "Advanced Materials & Composites", "Battery
	// Materials & Energy Storage", "Electronic Materials & Semiconductor Chemicals",
	// "Agrochemicals & Fertilizers", "Freight & Transportation Tech", "Last-Mile
	// Delivery", "Warehouse Automation", "Supply Chain Visibility Platforms",
	// "Logistics Marketplaces", "Shipping & Freight Forwarding", "Cold Chain
	// Logistics", "Reverse Logistics & Returns", "Cross-Border Trade Tech",
	// "Transportation Management Systems (TMS)", "Hotels & Accommodation", "Vacation
	// Rentals & Short-Term Stays", "Restaurant Tech & Management", "Travel Booking
	// Platforms", "Tourism Experiences & Activities", "Cruise Lines & Marine Tourism",
	// "Hospitality Management Systems", "Event & Venue Management", "Corporate Travel
	// Management", "Travel Insurance & Protection", "Construction Management
	// Software", "BIM/CAD & Design Tools", "Construction Marketplaces", "Equipment
	// Rental & Management", "Building Materials & Procurement", "Construction
	// Workforce Management", "Project Estimation & Bidding", "Modular & Prefab
	// Construction", "Construction Safety & Compliance", "Smart Building Technology",
	// "Food & Beverage CPG", "Home & Personal Care CPG", "CPG Analytics & Insights",
	// "Direct-to-Consumer CPG Brands", "CPG Supply Chain & Distribution", "Private
	// Label Manufacturing", "CPG Retail Intelligence", "Sustainable CPG & Packaging",
	// "Beauty & Cosmetics CPG", "Health & Wellness CPG".
	Subindustry string `json:"subindustry" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Industry    respjson.Field
		Subindustry respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandIndustriesEic) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandIndustriesEic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandIndustriesEic) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandIndustriesEic) UnmarshalJSON(data []byte) error
type BrandIdentifyFromTransactionResponseBrandLinks struct {
	// URL to the brand's blog or news page
	Blog string `json:"blog" api:"nullable"`
	// URL to the brand's careers or job opportunities page
	Careers string `json:"careers" api:"nullable"`
	// URL to the brand's contact or contact us page
	Contact string `json:"contact" api:"nullable"`
	// URL to the brand's pricing or plans page
	Pricing string `json:"pricing" api:"nullable"`
	// URL to the brand's privacy policy page
	Privacy string `json:"privacy" api:"nullable"`
	// URL to the brand's terms of service or terms and conditions page
	Terms string `json:"terms" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blog        respjson.Field
		Careers     respjson.Field
		Contact     respjson.Field
		Pricing     respjson.Field
		Privacy     respjson.Field
		Terms       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Important website links for the brand

func (BrandIdentifyFromTransactionResponseBrandLinks) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandLinks) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandLinks) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandLinks) UnmarshalJSON(data []byte) error
type BrandIdentifyFromTransactionResponseBrandLogo struct {
	// Array of colors in the logo
	Colors []BrandIdentifyFromTransactionResponseBrandLogoColor `json:"colors"`
	// Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
	// best for dark mode, 'has_opaque_background' = can be used for either as image
	// has its own background
	//
	// Any of "light", "dark", "has_opaque_background".
	Mode string `json:"mode"`
	// Resolution of the logo image
	Resolution BrandIdentifyFromTransactionResponseBrandLogoResolution `json:"resolution"`
	// Type of the logo based on resolution (e.g., 'icon', 'logo')
	//
	// Any of "icon", "logo".
	Type string `json:"type"`
	// CDN hosted url of the logo (ready for display)
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors      respjson.Field
		Mode        respjson.Field
		Resolution  respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandLogo) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandLogo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandLogo) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandLogo) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandLogoColor 

type BrandIdentifyFromTransactionResponseBrandLogoColor struct {
	// Color in hexadecimal format
	Hex string `json:"hex"`
	// Name of the color
	Name string `json:"name"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Hex         respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandLogoColor) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandLogoColor) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandLogoColor) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandLogoColor) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandLogoResolution 

type BrandIdentifyFromTransactionResponseBrandLogoResolution struct {
	// Aspect ratio of the image (width/height)
	AspectRatio float64 `json:"aspect_ratio"`
	// Height of the image in pixels
	Height int64 `json:"height"`
	// Width of the image in pixels
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AspectRatio respjson.Field
		Height      respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Resolution of the logo image

func (BrandIdentifyFromTransactionResponseBrandLogoResolution) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandLogoResolution) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandLogoResolution) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandLogoResolution) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandSocial 

type BrandIdentifyFromTransactionResponseBrandSocial struct {
	// Type of social media platform
	//
	// Any of "x", "facebook", "instagram", "linkedin", "youtube", "pinterest",
	// "tiktok", "dribbble", "github", "behance", "snapchat", "whatsapp", "telegram",
	// "line", "discord", "twitch", "vimeo", "imdb", "tumblr", "flickr", "giphy",
	// "medium", "spotify", "soundcloud", "tripadvisor", "yelp", "producthunt",
	// "reddit", "crunchbase", "appstore", "playstore".
	Type string `json:"type"`
	// URL of the social media page
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BrandIdentifyFromTransactionResponseBrandSocial) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandSocial) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandSocial) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandSocial) UnmarshalJSON(data []byte) error

type BrandIdentifyFromTransactionResponseBrandStock 

type BrandIdentifyFromTransactionResponseBrandStock struct {
	// Stock exchange name
	Exchange string `json:"exchange"`
	// Stock ticker symbol
	Ticker string `json:"ticker"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Exchange    respjson.Field
		Ticker      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Stock market information for this brand (will be null if not a publicly traded company)

func (BrandIdentifyFromTransactionResponseBrandStock) RawJSON 

func (r BrandIdentifyFromTransactionResponseBrandStock) RawJSON() string

Returns the unmodified JSON received from the API

func (*BrandIdentifyFromTransactionResponseBrandStock) UnmarshalJSON 

func (r *BrandIdentifyFromTransactionResponseBrandStock) UnmarshalJSON(data []byte) error

type BrandService 

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

BrandService contains methods and other services that help with interacting with the context.dev API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBrandService method instead.

func NewBrandService 

func NewBrandService(opts ...option.RequestOption) (r BrandService)

NewBrandService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BrandService) Get 

func (r *BrandService) Get(ctx context.Context, query BrandGetParams, opts ...option.RequestOption) (res *BrandGetResponse, err error)

Retrieve logos, backdrops, colors, industry, description, and more from any domain

func (*BrandService) GetByEmail 

func (r *BrandService) GetByEmail(ctx context.Context, query BrandGetByEmailParams, opts ...option.RequestOption) (res *BrandGetByEmailResponse, err error)

Retrieve brand information using an email address while detecting disposable and free email addresses. Disposable and free email addresses (like gmail.com, yahoo.com) will throw a 422 error.

func (*BrandService) GetByIsin 

func (r *BrandService) GetByIsin(ctx context.Context, query BrandGetByIsinParams, opts ...option.RequestOption) (res *BrandGetByIsinResponse, err error)

Retrieve brand information using an ISIN (International Securities Identification Number).

func (*BrandService) GetByName 

func (r *BrandService) GetByName(ctx context.Context, query BrandGetByNameParams, opts ...option.RequestOption) (res *BrandGetByNameResponse, err error)

Retrieve brand information using a company name.

func (*BrandService) GetByTicker 

func (r *BrandService) GetByTicker(ctx context.Context, query BrandGetByTickerParams, opts ...option.RequestOption) (res *BrandGetByTickerResponse, err error)

Retrieve brand information using a stock ticker symbol.

func (*BrandService) GetSimplified 

func (r *BrandService) GetSimplified(ctx context.Context, query BrandGetSimplifiedParams, opts ...option.RequestOption) (res *BrandGetSimplifiedResponse, err error)

Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops. Optimized for faster responses and reduced data transfer.

func (*BrandService) IdentifyFromTransaction 

func (r *BrandService) IdentifyFromTransaction(ctx context.Context, query BrandIdentifyFromTransactionParams, opts ...option.RequestOption) (res *BrandIdentifyFromTransactionResponse, err error)

Endpoint specially designed for platforms that want to identify transaction data by the transaction title.

type Client 

type Client struct {
	Web      WebService
	AI       AIService
	Brand    BrandService
	Industry IndustryService
	Utility  UtilityService
	// contains filtered or unexported fields
}

Client creates a struct with services and top level methods that help with interacting with the context.dev API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r Client)

NewClient generates a new client with the default option read from the environment (CONTEXT_DEV_API_KEY, CONTEXT_DEV_BASE_URL). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Error 

type Error = apierror.Error

type IndustryGetNaicsParams 

type IndustryGetNaicsParams struct {
	// Brand domain or title to retrieve NAICS code for. If a valid domain is provided,
	// it will be used for classification, otherwise, we will search for the brand
	// using the provided title.
	Input string `query:"input" api:"required" json:"-"`
	// Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
	// to 5.
	MaxResults param.Opt[int64] `query:"maxResults,omitzero" json:"-"`
	// Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
	MinResults param.Opt[int64] `query:"minResults,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IndustryGetNaicsParams) URLQuery 

func (r IndustryGetNaicsParams) URLQuery() (v url.Values, err error)

URLQuery serializes IndustryGetNaicsParams's query parameters as `url.Values`.

type IndustryGetNaicsResponse 

type IndustryGetNaicsResponse struct {
	// Array of NAICS codes and titles.
	Codes []IndustryGetNaicsResponseCode `json:"codes"`
	// Domain found for the brand
	Domain string `json:"domain"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// Industry classification type, for naics api it will be `naics`
	Type string `json:"type"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Codes       respjson.Field
		Domain      respjson.Field
		Status      respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IndustryGetNaicsResponse) RawJSON 

func (r IndustryGetNaicsResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IndustryGetNaicsResponse) UnmarshalJSON 

func (r *IndustryGetNaicsResponse) UnmarshalJSON(data []byte) error

type IndustryGetNaicsResponseCode 

type IndustryGetNaicsResponseCode struct {
	// NAICS code
	Code string `json:"code" api:"required"`
	// Confidence level for how well this NAICS code matches the company description
	//
	// Any of "high", "medium", "low".
	Confidence string `json:"confidence" api:"required"`
	// NAICS title
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Confidence  respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IndustryGetNaicsResponseCode) RawJSON 

func (r IndustryGetNaicsResponseCode) RawJSON() string

Returns the unmodified JSON received from the API

func (*IndustryGetNaicsResponseCode) UnmarshalJSON 

func (r *IndustryGetNaicsResponseCode) UnmarshalJSON(data []byte) error

type IndustryGetSicParams 

type IndustryGetSicParams struct {
	// Brand domain or title to retrieve SIC code for. If a valid domain is provided,
	// it will be used for classification, otherwise, we will search for the brand
	// using the provided title.
	Input string `query:"input" api:"required" json:"-"`
	// Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.
	MaxResults param.Opt[int64] `query:"maxResults,omitzero" json:"-"`
	// Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
	MinResults param.Opt[int64] `query:"minResults,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
	// Industrial Classification system; `latest_sec` uses the current SIC list as
	// published by the SEC. Defaults to `original_sic`.
	//
	// Any of "original_sic", "latest_sec".
	Type IndustryGetSicParamsType `query:"type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IndustryGetSicParams) URLQuery 

func (r IndustryGetSicParams) URLQuery() (v url.Values, err error)

URLQuery serializes IndustryGetSicParams's query parameters as `url.Values`.

type IndustryGetSicParamsType 

type IndustryGetSicParamsType string

Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Industrial Classification system; `latest_sec` uses the current SIC list as published by the SEC. Defaults to `original_sic`. 

const (
	IndustryGetSicParamsTypeOriginalSic IndustryGetSicParamsType = "original_sic"
	IndustryGetSicParamsTypeLatestSec   IndustryGetSicParamsType = "latest_sec"
)

type IndustryGetSicResponse 

type IndustryGetSicResponse struct {
	// Echoes back which SIC dataset was used to classify the brand.
	//
	// Any of "original_sic", "latest_sec".
	Classification IndustryGetSicResponseClassification `json:"classification"`
	// Array of SIC codes with confidence scores. Extra fields depend on the requested
	// classification: `original_sic` results include `majorGroup` and
	// `majorGroupName`; `latest_sec` results include `office`.
	Codes []IndustryGetSicResponseCode `json:"codes"`
	// Domain found for the brand
	Domain string `json:"domain"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// Industry classification type, for sic api it will be `sic`
	Type string `json:"type"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Classification respjson.Field
		Codes          respjson.Field
		Domain         respjson.Field
		Status         respjson.Field
		Type           respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IndustryGetSicResponse) RawJSON 

func (r IndustryGetSicResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IndustryGetSicResponse) UnmarshalJSON 

func (r *IndustryGetSicResponse) UnmarshalJSON(data []byte) error

type IndustryGetSicResponseClassification 

type IndustryGetSicResponseClassification string

Echoes back which SIC dataset was used to classify the brand. 

const (
	IndustryGetSicResponseClassificationOriginalSic IndustryGetSicResponseClassification = "original_sic"
	IndustryGetSicResponseClassificationLatestSec   IndustryGetSicResponseClassification = "latest_sec"
)

type IndustryGetSicResponseCode 

type IndustryGetSicResponseCode struct {
	// SIC code (4-digit).
	Code string `json:"code" api:"required"`
	// Confidence level for how well this SIC code matches the company description.
	//
	// Any of "high", "medium", "low".
	Confidence string `json:"confidence" api:"required"`
	// SIC industry title.
	Name string `json:"name" api:"required"`
	// 2-digit major group identifier (the leading two digits of the code). Only
	// present when `classification` is `original_sic`.
	MajorGroup string `json:"majorGroup"`
	// Description of the 2-digit major group. Only present when `classification` is
	// `original_sic`.
	MajorGroupName string `json:"majorGroupName"`
	// SEC review office responsible for filings under this code. Only present when
	// `classification` is `latest_sec`.
	Office string `json:"office"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code           respjson.Field
		Confidence     respjson.Field
		Name           respjson.Field
		MajorGroup     respjson.Field
		MajorGroupName respjson.Field
		Office         respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IndustryGetSicResponseCode) RawJSON 

func (r IndustryGetSicResponseCode) RawJSON() string

Returns the unmodified JSON received from the API

func (*IndustryGetSicResponseCode) UnmarshalJSON 

func (r *IndustryGetSicResponseCode) UnmarshalJSON(data []byte) error

type IndustryService 

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

IndustryService contains methods and other services that help with interacting with the context.dev API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewIndustryService method instead.

func NewIndustryService 

func NewIndustryService(opts ...option.RequestOption) (r IndustryService)

NewIndustryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*IndustryService) GetNaics 

func (r *IndustryService) GetNaics(ctx context.Context, query IndustryGetNaicsParams, opts ...option.RequestOption) (res *IndustryGetNaicsResponse, err error)

Classify any brand into 2022 NAICS industry codes from its domain or name.

func (*IndustryService) GetSic 

func (r *IndustryService) GetSic(ctx context.Context, query IndustryGetSicParams, opts ...option.RequestOption) (res *IndustryGetSicResponse, err error)

Classify any brand into Standard Industrial Classification (SIC) codes from its domain or name. Choose between the original SIC system (`original_sic`) or the latest SIC list maintained by the SEC (`latest_sec`).

type UtilityPrefetchByEmailParams 

type UtilityPrefetchByEmailParams struct {
	// Email address to prefetch brand data for. The domain will be extracted from the
	// email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
	// addresses are not allowed.
	Email string `json:"email" api:"required" format:"email"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// contains filtered or unexported fields
}

func (UtilityPrefetchByEmailParams) MarshalJSON 

func (r UtilityPrefetchByEmailParams) MarshalJSON() (data []byte, err error)

func (*UtilityPrefetchByEmailParams) UnmarshalJSON 

func (r *UtilityPrefetchByEmailParams) UnmarshalJSON(data []byte) error

type UtilityPrefetchByEmailResponse 

type UtilityPrefetchByEmailResponse struct {
	// The domain that was queued for prefetching
	Domain string `json:"domain"`
	// Success message
	Message string `json:"message"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Domain      respjson.Field
		Message     respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UtilityPrefetchByEmailResponse) RawJSON 

func (r UtilityPrefetchByEmailResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*UtilityPrefetchByEmailResponse) UnmarshalJSON 

func (r *UtilityPrefetchByEmailResponse) UnmarshalJSON(data []byte) error

type UtilityPrefetchParams 

type UtilityPrefetchParams struct {
	// Domain name to prefetch brand data for
	Domain string `json:"domain" api:"required"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// contains filtered or unexported fields
}

func (UtilityPrefetchParams) MarshalJSON 

func (r UtilityPrefetchParams) MarshalJSON() (data []byte, err error)

func (*UtilityPrefetchParams) UnmarshalJSON 

func (r *UtilityPrefetchParams) UnmarshalJSON(data []byte) error

type UtilityPrefetchResponse 

type UtilityPrefetchResponse struct {
	// The domain that was queued for prefetching
	Domain string `json:"domain"`
	// Success message
	Message string `json:"message"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Domain      respjson.Field
		Message     respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UtilityPrefetchResponse) RawJSON 

func (r UtilityPrefetchResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*UtilityPrefetchResponse) UnmarshalJSON 

func (r *UtilityPrefetchResponse) UnmarshalJSON(data []byte) error

type UtilityService 

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

UtilityService contains methods and other services that help with interacting with the context.dev API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUtilityService method instead.

func NewUtilityService 

func NewUtilityService(opts ...option.RequestOption) (r UtilityService)

NewUtilityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*UtilityService) Prefetch 

func (r *UtilityService) Prefetch(ctx context.Context, body UtilityPrefetchParams, opts ...option.RequestOption) (res *UtilityPrefetchResponse, err error)

Signal that you may fetch brand data for a particular domain soon to improve latency.

func (*UtilityService) PrefetchByEmail 

func (r *UtilityService) PrefetchByEmail(ctx context.Context, body UtilityPrefetchByEmailParams, opts ...option.RequestOption) (res *UtilityPrefetchByEmailResponse, err error)

Signal that you may fetch brand data for a particular domain soon to improve latency. This endpoint accepts an email address, extracts the domain from it, validates that it's not a disposable or free email provider, and queues the domain for prefetching.

type WebExtractFontsParams 

type WebExtractFontsParams struct {
	// A specific URL to fetch fonts from directly, bypassing domain resolution (e.g.,
	// 'https://example.com/design-system'). When provided, fonts are extracted from
	// this exact URL. You must provide either 'domain' or 'directUrl', but not both.
	DirectURL param.Opt[string] `query:"directUrl,omitzero" format:"uri" json:"-"`
	// Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The
	// domain will be automatically normalized and validated. You must provide either
	// 'domain' or 'directUrl', but not both.
	Domain param.Opt[string] `query:"domain,omitzero" json:"-"`
	// Maximum age in milliseconds for cached data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebExtractFontsParams) URLQuery 

func (r WebExtractFontsParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebExtractFontsParams's query parameters as `url.Values`.

type WebExtractFontsResponse 

type WebExtractFontsResponse struct {
	// HTTP status code, e.g., 200
	Code int64 `json:"code" api:"required"`
	// The normalized domain that was processed
	Domain string `json:"domain" api:"required"`
	// Array of font usage information
	Fonts []WebExtractFontsResponseFont `json:"fonts" api:"required"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status" api:"required"`
	// Font assets keyed by family name as it appears in the fonts array (non-generic
	// names only). Clients match entries in fonts to pick a file URL from files.
	// Omitted when no families resolve to Google or custom @font-face URLs.
	FontLinks map[string]WebExtractFontsResponseFontLink `json:"fontLinks"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Domain      respjson.Field
		Fonts       respjson.Field
		Status      respjson.Field
		FontLinks   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractFontsResponse) RawJSON 

func (r WebExtractFontsResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractFontsResponse) UnmarshalJSON 

func (r *WebExtractFontsResponse) UnmarshalJSON(data []byte) error

type WebExtractFontsResponseFont 

type WebExtractFontsResponseFont struct {
	// Array of fallback font families
	Fallbacks []string `json:"fallbacks" api:"required"`
	// Font family name
	Font string `json:"font" api:"required"`
	// Number of elements using this font
	NumElements float64 `json:"num_elements" api:"required"`
	// Number of words using this font
	NumWords float64 `json:"num_words" api:"required"`
	// Percentage of elements using this font
	PercentElements float64 `json:"percent_elements" api:"required"`
	// Percentage of words using this font
	PercentWords float64 `json:"percent_words" api:"required"`
	// Array of CSS selectors or element types where this font is used
	Uses []string `json:"uses" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Fallbacks       respjson.Field
		Font            respjson.Field
		NumElements     respjson.Field
		NumWords        respjson.Field
		PercentElements respjson.Field
		PercentWords    respjson.Field
		Uses            respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractFontsResponseFont) RawJSON 

func (r WebExtractFontsResponseFont) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractFontsResponseFont) UnmarshalJSON 

func (r *WebExtractFontsResponseFont) UnmarshalJSON(data []byte) error
type WebExtractFontsResponseFontLink struct {
	// Upright font files keyed by weight string (e.g. "400" for regular, "500",
	// "700"). Values are absolute URLs.
	Files map[string]string `json:"files" api:"required"`
	// Any of "google", "custom".
	Type string `json:"type" api:"required"`
	// Google Fonts category when type is google (e.g. sans-serif, serif, monospace,
	// display, handwriting). Omitted for custom fonts when unknown.
	Category string `json:"category"`
	// Present when type is custom: human-readable name derived from the fontLinks key
	// (strip build/hash suffixes, split camelCase / PascalCase, normalize separators).
	// Google entries omit this.
	DisplayName string `json:"displayName"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Files       respjson.Field
		Type        respjson.Field
		Category    respjson.Field
		DisplayName respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractFontsResponseFontLink) RawJSON 

func (r WebExtractFontsResponseFontLink) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractFontsResponseFontLink) UnmarshalJSON 

func (r *WebExtractFontsResponseFontLink) UnmarshalJSON(data []byte) error

type WebExtractParams added in v0.5.0 

type WebExtractParams struct {
	// JSON Schema for the returned data object. TypeScript Zod users can pass a JSON
	// Schema generated from a Zod object; Python users can pass the equivalent JSON
	// Schema object.
	Schema map[string]any `json:"schema,omitzero" api:"required"`
	// The starting website URL to crawl and extract from. Must include http:// or
	// https://.
	URL string `json:"url" api:"required" format:"uri"`
	// When true (default), every returned value must be grounded in facts stated on
	// the page; fields that cannot be supported by the page are returned as
	// null/empty. When false, the model may make reasonable inferences and derivations
	// from the page content (e.g. ideal customer, competitor analysis,
	// recommendations) while keeping verifiable specifics (names, quotes, URLs, dates,
	// metrics) faithful to the source.
	FactCheck param.Opt[bool] `json:"factCheck,omitzero"`
	// When true, follow links on subdomains of the starting URL's domain.
	FollowSubdomains param.Opt[bool] `json:"followSubdomains,omitzero"`
	// When true, iframe contents are included in Markdown before extraction.
	IncludeFrames param.Opt[bool] `json:"includeFrames,omitzero"`
	// Optional extraction guidance, such as which facts to prioritize or how to
	// interpret fields in the schema.
	Instructions param.Opt[string] `json:"instructions,omitzero"`
	// Return cached scrape results if a prior scrape for the same parameters is
	// younger than this many milliseconds.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Soft time budget for the crawl in milliseconds.
	StopAfterMs param.Opt[int64] `json:"stopAfterMs,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// Optional browser wait time in milliseconds after initial page load for each
	// crawled page.
	WaitForMs param.Opt[int64]    `json:"waitForMs,omitzero"`
	Pdf       WebExtractParamsPdf `json:"pdf,omitzero"`
	// contains filtered or unexported fields
}

func (WebExtractParams) MarshalJSON added in v0.5.0 

func (r WebExtractParams) MarshalJSON() (data []byte, err error)

func (*WebExtractParams) UnmarshalJSON added in v0.5.0 

func (r *WebExtractParams) UnmarshalJSON(data []byte) error

type WebExtractParamsPdf added in v0.5.0 

type WebExtractParamsPdf struct {
	// Last 1-based PDF page to parse. Must be greater than or equal to start when both
	// are provided.
	End param.Opt[int64] `json:"end,omitzero"`
	// When true, PDF pages are fetched and parsed. When false, PDF pages are skipped.
	ShouldParse param.Opt[bool] `json:"shouldParse,omitzero"`
	// First 1-based PDF page to parse.
	Start param.Opt[int64] `json:"start,omitzero"`
	// contains filtered or unexported fields
}

func (WebExtractParamsPdf) MarshalJSON added in v0.5.0 

func (r WebExtractParamsPdf) MarshalJSON() (data []byte, err error)

func (*WebExtractParamsPdf) UnmarshalJSON added in v0.5.0 

func (r *WebExtractParamsPdf) UnmarshalJSON(data []byte) error

type WebExtractResponse added in v0.5.0 

type WebExtractResponse struct {
	// Extracted data matching the request schema
	Data     map[string]any             `json:"data" api:"required"`
	Metadata WebExtractResponseMetadata `json:"metadata" api:"required"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status" api:"required"`
	// The starting URL that was analyzed
	URL string `json:"url" api:"required"`
	// List of URLs whose Markdown was used for extraction
	URLsAnalyzed []string `json:"urls_analyzed" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data         respjson.Field
		Metadata     respjson.Field
		Status       respjson.Field
		URL          respjson.Field
		URLsAnalyzed respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractResponse) RawJSON added in v0.5.0 

func (r WebExtractResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractResponse) UnmarshalJSON added in v0.5.0 

func (r *WebExtractResponse) UnmarshalJSON(data []byte) error

type WebExtractResponseMetadata added in v0.5.0 

type WebExtractResponseMetadata struct {
	MaxCrawlDepth int64 `json:"maxCrawlDepth" api:"required"`
	NumFailed     int64 `json:"numFailed" api:"required"`
	NumSkipped    int64 `json:"numSkipped" api:"required"`
	NumSucceeded  int64 `json:"numSucceeded" api:"required"`
	NumURLs       int64 `json:"numUrls" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		MaxCrawlDepth respjson.Field
		NumFailed     respjson.Field
		NumSkipped    respjson.Field
		NumSucceeded  respjson.Field
		NumURLs       respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractResponseMetadata) RawJSON added in v0.5.0 

func (r WebExtractResponseMetadata) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractResponseMetadata) UnmarshalJSON added in v0.5.0 

func (r *WebExtractResponseMetadata) UnmarshalJSON(data []byte) error

type WebExtractStyleguideParams 

type WebExtractStyleguideParams struct {
	// A specific URL to fetch the styleguide from directly, bypassing domain
	// resolution (e.g., 'https://example.com/design-system'). When provided, the
	// styleguide is extracted from this exact URL. You must provide either 'domain' or
	// 'directUrl', but not both.
	DirectURL param.Opt[string] `query:"directUrl,omitzero" format:"uri" json:"-"`
	// Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
	// domain will be automatically normalized and validated. You must provide either
	// 'domain' or 'directUrl', but not both.
	Domain param.Opt[string] `query:"domain,omitzero" json:"-"`
	// Maximum age in milliseconds for cached data before the API performs a hard
	// refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
	// are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
	// year.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebExtractStyleguideParams) URLQuery 

func (r WebExtractStyleguideParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebExtractStyleguideParams's query parameters as `url.Values`.

type WebExtractStyleguideResponse 

type WebExtractStyleguideResponse struct {
	// HTTP status code
	Code int64 `json:"code"`
	// The normalized domain that was processed
	Domain string `json:"domain"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// Comprehensive styleguide data extracted from the website
	Styleguide WebExtractStyleguideResponseStyleguide `json:"styleguide"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Domain      respjson.Field
		Status      respjson.Field
		Styleguide  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponse) RawJSON 

func (r WebExtractStyleguideResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponse) UnmarshalJSON 

func (r *WebExtractStyleguideResponse) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguide 

type WebExtractStyleguideResponseStyleguide struct {
	// Primary colors used on the website
	Colors WebExtractStyleguideResponseStyleguideColors `json:"colors" api:"required"`
	// UI component styles
	Components WebExtractStyleguideResponseStyleguideComponents `json:"components" api:"required"`
	// Spacing system used on the website
	ElementSpacing WebExtractStyleguideResponseStyleguideElementSpacing `json:"elementSpacing" api:"required"`
	// Font assets keyed by family name as it appears in fontFamily/fontFallbacks
	// (non-generic names only). Clients match typography.fontFamily / fontWeight or
	// button styles to pick a file URL from files.
	FontLinks map[string]WebExtractStyleguideResponseStyleguideFontLink `json:"fontLinks" api:"required"`
	// The primary color mode of the website design
	//
	// Any of "light", "dark".
	Mode string `json:"mode" api:"required"`
	// Shadow styles used on the website
	Shadows WebExtractStyleguideResponseStyleguideShadows `json:"shadows" api:"required"`
	// Typography styles used on the website
	Typography WebExtractStyleguideResponseStyleguideTypography `json:"typography" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Colors         respjson.Field
		Components     respjson.Field
		ElementSpacing respjson.Field
		FontLinks      respjson.Field
		Mode           respjson.Field
		Shadows        respjson.Field
		Typography     respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Comprehensive styleguide data extracted from the website

func (WebExtractStyleguideResponseStyleguide) RawJSON 

func (r WebExtractStyleguideResponseStyleguide) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguide) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguide) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideColors 

type WebExtractStyleguideResponseStyleguideColors struct {
	// Accent color (hex format)
	Accent string `json:"accent" api:"required"`
	// Background color (hex format)
	Background string `json:"background" api:"required"`
	// Text color (hex format)
	Text string `json:"text" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Accent      respjson.Field
		Background  respjson.Field
		Text        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Primary colors used on the website

func (WebExtractStyleguideResponseStyleguideColors) RawJSON 

func (r WebExtractStyleguideResponseStyleguideColors) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideColors) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideColors) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideComponents 

type WebExtractStyleguideResponseStyleguideComponents struct {
	// Button component styles
	Button WebExtractStyleguideResponseStyleguideComponentsButton `json:"button" api:"required"`
	// Card component style
	Card WebExtractStyleguideResponseStyleguideComponentsCard `json:"card"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Button      respjson.Field
		Card        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

UI component styles

func (WebExtractStyleguideResponseStyleguideComponents) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponents) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponents) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponents) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideComponentsButton 

type WebExtractStyleguideResponseStyleguideComponentsButton struct {
	Link      WebExtractStyleguideResponseStyleguideComponentsButtonLink      `json:"link"`
	Primary   WebExtractStyleguideResponseStyleguideComponentsButtonPrimary   `json:"primary"`
	Secondary WebExtractStyleguideResponseStyleguideComponentsButtonSecondary `json:"secondary"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Link        respjson.Field
		Primary     respjson.Field
		Secondary   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Button component styles

func (WebExtractStyleguideResponseStyleguideComponentsButton) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponentsButton) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponentsButton) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponentsButton) UnmarshalJSON(data []byte) error
type WebExtractStyleguideResponseStyleguideComponentsButtonLink struct {
	BackgroundColor string `json:"backgroundColor" api:"required"`
	// Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
	// alpha)
	BorderColor  string `json:"borderColor" api:"required"`
	BorderRadius string `json:"borderRadius" api:"required"`
	BorderStyle  string `json:"borderStyle" api:"required"`
	BorderWidth  string `json:"borderWidth" api:"required"`
	// Computed box-shadow (comma-separated layers when present)
	BoxShadow string `json:"boxShadow" api:"required"`
	Color     string `json:"color" api:"required"`
	// Ready-to-use CSS declaration block for this component style
	Css        string  `json:"css" api:"required"`
	FontSize   string  `json:"fontSize" api:"required"`
	FontWeight float64 `json:"fontWeight" api:"required"`
	// Sampled minimum height of the button box (typically px)
	MinHeight string `json:"minHeight" api:"required"`
	// Sampled minimum width of the button box (typically px)
	MinWidth       string `json:"minWidth" api:"required"`
	Padding        string `json:"padding" api:"required"`
	TextDecoration string `json:"textDecoration" api:"required"`
	// Full ordered font list from computed font-family
	FontFallbacks []string `json:"fontFallbacks"`
	// Primary button typeface (first in fontFallbacks)
	FontFamily string `json:"fontFamily"`
	// Hex color of the underline when it differs from the text color
	TextDecorationColor string `json:"textDecorationColor"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BackgroundColor     respjson.Field
		BorderColor         respjson.Field
		BorderRadius        respjson.Field
		BorderStyle         respjson.Field
		BorderWidth         respjson.Field
		BoxShadow           respjson.Field
		Color               respjson.Field
		Css                 respjson.Field
		FontSize            respjson.Field
		FontWeight          respjson.Field
		MinHeight           respjson.Field
		MinWidth            respjson.Field
		Padding             respjson.Field
		TextDecoration      respjson.Field
		FontFallbacks       respjson.Field
		FontFamily          respjson.Field
		TextDecorationColor respjson.Field
		ExtraFields         map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideComponentsButtonLink) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponentsButtonLink) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponentsButtonLink) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponentsButtonLink) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideComponentsButtonPrimary 

type WebExtractStyleguideResponseStyleguideComponentsButtonPrimary struct {
	BackgroundColor string `json:"backgroundColor" api:"required"`
	// Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
	// alpha)
	BorderColor  string `json:"borderColor" api:"required"`
	BorderRadius string `json:"borderRadius" api:"required"`
	BorderStyle  string `json:"borderStyle" api:"required"`
	BorderWidth  string `json:"borderWidth" api:"required"`
	// Computed box-shadow (comma-separated layers when present)
	BoxShadow string `json:"boxShadow" api:"required"`
	Color     string `json:"color" api:"required"`
	// Ready-to-use CSS declaration block for this component style
	Css        string  `json:"css" api:"required"`
	FontSize   string  `json:"fontSize" api:"required"`
	FontWeight float64 `json:"fontWeight" api:"required"`
	// Sampled minimum height of the button box (typically px)
	MinHeight string `json:"minHeight" api:"required"`
	// Sampled minimum width of the button box (typically px)
	MinWidth       string `json:"minWidth" api:"required"`
	Padding        string `json:"padding" api:"required"`
	TextDecoration string `json:"textDecoration" api:"required"`
	// Full ordered font list from computed font-family
	FontFallbacks []string `json:"fontFallbacks"`
	// Primary button typeface (first in fontFallbacks)
	FontFamily string `json:"fontFamily"`
	// Hex color of the underline when it differs from the text color
	TextDecorationColor string `json:"textDecorationColor"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BackgroundColor     respjson.Field
		BorderColor         respjson.Field
		BorderRadius        respjson.Field
		BorderStyle         respjson.Field
		BorderWidth         respjson.Field
		BoxShadow           respjson.Field
		Color               respjson.Field
		Css                 respjson.Field
		FontSize            respjson.Field
		FontWeight          respjson.Field
		MinHeight           respjson.Field
		MinWidth            respjson.Field
		Padding             respjson.Field
		TextDecoration      respjson.Field
		FontFallbacks       respjson.Field
		FontFamily          respjson.Field
		TextDecorationColor respjson.Field
		ExtraFields         map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideComponentsButtonPrimary) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponentsButtonPrimary) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponentsButtonPrimary) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponentsButtonPrimary) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideComponentsButtonSecondary 

type WebExtractStyleguideResponseStyleguideComponentsButtonSecondary struct {
	BackgroundColor string `json:"backgroundColor" api:"required"`
	// Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
	// alpha)
	BorderColor  string `json:"borderColor" api:"required"`
	BorderRadius string `json:"borderRadius" api:"required"`
	BorderStyle  string `json:"borderStyle" api:"required"`
	BorderWidth  string `json:"borderWidth" api:"required"`
	// Computed box-shadow (comma-separated layers when present)
	BoxShadow string `json:"boxShadow" api:"required"`
	Color     string `json:"color" api:"required"`
	// Ready-to-use CSS declaration block for this component style
	Css        string  `json:"css" api:"required"`
	FontSize   string  `json:"fontSize" api:"required"`
	FontWeight float64 `json:"fontWeight" api:"required"`
	// Sampled minimum height of the button box (typically px)
	MinHeight string `json:"minHeight" api:"required"`
	// Sampled minimum width of the button box (typically px)
	MinWidth       string `json:"minWidth" api:"required"`
	Padding        string `json:"padding" api:"required"`
	TextDecoration string `json:"textDecoration" api:"required"`
	// Full ordered font list from computed font-family
	FontFallbacks []string `json:"fontFallbacks"`
	// Primary button typeface (first in fontFallbacks)
	FontFamily string `json:"fontFamily"`
	// Hex color of the underline when it differs from the text color
	TextDecorationColor string `json:"textDecorationColor"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BackgroundColor     respjson.Field
		BorderColor         respjson.Field
		BorderRadius        respjson.Field
		BorderStyle         respjson.Field
		BorderWidth         respjson.Field
		BoxShadow           respjson.Field
		Color               respjson.Field
		Css                 respjson.Field
		FontSize            respjson.Field
		FontWeight          respjson.Field
		MinHeight           respjson.Field
		MinWidth            respjson.Field
		Padding             respjson.Field
		TextDecoration      respjson.Field
		FontFallbacks       respjson.Field
		FontFamily          respjson.Field
		TextDecorationColor respjson.Field
		ExtraFields         map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideComponentsButtonSecondary) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponentsButtonSecondary) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponentsButtonSecondary) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponentsButtonSecondary) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideComponentsCard 

type WebExtractStyleguideResponseStyleguideComponentsCard struct {
	BackgroundColor string `json:"backgroundColor" api:"required"`
	// Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
	// alpha)
	BorderColor  string `json:"borderColor" api:"required"`
	BorderRadius string `json:"borderRadius" api:"required"`
	BorderStyle  string `json:"borderStyle" api:"required"`
	BorderWidth  string `json:"borderWidth" api:"required"`
	BoxShadow    string `json:"boxShadow" api:"required"`
	// Ready-to-use CSS declaration block for this component style
	Css       string `json:"css" api:"required"`
	Padding   string `json:"padding" api:"required"`
	TextColor string `json:"textColor" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BackgroundColor respjson.Field
		BorderColor     respjson.Field
		BorderRadius    respjson.Field
		BorderStyle     respjson.Field
		BorderWidth     respjson.Field
		BoxShadow       respjson.Field
		Css             respjson.Field
		Padding         respjson.Field
		TextColor       respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Card component style

func (WebExtractStyleguideResponseStyleguideComponentsCard) RawJSON 

func (r WebExtractStyleguideResponseStyleguideComponentsCard) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideComponentsCard) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideComponentsCard) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideElementSpacing 

type WebExtractStyleguideResponseStyleguideElementSpacing struct {
	Lg string `json:"lg" api:"required"`
	Md string `json:"md" api:"required"`
	Sm string `json:"sm" api:"required"`
	Xl string `json:"xl" api:"required"`
	Xs string `json:"xs" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Lg          respjson.Field
		Md          respjson.Field
		Sm          respjson.Field
		Xl          respjson.Field
		Xs          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Spacing system used on the website

func (WebExtractStyleguideResponseStyleguideElementSpacing) RawJSON 

func (r WebExtractStyleguideResponseStyleguideElementSpacing) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideElementSpacing) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideElementSpacing) UnmarshalJSON(data []byte) error
type WebExtractStyleguideResponseStyleguideFontLink struct {
	// Upright font files keyed by weight string (e.g. "400" for regular, "500",
	// "700"). Values are absolute URLs.
	Files map[string]string `json:"files" api:"required"`
	// Any of "google", "custom".
	Type string `json:"type" api:"required"`
	// Google Fonts category when type is google (e.g. sans-serif, serif, monospace,
	// display, handwriting). Omitted for custom fonts when unknown.
	Category string `json:"category"`
	// Present when type is custom: human-readable name derived from the fontLinks key
	// (strip build/hash suffixes, split camelCase / PascalCase, normalize separators).
	// Google entries omit this.
	DisplayName string `json:"displayName"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Files       respjson.Field
		Type        respjson.Field
		Category    respjson.Field
		DisplayName respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideFontLink) RawJSON 

func (r WebExtractStyleguideResponseStyleguideFontLink) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideFontLink) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideFontLink) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideShadows 

type WebExtractStyleguideResponseStyleguideShadows struct {
	Inner string `json:"inner" api:"required"`
	Lg    string `json:"lg" api:"required"`
	Md    string `json:"md" api:"required"`
	Sm    string `json:"sm" api:"required"`
	Xl    string `json:"xl" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Inner       respjson.Field
		Lg          respjson.Field
		Md          respjson.Field
		Sm          respjson.Field
		Xl          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Shadow styles used on the website

func (WebExtractStyleguideResponseStyleguideShadows) RawJSON 

func (r WebExtractStyleguideResponseStyleguideShadows) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideShadows) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideShadows) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypography 

type WebExtractStyleguideResponseStyleguideTypography struct {
	// Heading styles
	Headings WebExtractStyleguideResponseStyleguideTypographyHeadings `json:"headings" api:"required"`
	P        WebExtractStyleguideResponseStyleguideTypographyP        `json:"p"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Headings    respjson.Field
		P           respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Typography styles used on the website

func (WebExtractStyleguideResponseStyleguideTypography) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypography) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypography) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypography) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyHeadings 

type WebExtractStyleguideResponseStyleguideTypographyHeadings struct {
	H1 WebExtractStyleguideResponseStyleguideTypographyHeadingsH1 `json:"h1"`
	H2 WebExtractStyleguideResponseStyleguideTypographyHeadingsH2 `json:"h2"`
	H3 WebExtractStyleguideResponseStyleguideTypographyHeadingsH3 `json:"h3"`
	H4 WebExtractStyleguideResponseStyleguideTypographyHeadingsH4 `json:"h4"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		H1          respjson.Field
		H2          respjson.Field
		H3          respjson.Field
		H4          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Heading styles

func (WebExtractStyleguideResponseStyleguideTypographyHeadings) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyHeadings) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyHeadings) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyHeadings) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH1 

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH1 struct {
	// Full ordered font list from resolved computed font-family
	FontFallbacks []string `json:"fontFallbacks" api:"required"`
	// Primary face (first family in the computed stack)
	FontFamily    string  `json:"fontFamily" api:"required"`
	FontSize      string  `json:"fontSize" api:"required"`
	FontWeight    float64 `json:"fontWeight" api:"required"`
	LetterSpacing string  `json:"letterSpacing" api:"required"`
	LineHeight    string  `json:"lineHeight" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		FontFallbacks respjson.Field
		FontFamily    respjson.Field
		FontSize      respjson.Field
		FontWeight    respjson.Field
		LetterSpacing respjson.Field
		LineHeight    respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideTypographyHeadingsH1) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyHeadingsH1) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyHeadingsH1) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyHeadingsH1) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH2 

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH2 struct {
	// Full ordered font list from resolved computed font-family
	FontFallbacks []string `json:"fontFallbacks" api:"required"`
	// Primary face (first family in the computed stack)
	FontFamily    string  `json:"fontFamily" api:"required"`
	FontSize      string  `json:"fontSize" api:"required"`
	FontWeight    float64 `json:"fontWeight" api:"required"`
	LetterSpacing string  `json:"letterSpacing" api:"required"`
	LineHeight    string  `json:"lineHeight" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		FontFallbacks respjson.Field
		FontFamily    respjson.Field
		FontSize      respjson.Field
		FontWeight    respjson.Field
		LetterSpacing respjson.Field
		LineHeight    respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideTypographyHeadingsH2) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyHeadingsH2) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyHeadingsH2) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyHeadingsH2) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH3 

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH3 struct {
	// Full ordered font list from resolved computed font-family
	FontFallbacks []string `json:"fontFallbacks" api:"required"`
	// Primary face (first family in the computed stack)
	FontFamily    string  `json:"fontFamily" api:"required"`
	FontSize      string  `json:"fontSize" api:"required"`
	FontWeight    float64 `json:"fontWeight" api:"required"`
	LetterSpacing string  `json:"letterSpacing" api:"required"`
	LineHeight    string  `json:"lineHeight" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		FontFallbacks respjson.Field
		FontFamily    respjson.Field
		FontSize      respjson.Field
		FontWeight    respjson.Field
		LetterSpacing respjson.Field
		LineHeight    respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideTypographyHeadingsH3) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyHeadingsH3) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyHeadingsH3) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyHeadingsH3) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH4 

type WebExtractStyleguideResponseStyleguideTypographyHeadingsH4 struct {
	// Full ordered font list from resolved computed font-family
	FontFallbacks []string `json:"fontFallbacks" api:"required"`
	// Primary face (first family in the computed stack)
	FontFamily    string  `json:"fontFamily" api:"required"`
	FontSize      string  `json:"fontSize" api:"required"`
	FontWeight    float64 `json:"fontWeight" api:"required"`
	LetterSpacing string  `json:"letterSpacing" api:"required"`
	LineHeight    string  `json:"lineHeight" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		FontFallbacks respjson.Field
		FontFamily    respjson.Field
		FontSize      respjson.Field
		FontWeight    respjson.Field
		LetterSpacing respjson.Field
		LineHeight    respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideTypographyHeadingsH4) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyHeadingsH4) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyHeadingsH4) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyHeadingsH4) UnmarshalJSON(data []byte) error

type WebExtractStyleguideResponseStyleguideTypographyP 

type WebExtractStyleguideResponseStyleguideTypographyP struct {
	// Full ordered font list from resolved computed font-family
	FontFallbacks []string `json:"fontFallbacks" api:"required"`
	// Primary face (first family in the computed stack)
	FontFamily    string  `json:"fontFamily" api:"required"`
	FontSize      string  `json:"fontSize" api:"required"`
	FontWeight    float64 `json:"fontWeight" api:"required"`
	LetterSpacing string  `json:"letterSpacing" api:"required"`
	LineHeight    string  `json:"lineHeight" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		FontFallbacks respjson.Field
		FontFamily    respjson.Field
		FontSize      respjson.Field
		FontWeight    respjson.Field
		LetterSpacing respjson.Field
		LineHeight    respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebExtractStyleguideResponseStyleguideTypographyP) RawJSON 

func (r WebExtractStyleguideResponseStyleguideTypographyP) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebExtractStyleguideResponseStyleguideTypographyP) UnmarshalJSON 

func (r *WebExtractStyleguideResponseStyleguideTypographyP) UnmarshalJSON(data []byte) error

type WebScreenshotParams 

type WebScreenshotParams struct {
	// A specific URL to screenshot directly, bypassing domain resolution (e.g.,
	// 'https://example.com/pricing'). When provided, the screenshot is taken of this
	// exact URL. You must provide either 'domain' or 'directUrl', but not both.
	DirectURL param.Opt[string] `query:"directUrl,omitzero" format:"uri" json:"-"`
	// Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
	// domain will be automatically normalized and validated. You must provide either
	// 'domain' or 'directUrl', but not both.
	Domain param.Opt[string] `query:"domain,omitzero" json:"-"`
	// Return a cached screenshot if a prior screenshot for the same parameters exists
	// and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional browser wait time in milliseconds after initial page load before taking
	// the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
	// omitted.
	WaitForMs param.Opt[int64] `query:"waitForMs,omitzero" json:"-"`
	// Optional parameter to determine screenshot type. If 'true', takes a full page
	// screenshot capturing all content. If 'false' or not provided, takes a viewport
	// screenshot (standard browser view).
	//
	// Any of "true", "false".
	FullScreenshot WebScreenshotParamsFullScreenshot `query:"fullScreenshot,omitzero" json:"-"`
	// Optional parameter to control cookie/consent popup handling. If 'true', we
	// dismiss cookie banner before capture. If 'false' or not provided, captures the
	// page without that step.
	//
	// Any of "true", "false".
	HandleCookiePopup WebScreenshotParamsHandleCookiePopup `query:"handleCookiePopup,omitzero" json:"-"`
	// Optional parameter to specify which page type to screenshot. If provided, the
	// system will scrape the domain's links and use heuristics to find the most
	// appropriate URL for the specified page type (30 supported languages). If not
	// provided, screenshots the main domain landing page. Only applicable when using
	// 'domain', not 'directUrl'.
	//
	// Any of "login", "signup", "blog", "careers", "pricing", "terms", "privacy",
	// "contact".
	Page WebScreenshotParamsPage `query:"page,omitzero" json:"-"`
	// Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
	Viewport WebScreenshotParamsViewport `query:"viewport,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebScreenshotParams) URLQuery 

func (r WebScreenshotParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebScreenshotParams's query parameters as `url.Values`.

type WebScreenshotParamsFullScreenshot 

type WebScreenshotParamsFullScreenshot string

Optional parameter to determine screenshot type. If 'true', takes a full page screenshot capturing all content. If 'false' or not provided, takes a viewport screenshot (standard browser view). 

const (
	WebScreenshotParamsFullScreenshotTrue  WebScreenshotParamsFullScreenshot = "true"
	WebScreenshotParamsFullScreenshotFalse WebScreenshotParamsFullScreenshot = "false"
)

type WebScreenshotParamsHandleCookiePopup 

type WebScreenshotParamsHandleCookiePopup string

Optional parameter to control cookie/consent popup handling. If 'true', we dismiss cookie banner before capture. If 'false' or not provided, captures the page without that step. 

const (
	WebScreenshotParamsHandleCookiePopupTrue  WebScreenshotParamsHandleCookiePopup = "true"
	WebScreenshotParamsHandleCookiePopupFalse WebScreenshotParamsHandleCookiePopup = "false"
)

type WebScreenshotParamsPage 

type WebScreenshotParamsPage string

Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain's links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page. Only applicable when using 'domain', not 'directUrl'. 

const (
	WebScreenshotParamsPageLogin   WebScreenshotParamsPage = "login"
	WebScreenshotParamsPageSignup  WebScreenshotParamsPage = "signup"
	WebScreenshotParamsPageBlog    WebScreenshotParamsPage = "blog"
	WebScreenshotParamsPageCareers WebScreenshotParamsPage = "careers"
	WebScreenshotParamsPagePricing WebScreenshotParamsPage = "pricing"
	WebScreenshotParamsPageTerms   WebScreenshotParamsPage = "terms"
	WebScreenshotParamsPagePrivacy WebScreenshotParamsPage = "privacy"
	WebScreenshotParamsPageContact WebScreenshotParamsPage = "contact"
)

type WebScreenshotParamsViewport 

type WebScreenshotParamsViewport struct {
	// Viewport height in pixels.
	Height param.Opt[int64] `query:"height,omitzero" json:"-"`
	// Viewport width in pixels.
	Width param.Opt[int64] `query:"width,omitzero" json:"-"`
	// contains filtered or unexported fields
}

Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.

func (WebScreenshotParamsViewport) URLQuery 

func (r WebScreenshotParamsViewport) URLQuery() (v url.Values, err error)

URLQuery serializes WebScreenshotParamsViewport's query parameters as `url.Values`.

type WebScreenshotResponse 

type WebScreenshotResponse struct {
	// HTTP status code
	Code int64 `json:"code"`
	// The normalized domain that was processed
	Domain string `json:"domain"`
	// Height in pixels of the returned screenshot image
	Height int64 `json:"height"`
	// Public URL of the uploaded screenshot image
	Screenshot string `json:"screenshot"`
	// Type of screenshot that was captured
	//
	// Any of "viewport", "fullPage".
	ScreenshotType WebScreenshotResponseScreenshotType `json:"screenshotType"`
	// Status of the response, e.g., 'ok'
	Status string `json:"status"`
	// Width in pixels of the returned screenshot image
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code           respjson.Field
		Domain         respjson.Field
		Height         respjson.Field
		Screenshot     respjson.Field
		ScreenshotType respjson.Field
		Status         respjson.Field
		Width          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebScreenshotResponse) RawJSON 

func (r WebScreenshotResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebScreenshotResponse) UnmarshalJSON 

func (r *WebScreenshotResponse) UnmarshalJSON(data []byte) error

type WebScreenshotResponseScreenshotType 

type WebScreenshotResponseScreenshotType string

Type of screenshot that was captured 

const (
	WebScreenshotResponseScreenshotTypeViewport WebScreenshotResponseScreenshotType = "viewport"
	WebScreenshotResponseScreenshotTypeFullPage WebScreenshotResponseScreenshotType = "fullPage"
)

type WebSearchParams added in v0.1.0 

type WebSearchParams struct {
	// Natural-language search query.
	Query string `json:"query" api:"required"`
	// Expand the query into multiple parallel variants for broader recall.
	QueryFanout param.Opt[bool] `json:"queryFanout,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// Blocklist — drop results from these domains. Example: ["pinterest.com",
	// "reddit.com"].
	ExcludeDomains []string `json:"excludeDomains,omitzero"`
	// Restrict results to content published within this window.
	//
	// Any of "last_24_hours", "last_week", "last_month", "last_year".
	Freshness WebSearchParamsFreshness `json:"freshness,omitzero"`
	// Allowlist — only return results from these domains. Example: ["arxiv.org",
	// "github.com"].
	IncludeDomains []string `json:"includeDomains,omitzero"`
	// Inline Markdown scraping for each result. Set `enabled: true` to activate.
	MarkdownOptions WebSearchParamsMarkdownOptions `json:"markdownOptions,omitzero"`
	// contains filtered or unexported fields
}

func (WebSearchParams) MarshalJSON added in v0.1.0 

func (r WebSearchParams) MarshalJSON() (data []byte, err error)

func (*WebSearchParams) UnmarshalJSON added in v0.1.0 

func (r *WebSearchParams) UnmarshalJSON(data []byte) error

type WebSearchParamsFreshness added in v0.1.0 

type WebSearchParamsFreshness string

Restrict results to content published within this window. 

const (
	WebSearchParamsFreshnessLast24Hours WebSearchParamsFreshness = "last_24_hours"
	WebSearchParamsFreshnessLastWeek    WebSearchParamsFreshness = "last_week"
	WebSearchParamsFreshnessLastMonth   WebSearchParamsFreshness = "last_month"
	WebSearchParamsFreshnessLastYear    WebSearchParamsFreshness = "last_year"
)

type WebSearchParamsMarkdownOptions added in v0.1.0 

type WebSearchParamsMarkdownOptions struct {
	// Scrape each result to Markdown. Off by default to keep search cheap and fast.
	Enabled param.Opt[bool] `json:"enabled,omitzero"`
	// Render iframe contents into the Markdown.
	IncludeFrames param.Opt[bool] `json:"includeFrames,omitzero"`
	// Emit image references in the Markdown.
	IncludeImages param.Opt[bool] `json:"includeImages,omitzero"`
	// Keep hyperlinks in the Markdown.
	IncludeLinks param.Opt[bool] `json:"includeLinks,omitzero"`
	// Cache TTL in ms for scraped Markdown keyed by URL + options. Default 1 day, max
	// 30 days. Set to 0 to force a fresh scrape.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Truncate inline base64 image payloads to keep responses small.
	ShortenBase64Images param.Opt[bool] `json:"shortenBase64Images,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// Strip nav, header, footer, and sidebar — keep only the primary article content.
	UseMainContentOnly param.Opt[bool] `json:"useMainContentOnly,omitzero"`
	// Extra wait after page load before rendering, in ms (0–30000). Useful for
	// JS-heavy pages.
	WaitForMs param.Opt[int64] `json:"waitForMs,omitzero"`
	// PDF handling. Use start/end to bound text extraction and OCR to a page range.
	Pdf WebSearchParamsMarkdownOptionsPdf `json:"pdf,omitzero"`
	// contains filtered or unexported fields
}

Inline Markdown scraping for each result. Set `enabled: true` to activate.

func (WebSearchParamsMarkdownOptions) MarshalJSON added in v0.1.0 

func (r WebSearchParamsMarkdownOptions) MarshalJSON() (data []byte, err error)

func (*WebSearchParamsMarkdownOptions) UnmarshalJSON added in v0.1.0 

func (r *WebSearchParamsMarkdownOptions) UnmarshalJSON(data []byte) error

type WebSearchParamsMarkdownOptionsPdf added in v0.1.0 

type WebSearchParamsMarkdownOptionsPdf struct {
	// Last PDF page to parse (1-based, inclusive). Defaults to the final page. Must
	// be >= start.
	End param.Opt[int64] `json:"end,omitzero"`
	// Parse PDF URLs. When false, PDF results are skipped with WEBSITE_ACCESS_ERROR.
	ShouldParse param.Opt[bool] `json:"shouldParse,omitzero"`
	// First PDF page to parse (1-based, inclusive). Defaults to page 1.
	Start param.Opt[int64] `json:"start,omitzero"`
	// contains filtered or unexported fields
}

PDF handling. Use start/end to bound text extraction and OCR to a page range.

func (WebSearchParamsMarkdownOptionsPdf) MarshalJSON added in v0.1.0 

func (r WebSearchParamsMarkdownOptionsPdf) MarshalJSON() (data []byte, err error)

func (*WebSearchParamsMarkdownOptionsPdf) UnmarshalJSON added in v0.1.0 

func (r *WebSearchParamsMarkdownOptionsPdf) UnmarshalJSON(data []byte) error

type WebSearchResponse added in v0.1.0 

type WebSearchResponse struct {
	// Echo of the original query (useful when fanout was enabled).
	Query   string                    `json:"query" api:"required"`
	Results []WebSearchResponseResult `json:"results" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Query       respjson.Field
		Results     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebSearchResponse) RawJSON added in v0.1.0 

func (r WebSearchResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebSearchResponse) UnmarshalJSON added in v0.1.0 

func (r *WebSearchResponse) UnmarshalJSON(data []byte) error

type WebSearchResponseResult added in v0.1.0 

type WebSearchResponseResult struct {
	// Snippet excerpt from the page.
	Description string `json:"description" api:"required"`
	// Markdown scrape status and content for this result.
	Markdown WebSearchResponseResultMarkdown `json:"markdown" api:"required"`
	// Relevance to the original query.
	//
	// Any of "high", "medium", "low".
	Relevance string `json:"relevance" api:"required"`
	// Page title.
	Title string `json:"title" api:"required"`
	// Canonical result URL.
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Description respjson.Field
		Markdown    respjson.Field
		Relevance   respjson.Field
		Title       respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebSearchResponseResult) RawJSON added in v0.1.0 

func (r WebSearchResponseResult) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebSearchResponseResult) UnmarshalJSON added in v0.1.0 

func (r *WebSearchResponseResult) UnmarshalJSON(data []byte) error

type WebSearchResponseResultMarkdown added in v0.1.0 

type WebSearchResponseResultMarkdown struct {
	// Per-result scrape outcome. Inspect this before reading `markdown`.
	//
	// Any of "SUCCESS", "NOT_REQUESTED", "TIMEOUT", "WEBSITE_ACCESS_ERROR", "ERROR".
	Code string `json:"code" api:"required"`
	// GFM Markdown of the page. Null unless markdownOptions.enabled is true and
	// scraping succeeded.
	Markdown string `json:"markdown" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Markdown    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Markdown scrape status and content for this result.

func (WebSearchResponseResultMarkdown) RawJSON added in v0.1.0 

func (r WebSearchResponseResultMarkdown) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebSearchResponseResultMarkdown) UnmarshalJSON added in v0.1.0 

func (r *WebSearchResponseResultMarkdown) UnmarshalJSON(data []byte) error

type WebService 

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

WebService contains methods and other services that help with interacting with the context.dev API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWebService method instead.

func NewWebService 

func NewWebService(opts ...option.RequestOption) (r WebService)

NewWebService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WebService) Extract added in v0.5.0 

func (r *WebService) Extract(ctx context.Context, body WebExtractParams, opts ...option.RequestOption) (res *WebExtractResponse, err error)

Crawl a website, convert pages to Markdown using the scrape cache, and extract structured data into the provided JSON Schema. The schema must describe the response data object. This endpoint does not accept targeted page-type selection.

func (*WebService) ExtractFonts 

func (r *WebService) ExtractFonts(ctx context.Context, query WebExtractFontsParams, opts ...option.RequestOption) (res *WebExtractFontsResponse, err error)

Scrape font information from a website including font families, usage statistics, fallbacks, and element/word counts.

func (*WebService) ExtractStyleguide 

func (r *WebService) ExtractStyleguide(ctx context.Context, query WebExtractStyleguideParams, opts ...option.RequestOption) (res *WebExtractStyleguideResponse, err error)

Extract a comprehensive design system from a website including colors, typography, spacing, shadows, and UI components.

func (*WebService) Screenshot 

func (r *WebService) Screenshot(ctx context.Context, query WebScreenshotParams, opts ...option.RequestOption) (res *WebScreenshotResponse, err error)

Capture a screenshot of a website.

func (*WebService) Search added in v0.1.0 

func (r *WebService) Search(ctx context.Context, body WebSearchParams, opts ...option.RequestOption) (res *WebSearchResponse, err error)

Search the web and optionally scrape each result to Markdown in one round-trip.

func (*WebService) WebCrawlMd 

func (r *WebService) WebCrawlMd(ctx context.Context, body WebWebCrawlMdParams, opts ...option.RequestOption) (res *WebWebCrawlMdResponse, err error)

Performs a crawl starting from a given URL, extracts page content as Markdown, and returns results for all crawled pages.

func (*WebService) WebScrapeHTML 

func (r *WebService) WebScrapeHTML(ctx context.Context, query WebWebScrapeHTMLParams, opts ...option.RequestOption) (res *WebWebScrapeHTMLResponse, err error)

Scrapes the given URL and returns the raw HTML content of the page.

func (*WebService) WebScrapeImages 

func (r *WebService) WebScrapeImages(ctx context.Context, query WebWebScrapeImagesParams, opts ...option.RequestOption) (res *WebWebScrapeImagesResponse, err error)

Extract image assets from a web page, including standard URLs, inline SVGs, data URIs, responsive image sources, metadata, CSS backgrounds, video posters, and embeds. The base request costs 1 credit. When enrichment is enabled, the entire call costs 5 credits.

func (*WebService) WebScrapeMd 

func (r *WebService) WebScrapeMd(ctx context.Context, query WebWebScrapeMdParams, opts ...option.RequestOption) (res *WebWebScrapeMdResponse, err error)

Scrapes the given URL into LLM usable Markdown.

func (*WebService) WebScrapeSitemap 

func (r *WebService) WebScrapeSitemap(ctx context.Context, query WebWebScrapeSitemapParams, opts ...option.RequestOption) (res *WebWebScrapeSitemapResponse, err error)

Crawl an entire website's sitemap and return all discovered page URLs.

type WebWebCrawlMdParams 

type WebWebCrawlMdParams struct {
	// The starting URL for the crawl (must include http:// or https:// protocol)
	URL string `json:"url" api:"required" format:"uri"`
	// When true, follow links on subdomains of the starting URL's domain (e.g.
	// docs.example.com when starting from example.com). www and apex are always
	// treated as equivalent.
	FollowSubdomains param.Opt[bool] `json:"followSubdomains,omitzero"`
	// When true, the contents of iframes are rendered to Markdown for each crawled
	// page.
	IncludeFrames param.Opt[bool] `json:"includeFrames,omitzero"`
	// Include image references in the Markdown output
	IncludeImages param.Opt[bool] `json:"includeImages,omitzero"`
	// Preserve hyperlinks in the Markdown output
	IncludeLinks param.Opt[bool] `json:"includeLinks,omitzero"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `json:"maxAgeMs,omitzero"`
	// Maximum link depth from the starting URL (0 = only the starting page)
	MaxDepth param.Opt[int64] `json:"maxDepth,omitzero"`
	// Maximum number of pages to crawl. Hard cap: 500.
	MaxPages param.Opt[int64] `json:"maxPages,omitzero"`
	// Truncate base64-encoded image data in the Markdown output
	ShortenBase64Images param.Opt[bool] `json:"shortenBase64Images,omitzero"`
	// Soft time budget for the crawl in milliseconds. After each scrape, the crawler
	// checks the elapsed time and, if exceeded, returns the pages collected so far
	// instead of continuing. Min: 10000 (10s). Max: 240000 (4 min). Default: 120000 (2
	// min).
	StopAfterMs param.Opt[int64] `json:"stopAfterMs,omitzero"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `json:"timeoutMS,omitzero"`
	// Regex pattern. Only URLs matching this pattern will be followed and scraped.
	URLRegex param.Opt[string] `json:"urlRegex,omitzero"`
	// Extract only the main content, stripping headers, footers, sidebars, and
	// navigation
	UseMainContentOnly param.Opt[bool] `json:"useMainContentOnly,omitzero"`
	// Optional browser wait time in milliseconds after initial page load for each
	// crawled page. Min: 0. Max: 30000 (30 seconds).
	WaitForMs param.Opt[int64] `json:"waitForMs,omitzero"`
	// PDF parsing controls. Use start/end to limit text extraction and OCR to an
	// inclusive 1-based page range.
	Pdf WebWebCrawlMdParamsPdf `json:"pdf,omitzero"`
	// contains filtered or unexported fields
}

func (WebWebCrawlMdParams) MarshalJSON 

func (r WebWebCrawlMdParams) MarshalJSON() (data []byte, err error)

func (*WebWebCrawlMdParams) UnmarshalJSON 

func (r *WebWebCrawlMdParams) UnmarshalJSON(data []byte) error

type WebWebCrawlMdParamsPdf 

type WebWebCrawlMdParamsPdf struct {
	// Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
	// Must be greater than or equal to start when both are provided.
	End param.Opt[int64] `json:"end,omitzero"`
	// When true, PDF pages are fetched and parsed. When false, PDF pages are skipped
	// entirely (not included in results and not counted as failures).
	ShouldParse param.Opt[bool] `json:"shouldParse,omitzero"`
	// First 1-based PDF page to parse. When omitted, parsing starts at the first page.
	Start param.Opt[int64] `json:"start,omitzero"`
	// contains filtered or unexported fields
}

PDF parsing controls. Use start/end to limit text extraction and OCR to an inclusive 1-based page range.

func (WebWebCrawlMdParamsPdf) MarshalJSON 

func (r WebWebCrawlMdParamsPdf) MarshalJSON() (data []byte, err error)

func (*WebWebCrawlMdParamsPdf) UnmarshalJSON 

func (r *WebWebCrawlMdParamsPdf) UnmarshalJSON(data []byte) error

type WebWebCrawlMdResponse 

type WebWebCrawlMdResponse struct {
	Metadata WebWebCrawlMdResponseMetadata `json:"metadata" api:"required"`
	Results  []WebWebCrawlMdResponseResult `json:"results" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Metadata    respjson.Field
		Results     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebCrawlMdResponse) RawJSON 

func (r WebWebCrawlMdResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebCrawlMdResponse) UnmarshalJSON 

func (r *WebWebCrawlMdResponse) UnmarshalJSON(data []byte) error

type WebWebCrawlMdResponseMetadata 

type WebWebCrawlMdResponseMetadata struct {
	// Maximum crawl depth reached during the crawl
	MaxCrawlDepth int64 `json:"maxCrawlDepth" api:"required"`
	// Number of pages that failed to crawl
	NumFailed int64 `json:"numFailed" api:"required"`
	// Number of URLs skipped (PDFs when pdf.shouldParse=false, or URLs not matching
	// urlRegex)
	NumSkipped int64 `json:"numSkipped" api:"required"`
	// Number of pages successfully crawled
	NumSucceeded int64 `json:"numSucceeded" api:"required"`
	// Total number of URLs crawled
	NumURLs int64 `json:"numUrls" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		MaxCrawlDepth respjson.Field
		NumFailed     respjson.Field
		NumSkipped    respjson.Field
		NumSucceeded  respjson.Field
		NumURLs       respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebCrawlMdResponseMetadata) RawJSON 

func (r WebWebCrawlMdResponseMetadata) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebCrawlMdResponseMetadata) UnmarshalJSON 

func (r *WebWebCrawlMdResponseMetadata) UnmarshalJSON(data []byte) error

type WebWebCrawlMdResponseResult 

type WebWebCrawlMdResponseResult struct {
	// Extracted page content as Markdown (empty string on failure)
	Markdown string                              `json:"markdown" api:"required"`
	Metadata WebWebCrawlMdResponseResultMetadata `json:"metadata" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Markdown    respjson.Field
		Metadata    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebCrawlMdResponseResult) RawJSON 

func (r WebWebCrawlMdResponseResult) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebCrawlMdResponseResult) UnmarshalJSON 

func (r *WebWebCrawlMdResponseResult) UnmarshalJSON(data []byte) error

type WebWebCrawlMdResponseResultMetadata 

type WebWebCrawlMdResponseResultMetadata struct {
	// Depth relative to the start URL. 0 = start URL, 1 = one link away.
	CrawlDepth int64 `json:"crawlDepth" api:"required"`
	// HTTP status code of the response
	StatusCode int64 `json:"statusCode" api:"required"`
	// true if the page was fetched and parsed successfully
	Success bool `json:"success" api:"required"`
	// The page's <title> content (empty string if unavailable)
	Title string `json:"title" api:"required"`
	// The URL that was fetched
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		CrawlDepth  respjson.Field
		StatusCode  respjson.Field
		Success     respjson.Field
		Title       respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebCrawlMdResponseResultMetadata) RawJSON 

func (r WebWebCrawlMdResponseResultMetadata) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebCrawlMdResponseResultMetadata) UnmarshalJSON 

func (r *WebWebCrawlMdResponseResultMetadata) UnmarshalJSON(data []byte) error

type WebWebScrapeHTMLParams 

type WebWebScrapeHTMLParams struct {
	// Full URL to scrape (must include http:// or https:// protocol)
	URL string `query:"url" api:"required" format:"uri" json:"-"`
	// When true, iframes are rendered inline into the returned HTML.
	IncludeFrames param.Opt[bool] `query:"includeFrames,omitzero" json:"-"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
	// 30000 (30 seconds).
	WaitForMs param.Opt[int64] `query:"waitForMs,omitzero" json:"-"`
	// PDF parsing controls. Use start/end to limit text extraction and OCR to an
	// inclusive 1-based page range.
	Pdf WebWebScrapeHTMLParamsPdf `query:"pdf,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebWebScrapeHTMLParams) URLQuery 

func (r WebWebScrapeHTMLParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeHTMLParams's query parameters as `url.Values`.

type WebWebScrapeHTMLParamsPdf 

type WebWebScrapeHTMLParamsPdf struct {
	// Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
	// Must be greater than or equal to start when both are provided.
	End param.Opt[int64] `query:"end,omitzero" json:"-"`
	// When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
	// a 400 WEBSITE_ACCESS_ERROR is returned.
	ShouldParse param.Opt[bool] `query:"shouldParse,omitzero" json:"-"`
	// First 1-based PDF page to parse. When omitted, parsing starts at the first page.
	Start param.Opt[int64] `query:"start,omitzero" json:"-"`
	// contains filtered or unexported fields
}

PDF parsing controls. Use start/end to limit text extraction and OCR to an inclusive 1-based page range.

func (WebWebScrapeHTMLParamsPdf) URLQuery 

func (r WebWebScrapeHTMLParamsPdf) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeHTMLParamsPdf's query parameters as `url.Values`.

type WebWebScrapeHTMLResponse 

type WebWebScrapeHTMLResponse struct {
	// Raw HTML content of the page
	HTML string `json:"html" api:"required"`
	// Indicates success
	//
	// Any of true.
	Success bool `json:"success" api:"required"`
	// The URL that was scraped
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		HTML        respjson.Field
		Success     respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebScrapeHTMLResponse) RawJSON 

func (r WebWebScrapeHTMLResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeHTMLResponse) UnmarshalJSON 

func (r *WebWebScrapeHTMLResponse) UnmarshalJSON(data []byte) error

type WebWebScrapeImagesParams 

type WebWebScrapeImagesParams struct {
	// Page URL to inspect. Must include http:// or https://.
	URL string `query:"url" api:"required" format:"uri" json:"-"`
	// Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
	// day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional browser wait time in milliseconds after initial page load before
	// collecting images. Min: 0. Max: 30000 (30 seconds).
	WaitForMs param.Opt[int64] `query:"waitForMs,omitzero" json:"-"`
	// Optional per-image processing, sent as deep-object query params such as
	// enrichment[resolution]=true.
	Enrichment WebWebScrapeImagesParamsEnrichment `query:"enrichment,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebWebScrapeImagesParams) URLQuery 

func (r WebWebScrapeImagesParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeImagesParams's query parameters as `url.Values`.

type WebWebScrapeImagesParamsEnrichment 

type WebWebScrapeImagesParamsEnrichment struct {
	// Classify each image by visual asset type.
	Classification param.Opt[bool] `query:"classification,omitzero" json:"-"`
	// Host materializable images on the Brand.dev CDN and return their URL and MIME
	// type.
	HostedURL param.Opt[bool] `query:"hostedUrl,omitzero" json:"-"`
	// Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
	MaxTimePerMs param.Opt[int64] `query:"maxTimePerMs,omitzero" json:"-"`
	// Measure image width and height when possible.
	Resolution param.Opt[bool] `query:"resolution,omitzero" json:"-"`
	// contains filtered or unexported fields
}

Optional per-image processing, sent as deep-object query params such as enrichment[resolution]=true.

func (WebWebScrapeImagesParamsEnrichment) URLQuery 

func (r WebWebScrapeImagesParamsEnrichment) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeImagesParamsEnrichment's query parameters as `url.Values`.

type WebWebScrapeImagesResponse 

type WebWebScrapeImagesResponse struct {
	// Images found on the page.
	Images []WebWebScrapeImagesResponseImage `json:"images" api:"required"`
	// Always true on success.
	//
	// Any of true.
	Success bool `json:"success" api:"required"`
	// Page URL that was scraped.
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Images      respjson.Field
		Success     respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebScrapeImagesResponse) RawJSON 

func (r WebWebScrapeImagesResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeImagesResponse) UnmarshalJSON 

func (r *WebWebScrapeImagesResponse) UnmarshalJSON(data []byte) error

type WebWebScrapeImagesResponseImage 

type WebWebScrapeImagesResponseImage struct {
	// Image alt text, or null when unavailable.
	Alt string `json:"alt" api:"required"`
	// Where the image was found.
	//
	// Any of "img", "svg", "link", "source", "video", "css", "object", "meta",
	// "background".
	Element string `json:"element" api:"required"`
	// Original image value: URL, inline SVG or HTML, or base64 data URI.
	Src string `json:"src" api:"required"`
	// Format of src.
	//
	// Any of "url", "html", "base64".
	Type string `json:"type" api:"required"`
	// Requested metadata for images that could be processed.
	Enrichment WebWebScrapeImagesResponseImageEnrichment `json:"enrichment"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Alt         respjson.Field
		Element     respjson.Field
		Src         respjson.Field
		Type        respjson.Field
		Enrichment  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebScrapeImagesResponseImage) RawJSON 

func (r WebWebScrapeImagesResponseImage) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeImagesResponseImage) UnmarshalJSON 

func (r *WebWebScrapeImagesResponseImage) UnmarshalJSON(data []byte) error

type WebWebScrapeImagesResponseImageEnrichment 

type WebWebScrapeImagesResponseImageEnrichment struct {
	// Image height in pixels, when measured.
	Height int64 `json:"height"`
	// Detected MIME type, when hosted.
	Mimetype string `json:"mimetype"`
	// Visual asset category, when classified.
	//
	// Any of "photography", "illustration", "logo", "wordmark", "icon", "pattern",
	// "graphic", "other".
	Type string `json:"type"`
	// Brand.dev CDN URL, when hosted.
	URL string `json:"url" format:"uri"`
	// Image width in pixels, when measured.
	Width int64 `json:"width"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Height      respjson.Field
		Mimetype    respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		Width       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Requested metadata for images that could be processed.

func (WebWebScrapeImagesResponseImageEnrichment) RawJSON 

func (r WebWebScrapeImagesResponseImageEnrichment) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeImagesResponseImageEnrichment) UnmarshalJSON 

func (r *WebWebScrapeImagesResponseImageEnrichment) UnmarshalJSON(data []byte) error

type WebWebScrapeMdParams 

type WebWebScrapeMdParams struct {
	// Full URL to scrape into LLM usable Markdown (must include http:// or https://
	// protocol)
	URL string `query:"url" api:"required" format:"uri" json:"-"`
	// When true, the contents of iframes are rendered to Markdown.
	IncludeFrames param.Opt[bool] `query:"includeFrames,omitzero" json:"-"`
	// Include image references in Markdown output
	IncludeImages param.Opt[bool] `query:"includeImages,omitzero" json:"-"`
	// Preserve hyperlinks in Markdown output
	IncludeLinks param.Opt[bool] `query:"includeLinks,omitzero" json:"-"`
	// Return a cached result if a prior scrape for the same parameters exists and is
	// younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
	// omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
	MaxAgeMs param.Opt[int64] `query:"maxAgeMs,omitzero" json:"-"`
	// Shorten base64-encoded image data in the Markdown output
	ShortenBase64Images param.Opt[bool] `query:"shortenBase64Images,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Extract only the main content of the page, excluding headers, footers, sidebars,
	// and navigation
	UseMainContentOnly param.Opt[bool] `query:"useMainContentOnly,omitzero" json:"-"`
	// Optional browser wait time in milliseconds after initial page load before
	// converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
	WaitForMs param.Opt[int64] `query:"waitForMs,omitzero" json:"-"`
	// PDF parsing controls. Use start/end to limit text extraction and OCR to an
	// inclusive 1-based page range.
	Pdf WebWebScrapeMdParamsPdf `query:"pdf,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebWebScrapeMdParams) URLQuery 

func (r WebWebScrapeMdParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeMdParams's query parameters as `url.Values`.

type WebWebScrapeMdParamsPdf 

type WebWebScrapeMdParamsPdf struct {
	// Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
	// Must be greater than or equal to start when both are provided.
	End param.Opt[int64] `query:"end,omitzero" json:"-"`
	// When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
	// a 400 WEBSITE_ACCESS_ERROR is returned.
	ShouldParse param.Opt[bool] `query:"shouldParse,omitzero" json:"-"`
	// First 1-based PDF page to parse. When omitted, parsing starts at the first page.
	Start param.Opt[int64] `query:"start,omitzero" json:"-"`
	// contains filtered or unexported fields
}

PDF parsing controls. Use start/end to limit text extraction and OCR to an inclusive 1-based page range.

func (WebWebScrapeMdParamsPdf) URLQuery 

func (r WebWebScrapeMdParamsPdf) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeMdParamsPdf's query parameters as `url.Values`.

type WebWebScrapeMdResponse 

type WebWebScrapeMdResponse struct {
	// Page content converted to GitHub Flavored Markdown
	Markdown string `json:"markdown" api:"required"`
	// Indicates success
	//
	// Any of true.
	Success bool `json:"success" api:"required"`
	// The URL that was scraped
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Markdown    respjson.Field
		Success     respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebScrapeMdResponse) RawJSON 

func (r WebWebScrapeMdResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeMdResponse) UnmarshalJSON 

func (r *WebWebScrapeMdResponse) UnmarshalJSON(data []byte) error

type WebWebScrapeSitemapParams 

type WebWebScrapeSitemapParams struct {
	// Domain to build a sitemap for
	Domain string `query:"domain" api:"required" json:"-"`
	// Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
	// Minimum is 1, maximum is 100,000.
	MaxLinks param.Opt[int64] `query:"maxLinks,omitzero" json:"-"`
	// Optional timeout in milliseconds for the request. If the request takes longer
	// than this value, it will be aborted with a 408 status code. Maximum allowed
	// value is 300000ms (5 minutes).
	TimeoutMs param.Opt[int64] `query:"timeoutMS,omitzero" json:"-"`
	// Optional RE2-compatible regex pattern. Only URLs matching this pattern are
	// returned and counted against maxLinks.
	URLRegex param.Opt[string] `query:"urlRegex,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WebWebScrapeSitemapParams) URLQuery 

func (r WebWebScrapeSitemapParams) URLQuery() (v url.Values, err error)

URLQuery serializes WebWebScrapeSitemapParams's query parameters as `url.Values`.

type WebWebScrapeSitemapResponse 

type WebWebScrapeSitemapResponse struct {
	// The normalized domain that was crawled
	Domain string `json:"domain" api:"required"`
	// Metadata about the sitemap crawl operation
	Meta WebWebScrapeSitemapResponseMeta `json:"meta" api:"required"`
	// Indicates success
	//
	// Any of true.
	Success bool `json:"success" api:"required"`
	// Array of discovered page URLs from the sitemap (max 500)
	URLs []string `json:"urls" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Domain      respjson.Field
		Meta        respjson.Field
		Success     respjson.Field
		URLs        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WebWebScrapeSitemapResponse) RawJSON 

func (r WebWebScrapeSitemapResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeSitemapResponse) UnmarshalJSON 

func (r *WebWebScrapeSitemapResponse) UnmarshalJSON(data []byte) error

type WebWebScrapeSitemapResponseMeta 

type WebWebScrapeSitemapResponseMeta struct {
	// Number of errors encountered during crawling
	Errors int64 `json:"errors" api:"required"`
	// Total number of sitemap files discovered
	SitemapsDiscovered int64 `json:"sitemapsDiscovered" api:"required"`
	// Number of sitemap files successfully fetched and parsed
	SitemapsFetched int64 `json:"sitemapsFetched" api:"required"`
	// Number of sitemap files skipped (due to errors, timeouts, or limits)
	SitemapsSkipped int64 `json:"sitemapsSkipped" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Errors             respjson.Field
		SitemapsDiscovered respjson.Field
		SitemapsFetched    respjson.Field
		SitemapsSkipped    respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Metadata about the sitemap crawl operation

func (WebWebScrapeSitemapResponseMeta) RawJSON 

func (r WebWebScrapeSitemapResponseMeta) RawJSON() string

Returns the unmodified JSON received from the API

func (*WebWebScrapeSitemapResponseMeta) UnmarshalJSON 

func (r *WebWebScrapeSitemapResponseMeta) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
respjson
shared
constant

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.