berrycrawl

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

README

Berrycrawl Go SDK

The official Go SDK for scraping, crawling, searching, mapping, structured extraction, screenshots, and brand profiles.

Documentation · Dashboard · GitHub

Table of Contents

Reference

A full reference for this library is available here.

Usage

Set BERRYCRAWL_API_KEY to an API key from the Berrycrawl dashboard.

package main

import (
    "context"
    "fmt"

    berrycrawl "github.com/strawberry-labs/berrycrawl-go"
    berryclient "github.com/strawberry-labs/berrycrawl-go/client"
)

func main() {
    client := berryclient.New() // reads BERRYCRAWL_API_KEY
    page, err := client.Scrape(context.Background(), &berrycrawl.ScrapeDto{
        URL: berrycrawl.String("https://example.com/pricing"),
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(page)
}

ctx := context.Background()
job, err := client.Crawl(ctx, &berrycrawl.CrawlDto{
    URL: "https://example.com/docs",
    Limit: berrycrawl.Float64(50),
})

results, err := client.Search(ctx, &berrycrawl.SearchDto{
    Query: "best headless browser libraries",
})
Retrieve a brand profile
brand, err := client.Brand.Retrieve(ctx, &berrycrawl.BrandDto{
    URL: "https://stripe.com",
})
Brand design system

Brand responses include an optional branding object for compatibility with older API deployments. When available, it contains the rendered light/dark scheme, semantic colors, typography, spacing, representative input and button styles, and semantic image roles. Use branding.images.favicon for the square icon and branding.images.logo for the wordmark.

Environments

You can choose between different environments by using the option.WithBaseURL option. You can configure any arbitrary base URL, which is particularly useful in test environments.

client := client.New(
    option.WithBaseURL(berrycrawl.Environments.Production),
)

Errors

Structured error types are returned from API calls that return non-success status codes. These errors are compatible with the errors.Is and errors.As APIs, so you can access the error like so:

response, err := client.Brand.Retrieve(...)
if err != nil {
    var apiError *core.APIError
    if errors.As(err, &apiError) {
        // Do something with the API error ...
    }
    return err
}

Request Options

A variety of request options are included to adapt the behavior of the library, which includes configuring authorization tokens, or providing your own instrumented *http.Client.

These request options can either be specified on the client so that they're applied on every request, or for an individual request, like so:

Providing your own *http.Client is recommended. Otherwise, the http.DefaultClient will be used, and your client will wait indefinitely for a response (unless the per-request, context-based timeout is used).

// Specify default options applied on every request.
client := client.New(
    option.WithAPIKey("<YOUR_API_KEY>"),
    option.WithHTTPClient(
        &http.Client{
            Timeout: 5 * time.Second,
        },
    ),
)

// Specify options for an individual request.
response, err := client.Brand.Retrieve(
    ...,
    option.WithAPIKey("<YOUR_API_KEY>"),
)

Advanced

Response Headers

You can access the raw HTTP response data by using the WithRawResponse field on the client. This is useful when you need to examine the response headers received from the API call. (When the endpoint is paginated, the raw HTTP response data will be included automatically in the Page response object.)

response, err := client.Brand.WithRawResponse.Retrieve(...)
if err != nil {
    return err
}
fmt.Printf("Got response headers: %v", response.Header)
fmt.Printf("Got status code: %d", response.StatusCode)
Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

If the Retry-After header is present in the response, the SDK will prioritize respecting its value exactly over the default exponential backoff.

Use the option.WithMaxAttempts option to configure this behavior for the entire client or an individual request:

client := client.New(
    option.WithMaxAttempts(1),
)

response, err := client.Brand.Retrieve(
    ...,
    option.WithMaxAttempts(1),
)
Timeouts

Setting a timeout for each individual request is as simple as using the standard context library. Setting a one second timeout for an individual API call looks like the following:

ctx, cancel := context.WithTimeout(ctx, time.Second)
defer cancel()

response, err := client.Brand.Retrieve(ctx, ...)
Explicit Null

If you want to send the explicit null JSON value through an optional parameter, you can use the setters
that come with every object. Calling a setter method for a property will flip a bit in the explicitFields bitfield for that setter's object; during serialization, any property with a flipped bit will have its omittable status stripped, so zero or nil values will be sent explicitly rather than omitted altogether:

type ExampleRequest struct {
    // An optional string parameter.
    Name *string `json:"name,omitempty" url:"-"`

    // Private bitmask of fields set to an explicit value and therefore not to be omitted
    explicitFields *big.Int `json:"-" url:"-"`
}

request := &ExampleRequest{}
request.SetName(nil)

response, err := client.Brand.Retrieve(ctx, request, ...)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Environments = struct {
	Production string
}{
	Production: "https://api.berrycrawl.com/api/v1",
}

Environments defines all of the API environments. These values can be used with the WithBaseURL RequestOption to override the client's default environment, if any.

View Source 
var ErrorCodes internal.ErrorCodes = internal.ErrorCodes{
	400: func(apiError *core.APIError) error {
		return &BadRequestError{
			APIError: apiError,
		}
	},
	401: func(apiError *core.APIError) error {
		return &UnauthorizedError{
			APIError: apiError,
		}
	},
	404: func(apiError *core.APIError) error {
		return &NotFoundError{
			APIError: apiError,
		}
	},
	429: func(apiError *core.APIError) error {
		return &TooManyRequestsError{
			APIError: apiError,
		}
	},
}

Functions

func Bool 

func Bool(b bool) *bool

Bool returns a pointer to the given bool value.

func Byte 

func Byte(b byte) *byte

Byte returns a pointer to the given byte value.

func Bytes 

func Bytes(b []byte) *[]byte

Bytes returns a pointer to the given []byte value.

func Complex64 

func Complex64(c complex64) *complex64

Complex64 returns a pointer to the given complex64 value.

func Complex128 

func Complex128(c complex128) *complex128

Complex128 returns a pointer to the given complex128 value.

func Float32 

func Float32(f float32) *float32

Float32 returns a pointer to the given float32 value.

func Float64 

func Float64(f float64) *float64

Float64 returns a pointer to the given float64 value.

func Int 

func Int(i int) *int

Int returns a pointer to the given int value.

func Int8 

func Int8(i int8) *int8

Int8 returns a pointer to the given int8 value.

func Int16 

func Int16(i int16) *int16

Int16 returns a pointer to the given int16 value.

func Int32 

func Int32(i int32) *int32

Int32 returns a pointer to the given int32 value.

func Int64 

func Int64(i int64) *int64

Int64 returns a pointer to the given int64 value.

func MustParseDate 

func MustParseDate(date string) time.Time

MustParseDate attempts to parse the given string as a date time.Time, and panics upon failure.

func MustParseDateTime 

func MustParseDateTime(datetime string) time.Time

MustParseDateTime attempts to parse the given string as a datetime time.Time, and panics upon failure.

func Rune 

func Rune(r rune) *rune

Rune returns a pointer to the given rune value.

func String 

func String(s string) *string

String returns a pointer to the given string value.

func Time 

func Time(t time.Time) *time.Time

Time returns a pointer to the given time.Time value.

func UUID 

func UUID(u uuid.UUID) *uuid.UUID

UUID returns a pointer to the given uuid.UUID value.

func Uint 

func Uint(u uint) *uint

Uint returns a pointer to the given uint value.

func Uint8 

func Uint8(u uint8) *uint8

Uint8 returns a pointer to the given uint8 value.

func Uint16 

func Uint16(u uint16) *uint16

Uint16 returns a pointer to the given uint16 value.

func Uint32 

func Uint32(u uint32) *uint32

Uint32 returns a pointer to the given uint32 value.

func Uint64 

func Uint64(u uint64) *uint64

Uint64 returns a pointer to the given uint64 value.

func Uintptr 

func Uintptr(u uintptr) *uintptr

Uintptr returns a pointer to the given uintptr value.

Types

type AccountResponse 

type AccountResponse struct {
	Data    *AccountResponseData `json:"data" url:"data"`
	Success bool                 `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*AccountResponse) GetData 

func (a *AccountResponse) GetData() *AccountResponseData

func (*AccountResponse) GetExtraProperties 

func (a *AccountResponse) GetExtraProperties() map[string]interface{}

func (*AccountResponse) GetSuccess 

func (a *AccountResponse) GetSuccess() bool

func (*AccountResponse) MarshalJSON 

func (a *AccountResponse) MarshalJSON() ([]byte, error)

func (*AccountResponse) SetData 

func (a *AccountResponse) SetData(data *AccountResponseData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponse) SetSuccess 

func (a *AccountResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponse) String 

func (a *AccountResponse) String() string

func (*AccountResponse) UnmarshalJSON 

func (a *AccountResponse) UnmarshalJSON(data []byte) error

type AccountResponseData 

type AccountResponseData struct {
	CreatedAt        time.Time                 `json:"createdAt" url:"createdAt"`
	Credits          int                       `json:"credits" url:"credits"`
	Email            string                    `json:"email" url:"email"`
	ID               string                    `json:"id" url:"id"`
	LifetimeSpendUsd float64                   `json:"lifetimeSpendUsd" url:"lifetimeSpendUsd"`
	Plan             *AccountResponseDataPlan  `json:"plan" url:"plan"`
	Queue            *AccountResponseDataQueue `json:"queue" url:"queue"`
	// contains filtered or unexported fields
}

func (*AccountResponseData) GetCreatedAt 

func (a *AccountResponseData) GetCreatedAt() time.Time

func (*AccountResponseData) GetCredits 

func (a *AccountResponseData) GetCredits() int

func (*AccountResponseData) GetEmail 

func (a *AccountResponseData) GetEmail() string

func (*AccountResponseData) GetExtraProperties 

func (a *AccountResponseData) GetExtraProperties() map[string]interface{}

func (*AccountResponseData) GetID 

func (a *AccountResponseData) GetID() string

func (*AccountResponseData) GetLifetimeSpendUsd 

func (a *AccountResponseData) GetLifetimeSpendUsd() float64

func (*AccountResponseData) GetPlan 

func (a *AccountResponseData) GetPlan() *AccountResponseDataPlan

func (*AccountResponseData) GetQueue 

func (a *AccountResponseData) GetQueue() *AccountResponseDataQueue

func (*AccountResponseData) MarshalJSON 

func (a *AccountResponseData) MarshalJSON() ([]byte, error)

func (*AccountResponseData) SetCreatedAt 

func (a *AccountResponseData) SetCreatedAt(createdAt time.Time)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetCredits 

func (a *AccountResponseData) SetCredits(credits int)

SetCredits sets the Credits field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetEmail 

func (a *AccountResponseData) SetEmail(email string)

SetEmail sets the Email field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetID 

func (a *AccountResponseData) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetLifetimeSpendUsd 

func (a *AccountResponseData) SetLifetimeSpendUsd(lifetimeSpendUsd float64)

SetLifetimeSpendUsd sets the LifetimeSpendUsd field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetPlan 

func (a *AccountResponseData) SetPlan(plan *AccountResponseDataPlan)

SetPlan sets the Plan field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) SetQueue 

func (a *AccountResponseData) SetQueue(queue *AccountResponseDataQueue)

SetQueue sets the Queue field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseData) String 

func (a *AccountResponseData) String() string

func (*AccountResponseData) UnmarshalJSON 

func (a *AccountResponseData) UnmarshalJSON(data []byte) error

type AccountResponseDataPlan 

type AccountResponseDataPlan struct {
	Concurrency        int    `json:"concurrency" url:"concurrency"`
	ID                 string `json:"id" url:"id"`
	Name               string `json:"name" url:"name"`
	QueueLimit         int    `json:"queueLimit" url:"queueLimit"`
	RateLimitPerMinute int    `json:"rateLimitPerMinute" url:"rateLimitPerMinute"`
	// contains filtered or unexported fields
}

func (*AccountResponseDataPlan) GetConcurrency 

func (a *AccountResponseDataPlan) GetConcurrency() int

func (*AccountResponseDataPlan) GetExtraProperties 

func (a *AccountResponseDataPlan) GetExtraProperties() map[string]interface{}

func (*AccountResponseDataPlan) GetID 

func (a *AccountResponseDataPlan) GetID() string

func (*AccountResponseDataPlan) GetName 

func (a *AccountResponseDataPlan) GetName() string

func (*AccountResponseDataPlan) GetQueueLimit 

func (a *AccountResponseDataPlan) GetQueueLimit() int

func (*AccountResponseDataPlan) GetRateLimitPerMinute 

func (a *AccountResponseDataPlan) GetRateLimitPerMinute() int

func (*AccountResponseDataPlan) MarshalJSON 

func (a *AccountResponseDataPlan) MarshalJSON() ([]byte, error)

func (*AccountResponseDataPlan) SetConcurrency 

func (a *AccountResponseDataPlan) SetConcurrency(concurrency int)

SetConcurrency sets the Concurrency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataPlan) SetID 

func (a *AccountResponseDataPlan) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataPlan) SetName 

func (a *AccountResponseDataPlan) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataPlan) SetQueueLimit 

func (a *AccountResponseDataPlan) SetQueueLimit(queueLimit int)

SetQueueLimit sets the QueueLimit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataPlan) SetRateLimitPerMinute 

func (a *AccountResponseDataPlan) SetRateLimitPerMinute(rateLimitPerMinute int)

SetRateLimitPerMinute sets the RateLimitPerMinute field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataPlan) String 

func (a *AccountResponseDataPlan) String() string

func (*AccountResponseDataPlan) UnmarshalJSON 

func (a *AccountResponseDataPlan) UnmarshalJSON(data []byte) error

type AccountResponseDataQueue 

type AccountResponseDataQueue struct {
	Active  int `json:"active" url:"active"`
	Waiting int `json:"waiting" url:"waiting"`
	// contains filtered or unexported fields
}

func (*AccountResponseDataQueue) GetActive 

func (a *AccountResponseDataQueue) GetActive() int

func (*AccountResponseDataQueue) GetExtraProperties 

func (a *AccountResponseDataQueue) GetExtraProperties() map[string]interface{}

func (*AccountResponseDataQueue) GetWaiting 

func (a *AccountResponseDataQueue) GetWaiting() int

func (*AccountResponseDataQueue) MarshalJSON 

func (a *AccountResponseDataQueue) MarshalJSON() ([]byte, error)

func (*AccountResponseDataQueue) SetActive 

func (a *AccountResponseDataQueue) SetActive(active int)

SetActive sets the Active field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataQueue) SetWaiting 

func (a *AccountResponseDataQueue) SetWaiting(waiting int)

SetWaiting sets the Waiting field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AccountResponseDataQueue) String 

func (a *AccountResponseDataQueue) String() string

func (*AccountResponseDataQueue) UnmarshalJSON 

func (a *AccountResponseDataQueue) UnmarshalJSON(data []byte) error

type ActionDto 

type ActionDto struct {
	Amount       *float64            `json:"amount,omitempty" url:"amount,omitempty"`
	Direction    *ActionDtoDirection `json:"direction,omitempty" url:"direction,omitempty"`
	Key          *string             `json:"key,omitempty" url:"key,omitempty"`
	Milliseconds *float64            `json:"milliseconds,omitempty" url:"milliseconds,omitempty"`
	Selector     *string             `json:"selector,omitempty" url:"selector,omitempty"`
	Text         *string             `json:"text,omitempty" url:"text,omitempty"`
	Type         ActionDtoType       `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*ActionDto) GetAmount 

func (a *ActionDto) GetAmount() *float64

func (*ActionDto) GetDirection 

func (a *ActionDto) GetDirection() *ActionDtoDirection

func (*ActionDto) GetExtraProperties 

func (a *ActionDto) GetExtraProperties() map[string]interface{}

func (*ActionDto) GetKey 

func (a *ActionDto) GetKey() *string

func (*ActionDto) GetMilliseconds 

func (a *ActionDto) GetMilliseconds() *float64

func (*ActionDto) GetSelector 

func (a *ActionDto) GetSelector() *string

func (*ActionDto) GetText 

func (a *ActionDto) GetText() *string

func (*ActionDto) GetType 

func (a *ActionDto) GetType() ActionDtoType

func (*ActionDto) MarshalJSON 

func (a *ActionDto) MarshalJSON() ([]byte, error)

func (*ActionDto) SetAmount 

func (a *ActionDto) SetAmount(amount *float64)

SetAmount sets the Amount field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetDirection 

func (a *ActionDto) SetDirection(direction *ActionDtoDirection)

SetDirection sets the Direction field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetKey 

func (a *ActionDto) SetKey(key *string)

SetKey sets the Key field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetMilliseconds 

func (a *ActionDto) SetMilliseconds(milliseconds *float64)

SetMilliseconds sets the Milliseconds field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetSelector 

func (a *ActionDto) SetSelector(selector *string)

SetSelector sets the Selector field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetText 

func (a *ActionDto) SetText(text *string)

SetText sets the Text field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) SetType 

func (a *ActionDto) SetType(type_ ActionDtoType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ActionDto) String 

func (a *ActionDto) String() string

func (*ActionDto) UnmarshalJSON 

func (a *ActionDto) UnmarshalJSON(data []byte) error

type ActionDtoDirection 

type ActionDtoDirection string
const (
	ActionDtoDirectionUp   ActionDtoDirection = "up"
	ActionDtoDirectionDown ActionDtoDirection = "down"
)

func NewActionDtoDirectionFromString 

func NewActionDtoDirectionFromString(s string) (ActionDtoDirection, error)

func (ActionDtoDirection) Ptr 

func (a ActionDtoDirection) Ptr() *ActionDtoDirection

type ActionDtoType 

type ActionDtoType string
const (
	ActionDtoTypeWait       ActionDtoType = "wait"
	ActionDtoTypeClick      ActionDtoType = "click"
	ActionDtoTypeWrite      ActionDtoType = "write"
	ActionDtoTypePress      ActionDtoType = "press"
	ActionDtoTypeScroll     ActionDtoType = "scroll"
	ActionDtoTypeScrape     ActionDtoType = "scrape"
	ActionDtoTypeScreenshot ActionDtoType = "screenshot"
	ActionDtoTypePdf        ActionDtoType = "pdf"
)

func NewActionDtoTypeFromString 

func NewActionDtoTypeFromString(s string) (ActionDtoType, error)

func (ActionDtoType) Ptr 

func (a ActionDtoType) Ptr() *ActionDtoType

type AgentConfigDto 

type AgentConfigDto struct {
	// Model routing mode. "default" uses the fast default model; "smart" uses the higher-latency reasoning model.
	Mode *AgentConfigDtoMode `json:"mode,omitempty" url:"mode,omitempty"`
	// Explicit AI model to use. Omit for the configured default, or set "smart" to use the configured smart model.
	Model *string `json:"model,omitempty" url:"model,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentConfigDto) GetExtraProperties 

func (a *AgentConfigDto) GetExtraProperties() map[string]interface{}

func (*AgentConfigDto) GetMode 

func (a *AgentConfigDto) GetMode() *AgentConfigDtoMode

func (*AgentConfigDto) GetModel 

func (a *AgentConfigDto) GetModel() *string

func (*AgentConfigDto) MarshalJSON 

func (a *AgentConfigDto) MarshalJSON() ([]byte, error)

func (*AgentConfigDto) SetMode 

func (a *AgentConfigDto) SetMode(mode *AgentConfigDtoMode)

SetMode sets the Mode field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AgentConfigDto) SetModel 

func (a *AgentConfigDto) SetModel(model *string)

SetModel sets the Model field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*AgentConfigDto) String 

func (a *AgentConfigDto) String() string

func (*AgentConfigDto) UnmarshalJSON 

func (a *AgentConfigDto) UnmarshalJSON(data []byte) error

type AgentConfigDtoMode 

type AgentConfigDtoMode string

Model routing mode. "default" uses the fast default model; "smart" uses the higher-latency reasoning model. 

const (
	AgentConfigDtoModeDefault AgentConfigDtoMode = "default"
	AgentConfigDtoModeSmart   AgentConfigDtoMode = "smart"
)

func NewAgentConfigDtoModeFromString 

func NewAgentConfigDtoModeFromString(s string) (AgentConfigDtoMode, error)

func (AgentConfigDtoMode) Ptr 

func (a AgentConfigDtoMode) Ptr() *AgentConfigDtoMode

type BadRequestError 

type BadRequestError struct {
	*core.APIError
	Body any
}

Invalid website URL or insufficient credits

func (*BadRequestError) MarshalJSON 

func (b *BadRequestError) MarshalJSON() ([]byte, error)

func (*BadRequestError) UnmarshalJSON 

func (b *BadRequestError) UnmarshalJSON(data []byte) error

func (*BadRequestError) Unwrap 

func (b *BadRequestError) Unwrap() error

type BrandAsset 

type BrandAsset struct {
	Height *int    `json:"height,omitempty" url:"height,omitempty"`
	Theme  *string `json:"theme,omitempty" url:"theme,omitempty"`
	Type   string  `json:"type" url:"type"`
	URL    string  `json:"url" url:"url"`
	Width  *int    `json:"width,omitempty" url:"width,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandAsset) GetExtraProperties 

func (b *BrandAsset) GetExtraProperties() map[string]interface{}

func (*BrandAsset) GetHeight 

func (b *BrandAsset) GetHeight() *int

func (*BrandAsset) GetTheme 

func (b *BrandAsset) GetTheme() *string

func (*BrandAsset) GetType 

func (b *BrandAsset) GetType() string

func (*BrandAsset) GetURL 

func (b *BrandAsset) GetURL() string

func (*BrandAsset) GetWidth 

func (b *BrandAsset) GetWidth() *int

func (*BrandAsset) MarshalJSON 

func (b *BrandAsset) MarshalJSON() ([]byte, error)

func (*BrandAsset) SetHeight 

func (b *BrandAsset) SetHeight(height *int)

SetHeight sets the Height field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandAsset) SetTheme 

func (b *BrandAsset) SetTheme(theme *string)

SetTheme sets the Theme field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandAsset) SetType 

func (b *BrandAsset) SetType(type_ string)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandAsset) SetURL 

func (b *BrandAsset) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandAsset) SetWidth 

func (b *BrandAsset) SetWidth(width *int)

SetWidth sets the Width field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandAsset) String 

func (b *BrandAsset) String() string

func (*BrandAsset) UnmarshalJSON 

func (b *BrandAsset) UnmarshalJSON(data []byte) error

type BrandComponentStyle added in v0.2.0 

type BrandComponentStyle struct {
	Background   *string `json:"background,omitempty" url:"background,omitempty"`
	BorderColor  *string `json:"borderColor,omitempty" url:"borderColor,omitempty"`
	BorderRadius *string `json:"borderRadius,omitempty" url:"borderRadius,omitempty"`
	Shadow       *string `json:"shadow,omitempty" url:"shadow,omitempty"`
	TextColor    *string `json:"textColor,omitempty" url:"textColor,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandComponentStyle) GetBackground added in v0.2.0 

func (b *BrandComponentStyle) GetBackground() *string

func (*BrandComponentStyle) GetBorderColor added in v0.2.0 

func (b *BrandComponentStyle) GetBorderColor() *string

func (*BrandComponentStyle) GetBorderRadius added in v0.2.0 

func (b *BrandComponentStyle) GetBorderRadius() *string

func (*BrandComponentStyle) GetExtraProperties added in v0.2.0 

func (b *BrandComponentStyle) GetExtraProperties() map[string]interface{}

func (*BrandComponentStyle) GetShadow added in v0.2.0 

func (b *BrandComponentStyle) GetShadow() *string

func (*BrandComponentStyle) GetTextColor added in v0.2.0 

func (b *BrandComponentStyle) GetTextColor() *string

func (*BrandComponentStyle) MarshalJSON added in v0.2.0 

func (b *BrandComponentStyle) MarshalJSON() ([]byte, error)

func (*BrandComponentStyle) SetBackground added in v0.2.0 

func (b *BrandComponentStyle) SetBackground(background *string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandComponentStyle) SetBorderColor added in v0.2.0 

func (b *BrandComponentStyle) SetBorderColor(borderColor *string)

SetBorderColor sets the BorderColor field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandComponentStyle) SetBorderRadius added in v0.2.0 

func (b *BrandComponentStyle) SetBorderRadius(borderRadius *string)

SetBorderRadius sets the BorderRadius field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandComponentStyle) SetShadow added in v0.2.0 

func (b *BrandComponentStyle) SetShadow(shadow *string)

SetShadow sets the Shadow field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandComponentStyle) SetTextColor added in v0.2.0 

func (b *BrandComponentStyle) SetTextColor(textColor *string)

SetTextColor sets the TextColor field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandComponentStyle) String added in v0.2.0 

func (b *BrandComponentStyle) String() string

func (*BrandComponentStyle) UnmarshalJSON added in v0.2.0 

func (b *BrandComponentStyle) UnmarshalJSON(data []byte) error

type BrandDesignSystem added in v0.2.0 

type BrandDesignSystem struct {
	Colors      *BrandDesignSystemColors     `json:"colors" url:"colors"`
	ColorScheme BrandDesignSystemColorScheme `json:"colorScheme" url:"colorScheme"`
	Components  *BrandDesignSystemComponents `json:"components" url:"components"`
	Images      *BrandDesignSystemImages     `json:"images" url:"images"`
	Spacing     *BrandDesignSystemSpacing    `json:"spacing" url:"spacing"`
	Typography  *BrandDesignSystemTypography `json:"typography" url:"typography"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystem) GetColorScheme added in v0.2.0 

func (b *BrandDesignSystem) GetColorScheme() BrandDesignSystemColorScheme

func (*BrandDesignSystem) GetColors added in v0.2.0 

func (b *BrandDesignSystem) GetColors() *BrandDesignSystemColors

func (*BrandDesignSystem) GetComponents added in v0.2.0 

func (b *BrandDesignSystem) GetComponents() *BrandDesignSystemComponents

func (*BrandDesignSystem) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystem) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystem) GetImages added in v0.2.0 

func (b *BrandDesignSystem) GetImages() *BrandDesignSystemImages

func (*BrandDesignSystem) GetSpacing added in v0.2.0 

func (b *BrandDesignSystem) GetSpacing() *BrandDesignSystemSpacing

func (*BrandDesignSystem) GetTypography added in v0.2.0 

func (b *BrandDesignSystem) GetTypography() *BrandDesignSystemTypography

func (*BrandDesignSystem) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystem) MarshalJSON() ([]byte, error)

func (*BrandDesignSystem) SetColorScheme added in v0.2.0 

func (b *BrandDesignSystem) SetColorScheme(colorScheme BrandDesignSystemColorScheme)

SetColorScheme sets the ColorScheme field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) SetColors added in v0.2.0 

func (b *BrandDesignSystem) SetColors(colors *BrandDesignSystemColors)

SetColors sets the Colors field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) SetComponents added in v0.2.0 

func (b *BrandDesignSystem) SetComponents(components *BrandDesignSystemComponents)

SetComponents sets the Components field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) SetImages added in v0.2.0 

func (b *BrandDesignSystem) SetImages(images *BrandDesignSystemImages)

SetImages sets the Images field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) SetSpacing added in v0.2.0 

func (b *BrandDesignSystem) SetSpacing(spacing *BrandDesignSystemSpacing)

SetSpacing sets the Spacing field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) SetTypography added in v0.2.0 

func (b *BrandDesignSystem) SetTypography(typography *BrandDesignSystemTypography)

SetTypography sets the Typography field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystem) String added in v0.2.0 

func (b *BrandDesignSystem) String() string

func (*BrandDesignSystem) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystem) UnmarshalJSON(data []byte) error

type BrandDesignSystemColorScheme added in v0.2.0 

type BrandDesignSystemColorScheme string
const (
	BrandDesignSystemColorSchemeLight BrandDesignSystemColorScheme = "light"
	BrandDesignSystemColorSchemeDark  BrandDesignSystemColorScheme = "dark"
)

func NewBrandDesignSystemColorSchemeFromString added in v0.2.0 

func NewBrandDesignSystemColorSchemeFromString(s string) (BrandDesignSystemColorScheme, error)

func (BrandDesignSystemColorScheme) Ptr added in v0.2.0 

func (b BrandDesignSystemColorScheme) Ptr() *BrandDesignSystemColorScheme

type BrandDesignSystemColors added in v0.2.0 

type BrandDesignSystemColors struct {
	Accent      *string `json:"accent,omitempty" url:"accent,omitempty"`
	Background  *string `json:"background,omitempty" url:"background,omitempty"`
	Link        *string `json:"link,omitempty" url:"link,omitempty"`
	Primary     *string `json:"primary,omitempty" url:"primary,omitempty"`
	Secondary   *string `json:"secondary,omitempty" url:"secondary,omitempty"`
	TextPrimary *string `json:"textPrimary,omitempty" url:"textPrimary,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemColors) GetAccent added in v0.2.0 

func (b *BrandDesignSystemColors) GetAccent() *string

func (*BrandDesignSystemColors) GetBackground added in v0.2.0 

func (b *BrandDesignSystemColors) GetBackground() *string

func (*BrandDesignSystemColors) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemColors) GetExtraProperties() map[string]interface{}
func (b *BrandDesignSystemColors) GetLink() *string

func (*BrandDesignSystemColors) GetPrimary added in v0.2.0 

func (b *BrandDesignSystemColors) GetPrimary() *string

func (*BrandDesignSystemColors) GetSecondary added in v0.2.0 

func (b *BrandDesignSystemColors) GetSecondary() *string

func (*BrandDesignSystemColors) GetTextPrimary added in v0.2.0 

func (b *BrandDesignSystemColors) GetTextPrimary() *string

func (*BrandDesignSystemColors) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemColors) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemColors) SetAccent added in v0.2.0 

func (b *BrandDesignSystemColors) SetAccent(accent *string)

SetAccent sets the Accent field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemColors) SetBackground added in v0.2.0 

func (b *BrandDesignSystemColors) SetBackground(background *string)

SetBackground sets the Background field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (b *BrandDesignSystemColors) SetLink(link *string)

SetLink sets the Link field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemColors) SetPrimary added in v0.2.0 

func (b *BrandDesignSystemColors) SetPrimary(primary *string)

SetPrimary sets the Primary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemColors) SetSecondary added in v0.2.0 

func (b *BrandDesignSystemColors) SetSecondary(secondary *string)

SetSecondary sets the Secondary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemColors) SetTextPrimary added in v0.2.0 

func (b *BrandDesignSystemColors) SetTextPrimary(textPrimary *string)

SetTextPrimary sets the TextPrimary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemColors) String added in v0.2.0 

func (b *BrandDesignSystemColors) String() string

func (*BrandDesignSystemColors) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemColors) UnmarshalJSON(data []byte) error

type BrandDesignSystemComponents added in v0.2.0 

type BrandDesignSystemComponents struct {
	ButtonPrimary   *BrandComponentStyle `json:"buttonPrimary,omitempty" url:"buttonPrimary,omitempty"`
	ButtonSecondary *BrandComponentStyle `json:"buttonSecondary,omitempty" url:"buttonSecondary,omitempty"`
	Input           *BrandComponentStyle `json:"input,omitempty" url:"input,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemComponents) GetButtonPrimary added in v0.2.0 

func (b *BrandDesignSystemComponents) GetButtonPrimary() *BrandComponentStyle

func (*BrandDesignSystemComponents) GetButtonSecondary added in v0.2.0 

func (b *BrandDesignSystemComponents) GetButtonSecondary() *BrandComponentStyle

func (*BrandDesignSystemComponents) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemComponents) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemComponents) GetInput added in v0.2.0 

func (b *BrandDesignSystemComponents) GetInput() *BrandComponentStyle

func (*BrandDesignSystemComponents) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemComponents) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemComponents) SetButtonPrimary added in v0.2.0 

func (b *BrandDesignSystemComponents) SetButtonPrimary(buttonPrimary *BrandComponentStyle)

SetButtonPrimary sets the ButtonPrimary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemComponents) SetButtonSecondary added in v0.2.0 

func (b *BrandDesignSystemComponents) SetButtonSecondary(buttonSecondary *BrandComponentStyle)

SetButtonSecondary sets the ButtonSecondary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemComponents) SetInput added in v0.2.0 

func (b *BrandDesignSystemComponents) SetInput(input *BrandComponentStyle)

SetInput sets the Input field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemComponents) String added in v0.2.0 

func (b *BrandDesignSystemComponents) String() string

func (*BrandDesignSystemComponents) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemComponents) UnmarshalJSON(data []byte) error

type BrandDesignSystemImages added in v0.2.0 

type BrandDesignSystemImages struct {
	Favicon *string `json:"favicon,omitempty" url:"favicon,omitempty"`
	OgImage *string `json:"ogImage,omitempty" url:"ogImage,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemImages) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemImages) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemImages) GetFavicon added in v0.2.0 

func (b *BrandDesignSystemImages) GetFavicon() *string
func (b *BrandDesignSystemImages) GetLogo() *string

func (*BrandDesignSystemImages) GetOgImage added in v0.2.0 

func (b *BrandDesignSystemImages) GetOgImage() *string

func (*BrandDesignSystemImages) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemImages) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemImages) SetFavicon added in v0.2.0 

func (b *BrandDesignSystemImages) SetFavicon(favicon *string)

SetFavicon sets the Favicon field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (b *BrandDesignSystemImages) SetLogo(logo *string)

SetLogo sets the Logo field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemImages) SetOgImage added in v0.2.0 

func (b *BrandDesignSystemImages) SetOgImage(ogImage *string)

SetOgImage sets the OgImage field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemImages) String added in v0.2.0 

func (b *BrandDesignSystemImages) String() string

func (*BrandDesignSystemImages) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemImages) UnmarshalJSON(data []byte) error

type BrandDesignSystemSpacing added in v0.2.0 

type BrandDesignSystemSpacing struct {
	BaseUnit     float64 `json:"baseUnit" url:"baseUnit"`
	BorderRadius *string `json:"borderRadius,omitempty" url:"borderRadius,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemSpacing) GetBaseUnit added in v0.2.0 

func (b *BrandDesignSystemSpacing) GetBaseUnit() float64

func (*BrandDesignSystemSpacing) GetBorderRadius added in v0.2.0 

func (b *BrandDesignSystemSpacing) GetBorderRadius() *string

func (*BrandDesignSystemSpacing) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemSpacing) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemSpacing) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemSpacing) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemSpacing) SetBaseUnit added in v0.2.0 

func (b *BrandDesignSystemSpacing) SetBaseUnit(baseUnit float64)

SetBaseUnit sets the BaseUnit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemSpacing) SetBorderRadius added in v0.2.0 

func (b *BrandDesignSystemSpacing) SetBorderRadius(borderRadius *string)

SetBorderRadius sets the BorderRadius field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemSpacing) String added in v0.2.0 

func (b *BrandDesignSystemSpacing) String() string

func (*BrandDesignSystemSpacing) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemSpacing) UnmarshalJSON(data []byte) error

type BrandDesignSystemTypography added in v0.2.0 

type BrandDesignSystemTypography struct {
	FontFamilies *BrandDesignSystemTypographyFontFamilies `json:"fontFamilies" url:"fontFamilies"`
	FontSizes    *BrandDesignSystemTypographyFontSizes    `json:"fontSizes" url:"fontSizes"`
	FontStacks   *BrandDesignSystemTypographyFontStacks   `json:"fontStacks" url:"fontStacks"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemTypography) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemTypography) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemTypography) GetFontFamilies added in v0.2.0 

func (b *BrandDesignSystemTypography) GetFontFamilies() *BrandDesignSystemTypographyFontFamilies

func (*BrandDesignSystemTypography) GetFontSizes added in v0.2.0 

func (b *BrandDesignSystemTypography) GetFontSizes() *BrandDesignSystemTypographyFontSizes

func (*BrandDesignSystemTypography) GetFontStacks added in v0.2.0 

func (b *BrandDesignSystemTypography) GetFontStacks() *BrandDesignSystemTypographyFontStacks

func (*BrandDesignSystemTypography) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypography) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemTypography) SetFontFamilies added in v0.2.0 

func (b *BrandDesignSystemTypography) SetFontFamilies(fontFamilies *BrandDesignSystemTypographyFontFamilies)

SetFontFamilies sets the FontFamilies field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypography) SetFontSizes added in v0.2.0 

func (b *BrandDesignSystemTypography) SetFontSizes(fontSizes *BrandDesignSystemTypographyFontSizes)

SetFontSizes sets the FontSizes field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypography) SetFontStacks added in v0.2.0 

func (b *BrandDesignSystemTypography) SetFontStacks(fontStacks *BrandDesignSystemTypographyFontStacks)

SetFontStacks sets the FontStacks field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypography) String added in v0.2.0 

func (b *BrandDesignSystemTypography) String() string

func (*BrandDesignSystemTypography) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypography) UnmarshalJSON(data []byte) error

type BrandDesignSystemTypographyFontFamilies added in v0.2.0 

type BrandDesignSystemTypographyFontFamilies struct {
	Heading *string `json:"heading,omitempty" url:"heading,omitempty"`
	Primary *string `json:"primary,omitempty" url:"primary,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemTypographyFontFamilies) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemTypographyFontFamilies) GetHeading added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) GetHeading() *string

func (*BrandDesignSystemTypographyFontFamilies) GetPrimary added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) GetPrimary() *string

func (*BrandDesignSystemTypographyFontFamilies) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemTypographyFontFamilies) SetHeading added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) SetHeading(heading *string)

SetHeading sets the Heading field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontFamilies) SetPrimary added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) SetPrimary(primary *string)

SetPrimary sets the Primary field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontFamilies) String added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) String() string

func (*BrandDesignSystemTypographyFontFamilies) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontFamilies) UnmarshalJSON(data []byte) error

type BrandDesignSystemTypographyFontSizes added in v0.2.0 

type BrandDesignSystemTypographyFontSizes struct {
	Body *string `json:"body,omitempty" url:"body,omitempty"`
	H1   *string `json:"h1,omitempty" url:"h1,omitempty"`
	H2   *string `json:"h2,omitempty" url:"h2,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemTypographyFontSizes) GetBody added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) GetBody() *string

func (*BrandDesignSystemTypographyFontSizes) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemTypographyFontSizes) GetH1 added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) GetH1() *string

func (*BrandDesignSystemTypographyFontSizes) GetH2 added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) GetH2() *string

func (*BrandDesignSystemTypographyFontSizes) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemTypographyFontSizes) SetBody added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) SetBody(body *string)

SetBody sets the Body field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontSizes) SetH1 added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) SetH1(h1 *string)

SetH1 sets the H1 field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontSizes) SetH2 added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) SetH2(h2 *string)

SetH2 sets the H2 field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontSizes) String added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) String() string

func (*BrandDesignSystemTypographyFontSizes) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontSizes) UnmarshalJSON(data []byte) error

type BrandDesignSystemTypographyFontStacks added in v0.2.0 

type BrandDesignSystemTypographyFontStacks struct {
	Body      []string `json:"body" url:"body"`
	Heading   []string `json:"heading" url:"heading"`
	Paragraph []string `json:"paragraph" url:"paragraph"`
	// contains filtered or unexported fields
}

func (*BrandDesignSystemTypographyFontStacks) GetBody added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) GetBody() []string

func (*BrandDesignSystemTypographyFontStacks) GetExtraProperties added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) GetExtraProperties() map[string]interface{}

func (*BrandDesignSystemTypographyFontStacks) GetHeading added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) GetHeading() []string

func (*BrandDesignSystemTypographyFontStacks) GetParagraph added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) GetParagraph() []string

func (*BrandDesignSystemTypographyFontStacks) MarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) MarshalJSON() ([]byte, error)

func (*BrandDesignSystemTypographyFontStacks) SetBody added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) SetBody(body []string)

SetBody sets the Body field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontStacks) SetHeading added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) SetHeading(heading []string)

SetHeading sets the Heading field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontStacks) SetParagraph added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) SetParagraph(paragraph []string)

SetParagraph sets the Paragraph field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDesignSystemTypographyFontStacks) String added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) String() string

func (*BrandDesignSystemTypographyFontStacks) UnmarshalJSON added in v0.2.0 

func (b *BrandDesignSystemTypographyFontStacks) UnmarshalJSON(data []byte) error

type BrandDto 

type BrandDto struct {
	// Ignore a cached profile and fetch the website again
	Refresh *bool `json:"refresh,omitempty" url:"-"`
	// Maximum time to spend building the profile, in milliseconds
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// The public website whose brand profile should be extracted
	URL string `json:"url" url:"-"`
	// contains filtered or unexported fields
}

func (*BrandDto) MarshalJSON 

func (b *BrandDto) MarshalJSON() ([]byte, error)

func (*BrandDto) SetRefresh 

func (b *BrandDto) SetRefresh(refresh *bool)

SetRefresh sets the Refresh field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDto) SetTimeout 

func (b *BrandDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDto) SetURL 

func (b *BrandDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandDto) UnmarshalJSON 

func (b *BrandDto) UnmarshalJSON(data []byte) error

type BrandProfile 

type BrandProfile struct {
	Branding    *BrandDesignSystem         `json:"branding,omitempty" url:"branding,omitempty"`
	Colors      []*BrandProfileColorsItem  `json:"colors" url:"colors"`
	Description *string                    `json:"description,omitempty" url:"description,omitempty"`
	Domain      string                     `json:"domain" url:"domain"`
	Fonts       []*BrandProfileFontsItem   `json:"fonts" url:"fonts"`
	Images      []*BrandAsset              `json:"images" url:"images"`
	Language    *string                    `json:"language,omitempty" url:"language,omitempty"`
	Logos       []*BrandAsset              `json:"logos" url:"logos"`
	Name        string                     `json:"name" url:"name"`
	Socials     []*BrandProfileSocialsItem `json:"socials" url:"socials"`
	Tagline     *string                    `json:"tagline,omitempty" url:"tagline,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandProfile) GetBranding added in v0.2.0 

func (b *BrandProfile) GetBranding() *BrandDesignSystem

func (*BrandProfile) GetColors 

func (b *BrandProfile) GetColors() []*BrandProfileColorsItem

func (*BrandProfile) GetDescription 

func (b *BrandProfile) GetDescription() *string

func (*BrandProfile) GetDomain 

func (b *BrandProfile) GetDomain() string

func (*BrandProfile) GetExtraProperties 

func (b *BrandProfile) GetExtraProperties() map[string]interface{}

func (*BrandProfile) GetFonts 

func (b *BrandProfile) GetFonts() []*BrandProfileFontsItem

func (*BrandProfile) GetImages 

func (b *BrandProfile) GetImages() []*BrandAsset

func (*BrandProfile) GetLanguage 

func (b *BrandProfile) GetLanguage() *string

func (*BrandProfile) GetLogos 

func (b *BrandProfile) GetLogos() []*BrandAsset

func (*BrandProfile) GetName 

func (b *BrandProfile) GetName() string

func (*BrandProfile) GetSocials 

func (b *BrandProfile) GetSocials() []*BrandProfileSocialsItem

func (*BrandProfile) GetTagline 

func (b *BrandProfile) GetTagline() *string

func (*BrandProfile) MarshalJSON 

func (b *BrandProfile) MarshalJSON() ([]byte, error)

func (*BrandProfile) SetBranding added in v0.2.0 

func (b *BrandProfile) SetBranding(branding *BrandDesignSystem)

SetBranding sets the Branding field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetColors 

func (b *BrandProfile) SetColors(colors []*BrandProfileColorsItem)

SetColors sets the Colors field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetDescription 

func (b *BrandProfile) SetDescription(description *string)

SetDescription sets the Description field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetDomain 

func (b *BrandProfile) SetDomain(domain string)

SetDomain sets the Domain field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetFonts 

func (b *BrandProfile) SetFonts(fonts []*BrandProfileFontsItem)

SetFonts sets the Fonts field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetImages 

func (b *BrandProfile) SetImages(images []*BrandAsset)

SetImages sets the Images field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetLanguage 

func (b *BrandProfile) SetLanguage(language *string)

SetLanguage sets the Language field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetLogos 

func (b *BrandProfile) SetLogos(logos []*BrandAsset)

SetLogos sets the Logos field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetName 

func (b *BrandProfile) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetSocials 

func (b *BrandProfile) SetSocials(socials []*BrandProfileSocialsItem)

SetSocials sets the Socials field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) SetTagline 

func (b *BrandProfile) SetTagline(tagline *string)

SetTagline sets the Tagline field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfile) String 

func (b *BrandProfile) String() string

func (*BrandProfile) UnmarshalJSON 

func (b *BrandProfile) UnmarshalJSON(data []byte) error

type BrandProfileColorsItem 

type BrandProfileColorsItem struct {
	Hex  string  `json:"hex" url:"hex"`
	Name *string `json:"name,omitempty" url:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandProfileColorsItem) GetExtraProperties 

func (b *BrandProfileColorsItem) GetExtraProperties() map[string]interface{}

func (*BrandProfileColorsItem) GetHex 

func (b *BrandProfileColorsItem) GetHex() string

func (*BrandProfileColorsItem) GetName 

func (b *BrandProfileColorsItem) GetName() *string

func (*BrandProfileColorsItem) MarshalJSON 

func (b *BrandProfileColorsItem) MarshalJSON() ([]byte, error)

func (*BrandProfileColorsItem) SetHex 

func (b *BrandProfileColorsItem) SetHex(hex string)

SetHex sets the Hex field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileColorsItem) SetName 

func (b *BrandProfileColorsItem) SetName(name *string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileColorsItem) String 

func (b *BrandProfileColorsItem) String() string

func (*BrandProfileColorsItem) UnmarshalJSON 

func (b *BrandProfileColorsItem) UnmarshalJSON(data []byte) error

type BrandProfileFontsItem 

type BrandProfileFontsItem struct {
	Family  string   `json:"family" url:"family"`
	Weights []string `json:"weights,omitempty" url:"weights,omitempty"`
	// contains filtered or unexported fields
}

func (*BrandProfileFontsItem) GetExtraProperties 

func (b *BrandProfileFontsItem) GetExtraProperties() map[string]interface{}

func (*BrandProfileFontsItem) GetFamily 

func (b *BrandProfileFontsItem) GetFamily() string

func (*BrandProfileFontsItem) GetWeights 

func (b *BrandProfileFontsItem) GetWeights() []string

func (*BrandProfileFontsItem) MarshalJSON 

func (b *BrandProfileFontsItem) MarshalJSON() ([]byte, error)

func (*BrandProfileFontsItem) SetFamily 

func (b *BrandProfileFontsItem) SetFamily(family string)

SetFamily sets the Family field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileFontsItem) SetWeights 

func (b *BrandProfileFontsItem) SetWeights(weights []string)

SetWeights sets the Weights field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileFontsItem) String 

func (b *BrandProfileFontsItem) String() string

func (*BrandProfileFontsItem) UnmarshalJSON 

func (b *BrandProfileFontsItem) UnmarshalJSON(data []byte) error

type BrandProfileSocialsItem 

type BrandProfileSocialsItem struct {
	Network string `json:"network" url:"network"`
	URL     string `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*BrandProfileSocialsItem) GetExtraProperties 

func (b *BrandProfileSocialsItem) GetExtraProperties() map[string]interface{}

func (*BrandProfileSocialsItem) GetNetwork 

func (b *BrandProfileSocialsItem) GetNetwork() string

func (*BrandProfileSocialsItem) GetURL 

func (b *BrandProfileSocialsItem) GetURL() string

func (*BrandProfileSocialsItem) MarshalJSON 

func (b *BrandProfileSocialsItem) MarshalJSON() ([]byte, error)

func (*BrandProfileSocialsItem) SetNetwork 

func (b *BrandProfileSocialsItem) SetNetwork(network string)

SetNetwork sets the Network field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileSocialsItem) SetURL 

func (b *BrandProfileSocialsItem) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandProfileSocialsItem) String 

func (b *BrandProfileSocialsItem) String() string

func (*BrandProfileSocialsItem) UnmarshalJSON 

func (b *BrandProfileSocialsItem) UnmarshalJSON(data []byte) error

type BrandResponse 

type BrandResponse struct {
	Data    *BrandResponseData `json:"data" url:"data"`
	Success bool               `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*BrandResponse) GetData 

func (b *BrandResponse) GetData() *BrandResponseData

func (*BrandResponse) GetExtraProperties 

func (b *BrandResponse) GetExtraProperties() map[string]interface{}

func (*BrandResponse) GetSuccess 

func (b *BrandResponse) GetSuccess() bool

func (*BrandResponse) MarshalJSON 

func (b *BrandResponse) MarshalJSON() ([]byte, error)

func (*BrandResponse) SetData 

func (b *BrandResponse) SetData(data *BrandResponseData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponse) SetSuccess 

func (b *BrandResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponse) String 

func (b *BrandResponse) String() string

func (*BrandResponse) UnmarshalJSON 

func (b *BrandResponse) UnmarshalJSON(data []byte) error

type BrandResponseData 

type BrandResponseData struct {
	Brand *BrandProfile          `json:"brand" url:"brand"`
	Meta  *BrandResponseDataMeta `json:"meta" url:"meta"`
	// contains filtered or unexported fields
}

func (*BrandResponseData) GetBrand 

func (b *BrandResponseData) GetBrand() *BrandProfile

func (*BrandResponseData) GetExtraProperties 

func (b *BrandResponseData) GetExtraProperties() map[string]interface{}

func (*BrandResponseData) GetMeta 

func (b *BrandResponseData) GetMeta() *BrandResponseDataMeta

func (*BrandResponseData) MarshalJSON 

func (b *BrandResponseData) MarshalJSON() ([]byte, error)

func (*BrandResponseData) SetBrand 

func (b *BrandResponseData) SetBrand(brand *BrandProfile)

SetBrand sets the Brand field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseData) SetMeta 

func (b *BrandResponseData) SetMeta(meta *BrandResponseDataMeta)

SetMeta sets the Meta field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseData) String 

func (b *BrandResponseData) String() string

func (*BrandResponseData) UnmarshalJSON 

func (b *BrandResponseData) UnmarshalJSON(data []byte) error

type BrandResponseDataMeta 

type BrandResponseDataMeta struct {
	Cached      bool      `json:"cached" url:"cached"`
	CreditsUsed int       `json:"creditsUsed" url:"creditsUsed"`
	FetchedAt   time.Time `json:"fetchedAt" url:"fetchedAt"`
	SourceURL   string    `json:"sourceUrl" url:"sourceUrl"`
	// contains filtered or unexported fields
}

func (*BrandResponseDataMeta) GetCached 

func (b *BrandResponseDataMeta) GetCached() bool

func (*BrandResponseDataMeta) GetCreditsUsed 

func (b *BrandResponseDataMeta) GetCreditsUsed() int

func (*BrandResponseDataMeta) GetExtraProperties 

func (b *BrandResponseDataMeta) GetExtraProperties() map[string]interface{}

func (*BrandResponseDataMeta) GetFetchedAt 

func (b *BrandResponseDataMeta) GetFetchedAt() time.Time

func (*BrandResponseDataMeta) GetSourceURL 

func (b *BrandResponseDataMeta) GetSourceURL() string

func (*BrandResponseDataMeta) MarshalJSON 

func (b *BrandResponseDataMeta) MarshalJSON() ([]byte, error)

func (*BrandResponseDataMeta) SetCached 

func (b *BrandResponseDataMeta) SetCached(cached bool)

SetCached sets the Cached field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseDataMeta) SetCreditsUsed 

func (b *BrandResponseDataMeta) SetCreditsUsed(creditsUsed int)

SetCreditsUsed sets the CreditsUsed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseDataMeta) SetFetchedAt 

func (b *BrandResponseDataMeta) SetFetchedAt(fetchedAt time.Time)

SetFetchedAt sets the FetchedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseDataMeta) SetSourceURL 

func (b *BrandResponseDataMeta) SetSourceURL(sourceURL string)

SetSourceURL sets the SourceURL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*BrandResponseDataMeta) String 

func (b *BrandResponseDataMeta) String() string

func (*BrandResponseDataMeta) UnmarshalJSON 

func (b *BrandResponseDataMeta) UnmarshalJSON(data []byte) error

type CancelJobResponse 

type CancelJobResponse struct {
	Data    *CancelJobResponseData `json:"data" url:"data"`
	Success bool                   `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*CancelJobResponse) GetData 

func (c *CancelJobResponse) GetData() *CancelJobResponseData

func (*CancelJobResponse) GetExtraProperties 

func (c *CancelJobResponse) GetExtraProperties() map[string]interface{}

func (*CancelJobResponse) GetSuccess 

func (c *CancelJobResponse) GetSuccess() bool

func (*CancelJobResponse) MarshalJSON 

func (c *CancelJobResponse) MarshalJSON() ([]byte, error)

func (*CancelJobResponse) SetData 

func (c *CancelJobResponse) SetData(data *CancelJobResponseData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CancelJobResponse) SetSuccess 

func (c *CancelJobResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CancelJobResponse) String 

func (c *CancelJobResponse) String() string

func (*CancelJobResponse) UnmarshalJSON 

func (c *CancelJobResponse) UnmarshalJSON(data []byte) error

type CancelJobResponseData 

type CancelJobResponseData struct {
	ID     string `json:"id" url:"id"`
	Status string `json:"status" url:"status"`
	// contains filtered or unexported fields
}

func (*CancelJobResponseData) GetExtraProperties 

func (c *CancelJobResponseData) GetExtraProperties() map[string]interface{}

func (*CancelJobResponseData) GetID 

func (c *CancelJobResponseData) GetID() string

func (*CancelJobResponseData) GetStatus 

func (c *CancelJobResponseData) GetStatus() string

func (*CancelJobResponseData) MarshalJSON 

func (c *CancelJobResponseData) MarshalJSON() ([]byte, error)

func (*CancelJobResponseData) SetID 

func (c *CancelJobResponseData) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CancelJobResponseData) SetStatus 

func (c *CancelJobResponseData) SetStatus(status string)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CancelJobResponseData) String 

func (c *CancelJobResponseData) String() string

func (*CancelJobResponseData) UnmarshalJSON 

func (c *CancelJobResponseData) UnmarshalJSON(data []byte) error

type CancelJobsRequest 

type CancelJobsRequest struct {
	ID string `json:"-" url:"-"`
	// contains filtered or unexported fields
}

func (*CancelJobsRequest) SetID 

func (c *CancelJobsRequest) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type ChangeTrackingFormatDto 

type ChangeTrackingFormatDto struct {
	// Change detection modes
	Modes []string `json:"modes,omitempty" url:"modes,omitempty"`
	// Schema for structured change tracking
	Schema map[string]any `json:"schema,omitempty" url:"schema,omitempty"`
	// Tag to identify this tracking session
	Tag *string `json:"tag,omitempty" url:"tag,omitempty"`
	// Format type
	Type ChangeTrackingFormatDtoType `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*ChangeTrackingFormatDto) GetExtraProperties 

func (c *ChangeTrackingFormatDto) GetExtraProperties() map[string]interface{}

func (*ChangeTrackingFormatDto) GetModes 

func (c *ChangeTrackingFormatDto) GetModes() []string

func (*ChangeTrackingFormatDto) GetSchema 

func (c *ChangeTrackingFormatDto) GetSchema() map[string]any

func (*ChangeTrackingFormatDto) GetTag 

func (c *ChangeTrackingFormatDto) GetTag() *string

func (*ChangeTrackingFormatDto) GetType 

func (c *ChangeTrackingFormatDto) GetType() ChangeTrackingFormatDtoType

func (*ChangeTrackingFormatDto) MarshalJSON 

func (c *ChangeTrackingFormatDto) MarshalJSON() ([]byte, error)

func (*ChangeTrackingFormatDto) SetModes 

func (c *ChangeTrackingFormatDto) SetModes(modes []string)

SetModes sets the Modes field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ChangeTrackingFormatDto) SetSchema 

func (c *ChangeTrackingFormatDto) SetSchema(schema map[string]any)

SetSchema sets the Schema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ChangeTrackingFormatDto) SetTag 

func (c *ChangeTrackingFormatDto) SetTag(tag *string)

SetTag sets the Tag field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ChangeTrackingFormatDto) SetType 

func (c *ChangeTrackingFormatDto) SetType(type_ ChangeTrackingFormatDtoType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ChangeTrackingFormatDto) String 

func (c *ChangeTrackingFormatDto) String() string

func (*ChangeTrackingFormatDto) UnmarshalJSON 

func (c *ChangeTrackingFormatDto) UnmarshalJSON(data []byte) error

type ChangeTrackingFormatDtoType 

type ChangeTrackingFormatDtoType string

Format type 

const (
	ChangeTrackingFormatDtoTypeChangeTracking ChangeTrackingFormatDtoType = "changeTracking"
)

func NewChangeTrackingFormatDtoTypeFromString 

func NewChangeTrackingFormatDtoTypeFromString(s string) (ChangeTrackingFormatDtoType, error)

func (ChangeTrackingFormatDtoType) Ptr 

func (c ChangeTrackingFormatDtoType) Ptr() *ChangeTrackingFormatDtoType

type CrawlDto 

type CrawlDto struct {
	// Whether to allow crawling external domains
	AllowExternalLinks *bool `json:"allowExternalLinks,omitempty" url:"-"`
	// Whether to allow crawling subdomains
	AllowSubdomains *bool `json:"allowSubdomains,omitempty" url:"-"`
	// Whether to crawl entire domain or just subtree
	CrawlEntireDomain *bool `json:"crawlEntireDomain,omitempty" url:"-"`
	// Deduplicate similar URLs using intelligent matching
	DeduplicateSimilarUrLs *bool `json:"deduplicateSimilarURLs,omitempty" url:"-"`
	// Delay between page scrapes in milliseconds
	Delay *float64 `json:"delay,omitempty" url:"-"`
	// Regex patterns to exclude paths
	ExcludePaths []string `json:"excludePaths,omitempty" url:"-"`
	// Ignore query parameters when deduplicating URLs
	IgnoreQueryParameters *bool `json:"ignoreQueryParameters,omitempty" url:"-"`
	// Regex patterns to include paths
	IncludePaths []string `json:"includePaths,omitempty" url:"-"`
	// Maximum number of pages to crawl
	Limit *float64 `json:"limit,omitempty" url:"-"`
	// Maximum number of concurrent scrapes for this crawl
	MaxConcurrency *float64 `json:"maxConcurrency,omitempty" url:"-"`
	// Maximum depth for URL discovery
	MaxDiscoveryDepth *float64 `json:"maxDiscoveryDepth,omitempty" url:"-"`
	// Natural language instructions for crawl configuration
	Prompt *string `json:"prompt,omitempty" url:"-"`
	// Scrape options to apply to each page. actions accepts at most 25 bounded browser actions. zeroDataRetention: true is currently rejected with 400 ZERO_DATA_RETENTION_NOT_SUPPORTED.
	ScrapeOptions map[string]any `json:"scrapeOptions,omitempty" url:"-"`
	// Sitemap handling strategy
	Sitemap *CrawlDtoSitemap `json:"sitemap,omitempty" url:"-"`
	// Starting URL to crawl
	URL string `json:"url" url:"-"`
	// Webhook configuration
	Webhook *WebhookConfigDto `json:"webhook,omitempty" url:"-"`
	// Reserved for a future zero-data-retention mode. true is currently rejected with 400 ZERO_DATA_RETENTION_NOT_SUPPORTED; omit or use false.
	ZeroDataRetention *bool `json:"zeroDataRetention,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*CrawlDto) MarshalJSON 

func (c *CrawlDto) MarshalJSON() ([]byte, error)
func (c *CrawlDto) SetAllowExternalLinks(allowExternalLinks *bool)

SetAllowExternalLinks sets the AllowExternalLinks field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetAllowSubdomains 

func (c *CrawlDto) SetAllowSubdomains(allowSubdomains *bool)

SetAllowSubdomains sets the AllowSubdomains field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetCrawlEntireDomain 

func (c *CrawlDto) SetCrawlEntireDomain(crawlEntireDomain *bool)

SetCrawlEntireDomain sets the CrawlEntireDomain field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetDeduplicateSimilarUrLs 

func (c *CrawlDto) SetDeduplicateSimilarUrLs(deduplicateSimilarUrLs *bool)

SetDeduplicateSimilarUrLs sets the DeduplicateSimilarUrLs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetDelay 

func (c *CrawlDto) SetDelay(delay *float64)

SetDelay sets the Delay field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetExcludePaths 

func (c *CrawlDto) SetExcludePaths(excludePaths []string)

SetExcludePaths sets the ExcludePaths field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetIgnoreQueryParameters 

func (c *CrawlDto) SetIgnoreQueryParameters(ignoreQueryParameters *bool)

SetIgnoreQueryParameters sets the IgnoreQueryParameters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetIncludePaths 

func (c *CrawlDto) SetIncludePaths(includePaths []string)

SetIncludePaths sets the IncludePaths field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetLimit 

func (c *CrawlDto) SetLimit(limit *float64)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetMaxConcurrency 

func (c *CrawlDto) SetMaxConcurrency(maxConcurrency *float64)

SetMaxConcurrency sets the MaxConcurrency field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetMaxDiscoveryDepth 

func (c *CrawlDto) SetMaxDiscoveryDepth(maxDiscoveryDepth *float64)

SetMaxDiscoveryDepth sets the MaxDiscoveryDepth field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetPrompt 

func (c *CrawlDto) SetPrompt(prompt *string)

SetPrompt sets the Prompt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetScrapeOptions 

func (c *CrawlDto) SetScrapeOptions(scrapeOptions map[string]any)

SetScrapeOptions sets the ScrapeOptions field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetSitemap 

func (c *CrawlDto) SetSitemap(sitemap *CrawlDtoSitemap)

SetSitemap sets the Sitemap field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetURL 

func (c *CrawlDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetWebhook 

func (c *CrawlDto) SetWebhook(webhook *WebhookConfigDto)

SetWebhook sets the Webhook field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) SetZeroDataRetention 

func (c *CrawlDto) SetZeroDataRetention(zeroDataRetention *bool)

SetZeroDataRetention sets the ZeroDataRetention field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CrawlDto) UnmarshalJSON 

func (c *CrawlDto) UnmarshalJSON(data []byte) error

type CrawlDtoSitemap 

type CrawlDtoSitemap string

Sitemap handling strategy 

const (
	CrawlDtoSitemapInclude CrawlDtoSitemap = "include"
	CrawlDtoSitemapSkip    CrawlDtoSitemap = "skip"
	CrawlDtoSitemapOnly    CrawlDtoSitemap = "only"
)

func NewCrawlDtoSitemapFromString 

func NewCrawlDtoSitemapFromString(s string) (CrawlDtoSitemap, error)

func (CrawlDtoSitemap) Ptr 

func (c CrawlDtoSitemap) Ptr() *CrawlDtoSitemap

type CreateWebhookDto 

type CreateWebhookDto struct {
	// Event types to subscribe to
	Events []string `json:"events" url:"-"`
	// Webhook URL to send events to
	URL string `json:"url" url:"-"`
	// contains filtered or unexported fields
}

func (*CreateWebhookDto) MarshalJSON 

func (c *CreateWebhookDto) MarshalJSON() ([]byte, error)

func (*CreateWebhookDto) SetEvents 

func (c *CreateWebhookDto) SetEvents(events []string)

SetEvents sets the Events field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateWebhookDto) SetURL 

func (c *CreateWebhookDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*CreateWebhookDto) UnmarshalJSON 

func (c *CreateWebhookDto) UnmarshalJSON(data []byte) error

type DeleteWebhooksRequest 

type DeleteWebhooksRequest struct {
	ID string `json:"-" url:"-"`
	// contains filtered or unexported fields
}

func (*DeleteWebhooksRequest) SetID 

func (d *DeleteWebhooksRequest) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type ExtractDto 

type ExtractDto struct {
	// Agent configuration
	Agent *AgentConfigDto `json:"agent,omitempty" url:"-"`
	// Enable web search for URL discovery
	EnableWebSearch *bool `json:"enableWebSearch,omitempty" url:"-"`
	// Ignore invalid URLs and process remaining valid ones
	IgnoreInvalidUrLs *bool `json:"ignoreInvalidURLs,omitempty" url:"-"`
	// Ignore sitemap during URL discovery
	IgnoreSitemap *bool `json:"ignoreSitemap,omitempty" url:"-"`
	// Include subdomains in extraction
	IncludeSubdomains *bool `json:"includeSubdomains,omitempty" url:"-"`
	// Natural language prompt describing what to extract. Maximum 16384 UTF-8 bytes.
	Prompt string `json:"prompt" url:"-"`
	// JSON Schema for structured output. Serialized schema is limited to 65536 UTF-8 bytes.
	Schema map[string]any `json:"schema,omitempty" url:"-"`
	// Scrape options for each URL. zeroDataRetention: true is currently rejected with 400 ZERO_DATA_RETENTION_NOT_SUPPORTED.
	ScrapeOptions map[string]any `json:"scrapeOptions,omitempty" url:"-"`
	// Include source citations in response
	ShowSources *bool `json:"showSources,omitempty" url:"-"`
	// 1–20 unique public HTTP(S) URLs. May be omitted only when enableWebSearch is true. Each URL is limited to 2048 UTF-8 bytes.
	URLs []string `json:"urls,omitempty" url:"-"`
	// Webhook configuration
	Webhook *ExtractWebhookConfigDto `json:"webhook,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*ExtractDto) MarshalJSON 

func (e *ExtractDto) MarshalJSON() ([]byte, error)

func (*ExtractDto) SetAgent 

func (e *ExtractDto) SetAgent(agent *AgentConfigDto)

SetAgent sets the Agent field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetEnableWebSearch 

func (e *ExtractDto) SetEnableWebSearch(enableWebSearch *bool)

SetEnableWebSearch sets the EnableWebSearch field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetIgnoreInvalidUrLs 

func (e *ExtractDto) SetIgnoreInvalidUrLs(ignoreInvalidUrLs *bool)

SetIgnoreInvalidUrLs sets the IgnoreInvalidUrLs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetIgnoreSitemap 

func (e *ExtractDto) SetIgnoreSitemap(ignoreSitemap *bool)

SetIgnoreSitemap sets the IgnoreSitemap field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetIncludeSubdomains 

func (e *ExtractDto) SetIncludeSubdomains(includeSubdomains *bool)

SetIncludeSubdomains sets the IncludeSubdomains field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetPrompt 

func (e *ExtractDto) SetPrompt(prompt string)

SetPrompt sets the Prompt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetSchema 

func (e *ExtractDto) SetSchema(schema map[string]any)

SetSchema sets the Schema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetScrapeOptions 

func (e *ExtractDto) SetScrapeOptions(scrapeOptions map[string]any)

SetScrapeOptions sets the ScrapeOptions field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetShowSources 

func (e *ExtractDto) SetShowSources(showSources *bool)

SetShowSources sets the ShowSources field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetURLs 

func (e *ExtractDto) SetURLs(urls []string)

SetURLs sets the URLs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) SetWebhook 

func (e *ExtractDto) SetWebhook(webhook *ExtractWebhookConfigDto)

SetWebhook sets the Webhook field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractDto) UnmarshalJSON 

func (e *ExtractDto) UnmarshalJSON(data []byte) error

type ExtractWebhookConfigDto 

type ExtractWebhookConfigDto struct {
	// Events to subscribe to
	Events []string `json:"events,omitempty" url:"events,omitempty"`
	// Custom metadata
	Metadata map[string]any `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Optional secret used to sign direct webhook deliveries
	Secret *string `json:"secret,omitempty" url:"secret,omitempty"`
	// Webhook URL
	URL string `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*ExtractWebhookConfigDto) GetEvents 

func (e *ExtractWebhookConfigDto) GetEvents() []string

func (*ExtractWebhookConfigDto) GetExtraProperties 

func (e *ExtractWebhookConfigDto) GetExtraProperties() map[string]interface{}

func (*ExtractWebhookConfigDto) GetMetadata 

func (e *ExtractWebhookConfigDto) GetMetadata() map[string]any

func (*ExtractWebhookConfigDto) GetSecret 

func (e *ExtractWebhookConfigDto) GetSecret() *string

func (*ExtractWebhookConfigDto) GetURL 

func (e *ExtractWebhookConfigDto) GetURL() string

func (*ExtractWebhookConfigDto) MarshalJSON 

func (e *ExtractWebhookConfigDto) MarshalJSON() ([]byte, error)

func (*ExtractWebhookConfigDto) SetEvents 

func (e *ExtractWebhookConfigDto) SetEvents(events []string)

SetEvents sets the Events field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractWebhookConfigDto) SetMetadata 

func (e *ExtractWebhookConfigDto) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractWebhookConfigDto) SetSecret 

func (e *ExtractWebhookConfigDto) SetSecret(secret *string)

SetSecret sets the Secret field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractWebhookConfigDto) SetURL 

func (e *ExtractWebhookConfigDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ExtractWebhookConfigDto) String 

func (e *ExtractWebhookConfigDto) String() string

func (*ExtractWebhookConfigDto) UnmarshalJSON 

func (e *ExtractWebhookConfigDto) UnmarshalJSON(data []byte) error

type FileParam 

type FileParam struct {
	io.Reader
	// contains filtered or unexported fields
}

FileParam is a file type suitable for multipart/form-data uploads.

func NewFileParam 

func NewFileParam(
	reader io.Reader,
	filename string,
	contentType string,
	opts ...FileParamOption,
) *FileParam

NewFileParam returns a *FileParam type suitable for multipart/form-data uploads. All file upload endpoints accept a simple io.Reader, which is usually created by opening a file via os.Open.

However, some endpoints require additional metadata about the file such as a specific Content-Type or custom filename. FileParam makes it easier to create the correct type signature for these endpoints.

func (*FileParam) ContentType 

func (f *FileParam) ContentType() string

func (*FileParam) Name 

func (f *FileParam) Name() string

type FileParamOption 

type FileParamOption interface {
	// contains filtered or unexported methods
}

FileParamOption adapts the behavior of the FileParam. No options are implemented yet, but this interface allows for future extensibility.

type GetJobsRequest 

type GetJobsRequest struct {
	ID    string   `json:"-" url:"-"`
	Page  *float64 `json:"-" url:"page,omitempty"`
	Limit *float64 `json:"-" url:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*GetJobsRequest) SetID 

func (g *GetJobsRequest) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetJobsRequest) SetLimit 

func (g *GetJobsRequest) SetLimit(limit *float64)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*GetJobsRequest) SetPage 

func (g *GetJobsRequest) SetPage(page *float64)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type GetWebhooksRequest 

type GetWebhooksRequest struct {
	ID string `json:"-" url:"-"`
	// contains filtered or unexported fields
}

func (*GetWebhooksRequest) SetID 

func (g *GetWebhooksRequest) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type JSONFormatDto 

type JSONFormatDto struct {
	// Natural language prompt for extraction guidance
	Prompt *string `json:"prompt,omitempty" url:"prompt,omitempty"`
	// JSON schema for structured extraction
	Schema map[string]any `json:"schema" url:"schema"`
	// Format type
	Type JSONFormatDtoType `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*JSONFormatDto) GetExtraProperties 

func (j *JSONFormatDto) GetExtraProperties() map[string]interface{}

func (*JSONFormatDto) GetPrompt 

func (j *JSONFormatDto) GetPrompt() *string

func (*JSONFormatDto) GetSchema 

func (j *JSONFormatDto) GetSchema() map[string]any

func (*JSONFormatDto) GetType 

func (j *JSONFormatDto) GetType() JSONFormatDtoType

func (*JSONFormatDto) MarshalJSON 

func (j *JSONFormatDto) MarshalJSON() ([]byte, error)

func (*JSONFormatDto) SetPrompt 

func (j *JSONFormatDto) SetPrompt(prompt *string)

SetPrompt sets the Prompt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JSONFormatDto) SetSchema 

func (j *JSONFormatDto) SetSchema(schema map[string]any)

SetSchema sets the Schema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JSONFormatDto) SetType 

func (j *JSONFormatDto) SetType(type_ JSONFormatDtoType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JSONFormatDto) String 

func (j *JSONFormatDto) String() string

func (*JSONFormatDto) UnmarshalJSON 

func (j *JSONFormatDto) UnmarshalJSON(data []byte) error

type JSONFormatDtoType 

type JSONFormatDtoType string

Format type 

const (
	JSONFormatDtoTypeJSON JSONFormatDtoType = "json"
)

func NewJSONFormatDtoTypeFromString 

func NewJSONFormatDtoTypeFromString(s string) (JSONFormatDtoType, error)

func (JSONFormatDtoType) Ptr 

func (j JSONFormatDtoType) Ptr() *JSONFormatDtoType

type JobCreatedResponse 

type JobCreatedResponse struct {
	ID          string   `json:"id" url:"id"`
	InvalidUrLs []string `json:"invalidURLs,omitempty" url:"invalidURLs,omitempty"`
	Success     bool     `json:"success" url:"success"`
	URL         string   `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*JobCreatedResponse) GetExtraProperties 

func (j *JobCreatedResponse) GetExtraProperties() map[string]interface{}

func (*JobCreatedResponse) GetID 

func (j *JobCreatedResponse) GetID() string

func (*JobCreatedResponse) GetInvalidUrLs 

func (j *JobCreatedResponse) GetInvalidUrLs() []string

func (*JobCreatedResponse) GetSuccess 

func (j *JobCreatedResponse) GetSuccess() bool

func (*JobCreatedResponse) GetURL 

func (j *JobCreatedResponse) GetURL() string

func (*JobCreatedResponse) MarshalJSON 

func (j *JobCreatedResponse) MarshalJSON() ([]byte, error)

func (*JobCreatedResponse) SetID 

func (j *JobCreatedResponse) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobCreatedResponse) SetInvalidUrLs 

func (j *JobCreatedResponse) SetInvalidUrLs(invalidUrLs []string)

SetInvalidUrLs sets the InvalidUrLs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobCreatedResponse) SetSuccess 

func (j *JobCreatedResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobCreatedResponse) SetURL 

func (j *JobCreatedResponse) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobCreatedResponse) String 

func (j *JobCreatedResponse) String() string

func (*JobCreatedResponse) UnmarshalJSON 

func (j *JobCreatedResponse) UnmarshalJSON(data []byte) error

type JobResponse 

type JobResponse struct {
	Data    *JobResponseData `json:"data" url:"data"`
	Success bool             `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*JobResponse) GetData 

func (j *JobResponse) GetData() *JobResponseData

func (*JobResponse) GetExtraProperties 

func (j *JobResponse) GetExtraProperties() map[string]interface{}

func (*JobResponse) GetSuccess 

func (j *JobResponse) GetSuccess() bool

func (*JobResponse) MarshalJSON 

func (j *JobResponse) MarshalJSON() ([]byte, error)

func (*JobResponse) SetData 

func (j *JobResponse) SetData(data *JobResponseData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponse) SetSuccess 

func (j *JobResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponse) String 

func (j *JobResponse) String() string

func (*JobResponse) UnmarshalJSON 

func (j *JobResponse) UnmarshalJSON(data []byte) error

type JobResponseData 

type JobResponseData struct {
	Completed        *int                         `json:"completed,omitempty" url:"completed,omitempty"`
	CompletedAt      *time.Time                   `json:"completedAt,omitempty" url:"completedAt,omitempty"`
	CreatedAt        time.Time                    `json:"createdAt" url:"createdAt"`
	CreditsUsed      int                          `json:"creditsUsed" url:"creditsUsed"`
	Error            *string                      `json:"error,omitempty" url:"error,omitempty"`
	Failed           *int                         `json:"failed,omitempty" url:"failed,omitempty"`
	ID               string                       `json:"id" url:"id"`
	StartedAt        *time.Time                   `json:"startedAt,omitempty" url:"startedAt,omitempty"`
	Status           string                       `json:"status" url:"status"`
	Total            int                          `json:"total" url:"total"`
	Type             JobSummaryType               `json:"type" url:"type"`
	Errors           []*JobResponseDataErrorsItem `json:"errors" url:"errors"`
	Result           any                          `json:"result,omitempty" url:"result,omitempty"`
	ResultPagination *Pagination                  `json:"resultPagination" url:"resultPagination"`
	Results          []map[string]any             `json:"results" url:"results"`
	// contains filtered or unexported fields
}

func (*JobResponseData) GetCompleted 

func (j *JobResponseData) GetCompleted() *int

func (*JobResponseData) GetCompletedAt 

func (j *JobResponseData) GetCompletedAt() *time.Time

func (*JobResponseData) GetCreatedAt 

func (j *JobResponseData) GetCreatedAt() time.Time

func (*JobResponseData) GetCreditsUsed 

func (j *JobResponseData) GetCreditsUsed() int

func (*JobResponseData) GetError 

func (j *JobResponseData) GetError() *string

func (*JobResponseData) GetErrors 

func (j *JobResponseData) GetErrors() []*JobResponseDataErrorsItem

func (*JobResponseData) GetExtraProperties 

func (j *JobResponseData) GetExtraProperties() map[string]interface{}

func (*JobResponseData) GetFailed 

func (j *JobResponseData) GetFailed() *int

func (*JobResponseData) GetID 

func (j *JobResponseData) GetID() string

func (*JobResponseData) GetResult 

func (j *JobResponseData) GetResult() any

func (*JobResponseData) GetResultPagination 

func (j *JobResponseData) GetResultPagination() *Pagination

func (*JobResponseData) GetResults 

func (j *JobResponseData) GetResults() []map[string]any

func (*JobResponseData) GetStartedAt 

func (j *JobResponseData) GetStartedAt() *time.Time

func (*JobResponseData) GetStatus 

func (j *JobResponseData) GetStatus() string

func (*JobResponseData) GetTotal 

func (j *JobResponseData) GetTotal() int

func (*JobResponseData) GetType 

func (j *JobResponseData) GetType() JobSummaryType

func (*JobResponseData) MarshalJSON 

func (j *JobResponseData) MarshalJSON() ([]byte, error)

func (*JobResponseData) SetCompleted 

func (j *JobResponseData) SetCompleted(completed *int)

SetCompleted sets the Completed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetCompletedAt 

func (j *JobResponseData) SetCompletedAt(completedAt *time.Time)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetCreatedAt 

func (j *JobResponseData) SetCreatedAt(createdAt time.Time)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetCreditsUsed 

func (j *JobResponseData) SetCreditsUsed(creditsUsed int)

SetCreditsUsed sets the CreditsUsed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetError 

func (j *JobResponseData) SetError(error_ *string)

SetError sets the Error field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetErrors 

func (j *JobResponseData) SetErrors(errors []*JobResponseDataErrorsItem)

SetErrors sets the Errors field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetFailed 

func (j *JobResponseData) SetFailed(failed *int)

SetFailed sets the Failed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetID 

func (j *JobResponseData) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetResult 

func (j *JobResponseData) SetResult(result any)

SetResult sets the Result field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetResultPagination 

func (j *JobResponseData) SetResultPagination(resultPagination *Pagination)

SetResultPagination sets the ResultPagination field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetResults 

func (j *JobResponseData) SetResults(results []map[string]any)

SetResults sets the Results field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetStartedAt 

func (j *JobResponseData) SetStartedAt(startedAt *time.Time)

SetStartedAt sets the StartedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetStatus 

func (j *JobResponseData) SetStatus(status string)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetTotal 

func (j *JobResponseData) SetTotal(total int)

SetTotal sets the Total field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) SetType 

func (j *JobResponseData) SetType(type_ JobSummaryType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseData) String 

func (j *JobResponseData) String() string

func (*JobResponseData) UnmarshalJSON 

func (j *JobResponseData) UnmarshalJSON(data []byte) error

type JobResponseDataErrorsItem 

type JobResponseDataErrorsItem struct {
	Error *string `json:"error,omitempty" url:"error,omitempty"`
	URL   *string `json:"url,omitempty" url:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*JobResponseDataErrorsItem) GetError 

func (j *JobResponseDataErrorsItem) GetError() *string

func (*JobResponseDataErrorsItem) GetExtraProperties 

func (j *JobResponseDataErrorsItem) GetExtraProperties() map[string]interface{}

func (*JobResponseDataErrorsItem) GetURL 

func (j *JobResponseDataErrorsItem) GetURL() *string

func (*JobResponseDataErrorsItem) MarshalJSON 

func (j *JobResponseDataErrorsItem) MarshalJSON() ([]byte, error)

func (*JobResponseDataErrorsItem) SetError 

func (j *JobResponseDataErrorsItem) SetError(error_ *string)

SetError sets the Error field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseDataErrorsItem) SetURL 

func (j *JobResponseDataErrorsItem) SetURL(url *string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobResponseDataErrorsItem) String 

func (j *JobResponseDataErrorsItem) String() string

func (*JobResponseDataErrorsItem) UnmarshalJSON 

func (j *JobResponseDataErrorsItem) UnmarshalJSON(data []byte) error

type JobSummary 

type JobSummary struct {
	Completed   *int           `json:"completed,omitempty" url:"completed,omitempty"`
	CompletedAt *time.Time     `json:"completedAt,omitempty" url:"completedAt,omitempty"`
	CreatedAt   time.Time      `json:"createdAt" url:"createdAt"`
	CreditsUsed int            `json:"creditsUsed" url:"creditsUsed"`
	Error       *string        `json:"error,omitempty" url:"error,omitempty"`
	Failed      *int           `json:"failed,omitempty" url:"failed,omitempty"`
	ID          string         `json:"id" url:"id"`
	StartedAt   *time.Time     `json:"startedAt,omitempty" url:"startedAt,omitempty"`
	Status      string         `json:"status" url:"status"`
	Total       int            `json:"total" url:"total"`
	Type        JobSummaryType `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*JobSummary) GetCompleted 

func (j *JobSummary) GetCompleted() *int

func (*JobSummary) GetCompletedAt 

func (j *JobSummary) GetCompletedAt() *time.Time

func (*JobSummary) GetCreatedAt 

func (j *JobSummary) GetCreatedAt() time.Time

func (*JobSummary) GetCreditsUsed 

func (j *JobSummary) GetCreditsUsed() int

func (*JobSummary) GetError 

func (j *JobSummary) GetError() *string

func (*JobSummary) GetExtraProperties 

func (j *JobSummary) GetExtraProperties() map[string]interface{}

func (*JobSummary) GetFailed 

func (j *JobSummary) GetFailed() *int

func (*JobSummary) GetID 

func (j *JobSummary) GetID() string

func (*JobSummary) GetStartedAt 

func (j *JobSummary) GetStartedAt() *time.Time

func (*JobSummary) GetStatus 

func (j *JobSummary) GetStatus() string

func (*JobSummary) GetTotal 

func (j *JobSummary) GetTotal() int

func (*JobSummary) GetType 

func (j *JobSummary) GetType() JobSummaryType

func (*JobSummary) MarshalJSON 

func (j *JobSummary) MarshalJSON() ([]byte, error)

func (*JobSummary) SetCompleted 

func (j *JobSummary) SetCompleted(completed *int)

SetCompleted sets the Completed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetCompletedAt 

func (j *JobSummary) SetCompletedAt(completedAt *time.Time)

SetCompletedAt sets the CompletedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetCreatedAt 

func (j *JobSummary) SetCreatedAt(createdAt time.Time)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetCreditsUsed 

func (j *JobSummary) SetCreditsUsed(creditsUsed int)

SetCreditsUsed sets the CreditsUsed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetError 

func (j *JobSummary) SetError(error_ *string)

SetError sets the Error field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetFailed 

func (j *JobSummary) SetFailed(failed *int)

SetFailed sets the Failed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetID 

func (j *JobSummary) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetStartedAt 

func (j *JobSummary) SetStartedAt(startedAt *time.Time)

SetStartedAt sets the StartedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetStatus 

func (j *JobSummary) SetStatus(status string)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetTotal 

func (j *JobSummary) SetTotal(total int)

SetTotal sets the Total field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) SetType 

func (j *JobSummary) SetType(type_ JobSummaryType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*JobSummary) String 

func (j *JobSummary) String() string

func (*JobSummary) UnmarshalJSON 

func (j *JobSummary) UnmarshalJSON(data []byte) error

type JobSummaryType 

type JobSummaryType string
const (
	JobSummaryTypeCrawl   JobSummaryType = "crawl"
	JobSummaryTypeExtract JobSummaryType = "extract"
)

func NewJobSummaryTypeFromString 

func NewJobSummaryTypeFromString(s string) (JobSummaryType, error)

func (JobSummaryType) Ptr 

func (j JobSummaryType) Ptr() *JobSummaryType

type ListJobsRequest 

type ListJobsRequest struct {
	Type   *ListJobsRequestType   `json:"-" url:"type,omitempty"`
	Status *ListJobsRequestStatus `json:"-" url:"status,omitempty"`
	Page   *float64               `json:"-" url:"page,omitempty"`
	Limit  *float64               `json:"-" url:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*ListJobsRequest) SetLimit 

func (l *ListJobsRequest) SetLimit(limit *float64)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsRequest) SetPage 

func (l *ListJobsRequest) SetPage(page *float64)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsRequest) SetStatus 

func (l *ListJobsRequest) SetStatus(status *ListJobsRequestStatus)

SetStatus sets the Status field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsRequest) SetType 

func (l *ListJobsRequest) SetType(type_ *ListJobsRequestType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

type ListJobsRequestStatus 

type ListJobsRequestStatus string
const (
	ListJobsRequestStatusPending   ListJobsRequestStatus = "PENDING"
	ListJobsRequestStatusRunning   ListJobsRequestStatus = "RUNNING"
	ListJobsRequestStatusCompleted ListJobsRequestStatus = "COMPLETED"
	ListJobsRequestStatusFailed    ListJobsRequestStatus = "FAILED"
	ListJobsRequestStatusCancelled ListJobsRequestStatus = "CANCELLED"
)

func NewListJobsRequestStatusFromString 

func NewListJobsRequestStatusFromString(s string) (ListJobsRequestStatus, error)

func (ListJobsRequestStatus) Ptr 

func (l ListJobsRequestStatus) Ptr() *ListJobsRequestStatus

type ListJobsRequestType 

type ListJobsRequestType string
const (
	ListJobsRequestTypeCrawl   ListJobsRequestType = "crawl"
	ListJobsRequestTypeExtract ListJobsRequestType = "extract"
)

func NewListJobsRequestTypeFromString 

func NewListJobsRequestTypeFromString(s string) (ListJobsRequestType, error)

func (ListJobsRequestType) Ptr 

func (l ListJobsRequestType) Ptr() *ListJobsRequestType

type ListJobsResponse 

type ListJobsResponse struct {
	Data    *ListJobsResponseData `json:"data" url:"data"`
	Success bool                  `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*ListJobsResponse) GetData 

func (l *ListJobsResponse) GetData() *ListJobsResponseData

func (*ListJobsResponse) GetExtraProperties 

func (l *ListJobsResponse) GetExtraProperties() map[string]interface{}

func (*ListJobsResponse) GetSuccess 

func (l *ListJobsResponse) GetSuccess() bool

func (*ListJobsResponse) MarshalJSON 

func (l *ListJobsResponse) MarshalJSON() ([]byte, error)

func (*ListJobsResponse) SetData 

func (l *ListJobsResponse) SetData(data *ListJobsResponseData)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsResponse) SetSuccess 

func (l *ListJobsResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsResponse) String 

func (l *ListJobsResponse) String() string

func (*ListJobsResponse) UnmarshalJSON 

func (l *ListJobsResponse) UnmarshalJSON(data []byte) error

type ListJobsResponseData 

type ListJobsResponseData struct {
	Jobs       []*JobSummary `json:"jobs" url:"jobs"`
	Pagination *Pagination   `json:"pagination" url:"pagination"`
	// contains filtered or unexported fields
}

func (*ListJobsResponseData) GetExtraProperties 

func (l *ListJobsResponseData) GetExtraProperties() map[string]interface{}

func (*ListJobsResponseData) GetJobs 

func (l *ListJobsResponseData) GetJobs() []*JobSummary

func (*ListJobsResponseData) GetPagination 

func (l *ListJobsResponseData) GetPagination() *Pagination

func (*ListJobsResponseData) MarshalJSON 

func (l *ListJobsResponseData) MarshalJSON() ([]byte, error)

func (*ListJobsResponseData) SetJobs 

func (l *ListJobsResponseData) SetJobs(jobs []*JobSummary)

SetJobs sets the Jobs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsResponseData) SetPagination 

func (l *ListJobsResponseData) SetPagination(pagination *Pagination)

SetPagination sets the Pagination field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListJobsResponseData) String 

func (l *ListJobsResponseData) String() string

func (*ListJobsResponseData) UnmarshalJSON 

func (l *ListJobsResponseData) UnmarshalJSON(data []byte) error

type ListWebhooksResponse 

type ListWebhooksResponse struct {
	Data    []*Webhook `json:"data" url:"data"`
	Success bool       `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*ListWebhooksResponse) GetData 

func (l *ListWebhooksResponse) GetData() []*Webhook

func (*ListWebhooksResponse) GetExtraProperties 

func (l *ListWebhooksResponse) GetExtraProperties() map[string]interface{}

func (*ListWebhooksResponse) GetSuccess 

func (l *ListWebhooksResponse) GetSuccess() bool

func (*ListWebhooksResponse) MarshalJSON 

func (l *ListWebhooksResponse) MarshalJSON() ([]byte, error)

func (*ListWebhooksResponse) SetData 

func (l *ListWebhooksResponse) SetData(data []*Webhook)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListWebhooksResponse) SetSuccess 

func (l *ListWebhooksResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ListWebhooksResponse) String 

func (l *ListWebhooksResponse) String() string

func (*ListWebhooksResponse) UnmarshalJSON 

func (l *ListWebhooksResponse) UnmarshalJSON(data []byte) error

type LocationDto 

type LocationDto struct {
	Country   *string  `json:"country,omitempty" url:"country,omitempty"`
	Languages []string `json:"languages,omitempty" url:"languages,omitempty"`
	// contains filtered or unexported fields
}

func (*LocationDto) GetCountry 

func (l *LocationDto) GetCountry() *string

func (*LocationDto) GetExtraProperties 

func (l *LocationDto) GetExtraProperties() map[string]interface{}

func (*LocationDto) GetLanguages 

func (l *LocationDto) GetLanguages() []string

func (*LocationDto) MarshalJSON 

func (l *LocationDto) MarshalJSON() ([]byte, error)

func (*LocationDto) SetCountry 

func (l *LocationDto) SetCountry(country *string)

SetCountry sets the Country field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*LocationDto) SetLanguages 

func (l *LocationDto) SetLanguages(languages []string)

SetLanguages sets the Languages field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*LocationDto) String 

func (l *LocationDto) String() string

func (*LocationDto) UnmarshalJSON 

func (l *LocationDto) UnmarshalJSON(data []byte) error

type MapDto 

type MapDto struct {
	// Ignore query parameters when discovering URLs
	IgnoreQueryParameters *bool `json:"ignoreQueryParameters,omitempty" url:"-"`
	// Include subdomains in the map
	IncludeSubdomains *bool `json:"includeSubdomains,omitempty" url:"-"`
	// Maximum number of URLs to return
	Limit *float64 `json:"limit,omitempty" url:"-"`
	// Location configuration
	Location *LocationDto `json:"location,omitempty" url:"-"`
	// Search filter for URLs
	Search *string `json:"search,omitempty" url:"-"`
	// How to handle sitemaps
	Sitemap *MapDtoSitemap `json:"sitemap,omitempty" url:"-"`
	// Timeout for map operation in milliseconds
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// URL to map
	URL string `json:"url" url:"-"`
	// contains filtered or unexported fields
}

func (*MapDto) MarshalJSON 

func (m *MapDto) MarshalJSON() ([]byte, error)

func (*MapDto) SetIgnoreQueryParameters 

func (m *MapDto) SetIgnoreQueryParameters(ignoreQueryParameters *bool)

SetIgnoreQueryParameters sets the IgnoreQueryParameters field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetIncludeSubdomains 

func (m *MapDto) SetIncludeSubdomains(includeSubdomains *bool)

SetIncludeSubdomains sets the IncludeSubdomains field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetLimit 

func (m *MapDto) SetLimit(limit *float64)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetLocation 

func (m *MapDto) SetLocation(location *LocationDto)

SetLocation sets the Location field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetSearch 

func (m *MapDto) SetSearch(search *string)

SetSearch sets the Search field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetSitemap 

func (m *MapDto) SetSitemap(sitemap *MapDtoSitemap)

SetSitemap sets the Sitemap field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetTimeout 

func (m *MapDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) SetURL 

func (m *MapDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapDto) UnmarshalJSON 

func (m *MapDto) UnmarshalJSON(data []byte) error

type MapDtoSitemap 

type MapDtoSitemap string

How to handle sitemaps 

const (
	MapDtoSitemapInclude MapDtoSitemap = "include"
	MapDtoSitemapSkip    MapDtoSitemap = "skip"
	MapDtoSitemapOnly    MapDtoSitemap = "only"
)

func NewMapDtoSitemapFromString 

func NewMapDtoSitemapFromString(s string) (MapDtoSitemap, error)

func (MapDtoSitemap) Ptr 

func (m MapDtoSitemap) Ptr() *MapDtoSitemap
type MapLink struct {
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	Title       *string `json:"title,omitempty" url:"title,omitempty"`
	URL         string  `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*MapLink) GetDescription 

func (m *MapLink) GetDescription() *string

func (*MapLink) GetExtraProperties 

func (m *MapLink) GetExtraProperties() map[string]interface{}

func (*MapLink) GetTitle 

func (m *MapLink) GetTitle() *string

func (*MapLink) GetURL 

func (m *MapLink) GetURL() string

func (*MapLink) MarshalJSON 

func (m *MapLink) MarshalJSON() ([]byte, error)

func (*MapLink) SetDescription 

func (m *MapLink) SetDescription(description *string)

SetDescription sets the Description field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapLink) SetTitle 

func (m *MapLink) SetTitle(title *string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapLink) SetURL 

func (m *MapLink) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapLink) String 

func (m *MapLink) String() string

func (*MapLink) UnmarshalJSON 

func (m *MapLink) UnmarshalJSON(data []byte) error

type MapResponse 

type MapResponse struct {
	CreditsUsed int        `json:"creditsUsed" url:"creditsUsed"`
	Links       []*MapLink `json:"links" url:"links"`
	Success     bool       `json:"success" url:"success"`
	Total       int        `json:"total" url:"total"`
	// contains filtered or unexported fields
}

func (*MapResponse) GetCreditsUsed 

func (m *MapResponse) GetCreditsUsed() int

func (*MapResponse) GetExtraProperties 

func (m *MapResponse) GetExtraProperties() map[string]interface{}
func (m *MapResponse) GetLinks() []*MapLink

func (*MapResponse) GetSuccess 

func (m *MapResponse) GetSuccess() bool

func (*MapResponse) GetTotal 

func (m *MapResponse) GetTotal() int

func (*MapResponse) MarshalJSON 

func (m *MapResponse) MarshalJSON() ([]byte, error)

func (*MapResponse) SetCreditsUsed 

func (m *MapResponse) SetCreditsUsed(creditsUsed int)

SetCreditsUsed sets the CreditsUsed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization. 

func (m *MapResponse) SetLinks(links []*MapLink)

SetLinks sets the Links field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapResponse) SetSuccess 

func (m *MapResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapResponse) SetTotal 

func (m *MapResponse) SetTotal(total int)

SetTotal sets the Total field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MapResponse) String 

func (m *MapResponse) String() string

func (*MapResponse) UnmarshalJSON 

func (m *MapResponse) UnmarshalJSON(data []byte) error

type MessageResponse 

type MessageResponse struct {
	Message string `json:"message" url:"message"`
	Success bool   `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*MessageResponse) GetExtraProperties 

func (m *MessageResponse) GetExtraProperties() map[string]interface{}

func (*MessageResponse) GetMessage 

func (m *MessageResponse) GetMessage() string

func (*MessageResponse) GetSuccess 

func (m *MessageResponse) GetSuccess() bool

func (*MessageResponse) MarshalJSON 

func (m *MessageResponse) MarshalJSON() ([]byte, error)

func (*MessageResponse) SetMessage 

func (m *MessageResponse) SetMessage(message string)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MessageResponse) SetSuccess 

func (m *MessageResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*MessageResponse) String 

func (m *MessageResponse) String() string

func (*MessageResponse) UnmarshalJSON 

func (m *MessageResponse) UnmarshalJSON(data []byte) error

type NotFoundError 

type NotFoundError struct {
	*core.APIError
	Body any
}

Website could not be loaded

func (*NotFoundError) MarshalJSON 

func (n *NotFoundError) MarshalJSON() ([]byte, error)

func (*NotFoundError) UnmarshalJSON 

func (n *NotFoundError) UnmarshalJSON(data []byte) error

func (*NotFoundError) Unwrap 

func (n *NotFoundError) Unwrap() error

type Pagination 

type Pagination struct {
	Limit      int  `json:"limit" url:"limit"`
	Page       int  `json:"page" url:"page"`
	Total      int  `json:"total" url:"total"`
	TotalPages *int `json:"totalPages,omitempty" url:"totalPages,omitempty"`
	// contains filtered or unexported fields
}

func (*Pagination) GetExtraProperties 

func (p *Pagination) GetExtraProperties() map[string]interface{}

func (*Pagination) GetLimit 

func (p *Pagination) GetLimit() int

func (*Pagination) GetPage 

func (p *Pagination) GetPage() int

func (*Pagination) GetTotal 

func (p *Pagination) GetTotal() int

func (*Pagination) GetTotalPages 

func (p *Pagination) GetTotalPages() *int

func (*Pagination) MarshalJSON 

func (p *Pagination) MarshalJSON() ([]byte, error)

func (*Pagination) SetLimit 

func (p *Pagination) SetLimit(limit int)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) SetPage 

func (p *Pagination) SetPage(page int)

SetPage sets the Page field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) SetTotal 

func (p *Pagination) SetTotal(total int)

SetTotal sets the Total field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) SetTotalPages 

func (p *Pagination) SetTotalPages(totalPages *int)

SetTotalPages sets the TotalPages field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Pagination) String 

func (p *Pagination) String() string

func (*Pagination) UnmarshalJSON 

func (p *Pagination) UnmarshalJSON(data []byte) error

type ParseDto 

type ParseDto struct {
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// Public PDF, Word document, or spreadsheet URL
	URL string `json:"url" url:"-"`
	// contains filtered or unexported fields
}

func (*ParseDto) MarshalJSON 

func (p *ParseDto) MarshalJSON() ([]byte, error)

func (*ParseDto) SetTimeout 

func (p *ParseDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ParseDto) SetURL 

func (p *ParseDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ParseDto) UnmarshalJSON 

func (p *ParseDto) UnmarshalJSON(data []byte) error

type ScrapeDto 

type ScrapeDto struct {
	// Browser actions to execute
	Actions []*ActionDto `json:"actions,omitempty" url:"-"`
	// Enable ad-blocking and cookie popup blocking
	BlockAds *bool `json:"blockAds,omitempty" url:"-"`
	// Domain to scrape. Normalized to https://domain when url is omitted.
	Domain *string `json:"domain,omitempty" url:"-"`
	// CSS selectors to exclude
	ExcludeTags []string `json:"excludeTags,omitempty" url:"-"`
	// Schema for structured data extraction (used with json format)
	ExtractionSchema map[string]any `json:"extractionSchema,omitempty" url:"-"`
	// Output formats - can be simple strings or format objects with options
	Formats []*ScrapeDtoFormatsItem `json:"formats,omitempty" url:"-"`
	// Custom headers
	Headers map[string]any `json:"headers,omitempty" url:"-"`
	// CSS selectors to include
	IncludeTags []string `json:"includeTags,omitempty" url:"-"`
	// Location settings
	Location *LocationDto `json:"location,omitempty" url:"-"`
	// Cache max age in milliseconds
	MaxAge *float64 `json:"maxAge,omitempty" url:"-"`
	// Emulate mobile device for scraping
	Mobile *bool `json:"mobile,omitempty" url:"-"`
	// Extract only main content
	OnlyMainContent *bool `json:"onlyMainContent,omitempty" url:"-"`
	// Proxy mode. auto starts direct and escalates only when blocked. basic is an alias for none.
	Proxy *ScrapeDtoProxy `json:"proxy,omitempty" url:"-"`
	// Remove base64 images from output (keeps alt text)
	RemoveBase64Images *bool `json:"removeBase64Images,omitempty" url:"-"`
	// Return screenshot/PDF output inline as a base64 data URL instead of an uploaded CDN URL. Default false (a CDN URL is returned).
	ScreenshotAsBase64 *bool `json:"screenshotAsBase64,omitempty" url:"-"`
	// Skip TLS certificate verification
	SkipTLSVerification *bool `json:"skipTlsVerification,omitempty" url:"-"`
	// Store result in cache
	StoreInCache *bool `json:"storeInCache,omitempty" url:"-"`
	// Request timeout in milliseconds
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// URL to scrape. Either url or domain is required.
	URL *string `json:"url,omitempty" url:"-"`
	// Wait time before scraping (ms)
	WaitFor *float64 `json:"waitFor,omitempty" url:"-"`
	// Reserved for a future zero-data-retention mode. true is currently rejected with 400 ZERO_DATA_RETENTION_NOT_SUPPORTED; omit or use false.
	ZeroDataRetention *bool `json:"zeroDataRetention,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*ScrapeDto) MarshalJSON 

func (s *ScrapeDto) MarshalJSON() ([]byte, error)

func (*ScrapeDto) SetActions 

func (s *ScrapeDto) SetActions(actions []*ActionDto)

SetActions sets the Actions field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetBlockAds 

func (s *ScrapeDto) SetBlockAds(blockAds *bool)

SetBlockAds sets the BlockAds field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetDomain 

func (s *ScrapeDto) SetDomain(domain *string)

SetDomain sets the Domain field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetExcludeTags 

func (s *ScrapeDto) SetExcludeTags(excludeTags []string)

SetExcludeTags sets the ExcludeTags field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetExtractionSchema 

func (s *ScrapeDto) SetExtractionSchema(extractionSchema map[string]any)

SetExtractionSchema sets the ExtractionSchema field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetFormats 

func (s *ScrapeDto) SetFormats(formats []*ScrapeDtoFormatsItem)

SetFormats sets the Formats field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetHeaders 

func (s *ScrapeDto) SetHeaders(headers map[string]any)

SetHeaders sets the Headers field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetIncludeTags 

func (s *ScrapeDto) SetIncludeTags(includeTags []string)

SetIncludeTags sets the IncludeTags field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetLocation 

func (s *ScrapeDto) SetLocation(location *LocationDto)

SetLocation sets the Location field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetMaxAge 

func (s *ScrapeDto) SetMaxAge(maxAge *float64)

SetMaxAge sets the MaxAge field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetMobile 

func (s *ScrapeDto) SetMobile(mobile *bool)

SetMobile sets the Mobile field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetOnlyMainContent 

func (s *ScrapeDto) SetOnlyMainContent(onlyMainContent *bool)

SetOnlyMainContent sets the OnlyMainContent field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetProxy 

func (s *ScrapeDto) SetProxy(proxy *ScrapeDtoProxy)

SetProxy sets the Proxy field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetRemoveBase64Images 

func (s *ScrapeDto) SetRemoveBase64Images(removeBase64Images *bool)

SetRemoveBase64Images sets the RemoveBase64Images field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetScreenshotAsBase64 

func (s *ScrapeDto) SetScreenshotAsBase64(screenshotAsBase64 *bool)

SetScreenshotAsBase64 sets the ScreenshotAsBase64 field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetSkipTLSVerification 

func (s *ScrapeDto) SetSkipTLSVerification(skipTLSVerification *bool)

SetSkipTLSVerification sets the SkipTLSVerification field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetStoreInCache 

func (s *ScrapeDto) SetStoreInCache(storeInCache *bool)

SetStoreInCache sets the StoreInCache field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetTimeout 

func (s *ScrapeDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetURL 

func (s *ScrapeDto) SetURL(url *string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetWaitFor 

func (s *ScrapeDto) SetWaitFor(waitFor *float64)

SetWaitFor sets the WaitFor field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) SetZeroDataRetention 

func (s *ScrapeDto) SetZeroDataRetention(zeroDataRetention *bool)

SetZeroDataRetention sets the ZeroDataRetention field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeDto) UnmarshalJSON 

func (s *ScrapeDto) UnmarshalJSON(data []byte) error

type ScrapeDtoFormatsItem 

type ScrapeDtoFormatsItem struct {
	ScrapeDtoFormatsItemZero ScrapeDtoFormatsItemZero
	JSONFormatDto            *JSONFormatDto
	SummaryFormatDto         *SummaryFormatDto
	ChangeTrackingFormatDto  *ChangeTrackingFormatDto
	// contains filtered or unexported fields
}

func (*ScrapeDtoFormatsItem) Accept 

func (s *ScrapeDtoFormatsItem) Accept(visitor ScrapeDtoFormatsItemVisitor) error

func (*ScrapeDtoFormatsItem) GetChangeTrackingFormatDto 

func (s *ScrapeDtoFormatsItem) GetChangeTrackingFormatDto() *ChangeTrackingFormatDto

func (*ScrapeDtoFormatsItem) GetJSONFormatDto 

func (s *ScrapeDtoFormatsItem) GetJSONFormatDto() *JSONFormatDto

func (*ScrapeDtoFormatsItem) GetScrapeDtoFormatsItemZero 

func (s *ScrapeDtoFormatsItem) GetScrapeDtoFormatsItemZero() ScrapeDtoFormatsItemZero

func (*ScrapeDtoFormatsItem) GetSummaryFormatDto 

func (s *ScrapeDtoFormatsItem) GetSummaryFormatDto() *SummaryFormatDto

func (ScrapeDtoFormatsItem) MarshalJSON 

func (s ScrapeDtoFormatsItem) MarshalJSON() ([]byte, error)

func (*ScrapeDtoFormatsItem) UnmarshalJSON 

func (s *ScrapeDtoFormatsItem) UnmarshalJSON(data []byte) error

type ScrapeDtoFormatsItemVisitor 

type ScrapeDtoFormatsItemVisitor interface {
	VisitScrapeDtoFormatsItemZero(ScrapeDtoFormatsItemZero) error
	VisitJSONFormatDto(*JSONFormatDto) error
	VisitSummaryFormatDto(*SummaryFormatDto) error
	VisitChangeTrackingFormatDto(*ChangeTrackingFormatDto) error
}

type ScrapeDtoFormatsItemZero 

type ScrapeDtoFormatsItemZero string
const (
	ScrapeDtoFormatsItemZeroMarkdown       ScrapeDtoFormatsItemZero = "markdown"
	ScrapeDtoFormatsItemZeroHTML           ScrapeDtoFormatsItemZero = "html"
	ScrapeDtoFormatsItemZeroRawhtml        ScrapeDtoFormatsItemZero = "rawhtml"
	ScrapeDtoFormatsItemZeroLinks          ScrapeDtoFormatsItemZero = "links"
	ScrapeDtoFormatsItemZeroImages         ScrapeDtoFormatsItemZero = "images"
	ScrapeDtoFormatsItemZeroSummary        ScrapeDtoFormatsItemZero = "summary"
	ScrapeDtoFormatsItemZeroJSON           ScrapeDtoFormatsItemZero = "json"
	ScrapeDtoFormatsItemZeroChangeTracking ScrapeDtoFormatsItemZero = "changeTracking"
)

func NewScrapeDtoFormatsItemZeroFromString 

func NewScrapeDtoFormatsItemZeroFromString(s string) (ScrapeDtoFormatsItemZero, error)

func (ScrapeDtoFormatsItemZero) Ptr 

func (s ScrapeDtoFormatsItemZero) Ptr() *ScrapeDtoFormatsItemZero

type ScrapeDtoProxy 

type ScrapeDtoProxy string

Proxy mode. auto starts direct and escalates only when blocked. basic is an alias for none. 

const (
	ScrapeDtoProxyNone        ScrapeDtoProxy = "none"
	ScrapeDtoProxyBasic       ScrapeDtoProxy = "basic"
	ScrapeDtoProxyDatacenter  ScrapeDtoProxy = "datacenter"
	ScrapeDtoProxyResidential ScrapeDtoProxy = "residential"
	ScrapeDtoProxyStealth     ScrapeDtoProxy = "stealth"
	ScrapeDtoProxyAuto        ScrapeDtoProxy = "auto"
)

func NewScrapeDtoProxyFromString 

func NewScrapeDtoProxyFromString(s string) (ScrapeDtoProxy, error)

func (ScrapeDtoProxy) Ptr 

func (s ScrapeDtoProxy) Ptr() *ScrapeDtoProxy

type ScrapeMetadata 

type ScrapeMetadata struct {
	ContentType *string   `json:"contentType,omitempty" url:"contentType,omitempty"`
	StatusCode  *int      `json:"statusCode,omitempty" url:"statusCode,omitempty"`
	Timestamp   time.Time `json:"timestamp" url:"timestamp"`
	Title       *string   `json:"title,omitempty" url:"title,omitempty"`
	URL         string    `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*ScrapeMetadata) GetContentType 

func (s *ScrapeMetadata) GetContentType() *string

func (*ScrapeMetadata) GetExtraProperties 

func (s *ScrapeMetadata) GetExtraProperties() map[string]interface{}

func (*ScrapeMetadata) GetStatusCode 

func (s *ScrapeMetadata) GetStatusCode() *int

func (*ScrapeMetadata) GetTimestamp 

func (s *ScrapeMetadata) GetTimestamp() time.Time

func (*ScrapeMetadata) GetTitle 

func (s *ScrapeMetadata) GetTitle() *string

func (*ScrapeMetadata) GetURL 

func (s *ScrapeMetadata) GetURL() string

func (*ScrapeMetadata) MarshalJSON 

func (s *ScrapeMetadata) MarshalJSON() ([]byte, error)

func (*ScrapeMetadata) SetContentType 

func (s *ScrapeMetadata) SetContentType(contentType *string)

SetContentType sets the ContentType field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeMetadata) SetStatusCode 

func (s *ScrapeMetadata) SetStatusCode(statusCode *int)

SetStatusCode sets the StatusCode field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeMetadata) SetTimestamp 

func (s *ScrapeMetadata) SetTimestamp(timestamp time.Time)

SetTimestamp sets the Timestamp field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeMetadata) SetTitle 

func (s *ScrapeMetadata) SetTitle(title *string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeMetadata) SetURL 

func (s *ScrapeMetadata) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeMetadata) String 

func (s *ScrapeMetadata) String() string

func (*ScrapeMetadata) UnmarshalJSON 

func (s *ScrapeMetadata) UnmarshalJSON(data []byte) error

type ScrapeResponse 

type ScrapeResponse struct {
	Credits  *ScrapeResponseCredits `json:"credits" url:"credits"`
	Data     map[string]any         `json:"data,omitempty" url:"data,omitempty"`
	Error    *string                `json:"error,omitempty" url:"error,omitempty"`
	Metadata *ScrapeMetadata        `json:"metadata" url:"metadata"`
	Success  bool                   `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*ScrapeResponse) GetCredits 

func (s *ScrapeResponse) GetCredits() *ScrapeResponseCredits

func (*ScrapeResponse) GetData 

func (s *ScrapeResponse) GetData() map[string]any

func (*ScrapeResponse) GetError 

func (s *ScrapeResponse) GetError() *string

func (*ScrapeResponse) GetExtraProperties 

func (s *ScrapeResponse) GetExtraProperties() map[string]interface{}

func (*ScrapeResponse) GetMetadata 

func (s *ScrapeResponse) GetMetadata() *ScrapeMetadata

func (*ScrapeResponse) GetSuccess 

func (s *ScrapeResponse) GetSuccess() bool

func (*ScrapeResponse) MarshalJSON 

func (s *ScrapeResponse) MarshalJSON() ([]byte, error)

func (*ScrapeResponse) SetCredits 

func (s *ScrapeResponse) SetCredits(credits *ScrapeResponseCredits)

SetCredits sets the Credits field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponse) SetData 

func (s *ScrapeResponse) SetData(data map[string]any)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponse) SetError 

func (s *ScrapeResponse) SetError(error_ *string)

SetError sets the Error field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponse) SetMetadata 

func (s *ScrapeResponse) SetMetadata(metadata *ScrapeMetadata)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponse) SetSuccess 

func (s *ScrapeResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponse) String 

func (s *ScrapeResponse) String() string

func (*ScrapeResponse) UnmarshalJSON 

func (s *ScrapeResponse) UnmarshalJSON(data []byte) error

type ScrapeResponseCredits 

type ScrapeResponseCredits struct {
	Used int `json:"used" url:"used"`
	// contains filtered or unexported fields
}

func (*ScrapeResponseCredits) GetExtraProperties 

func (s *ScrapeResponseCredits) GetExtraProperties() map[string]interface{}

func (*ScrapeResponseCredits) GetUsed 

func (s *ScrapeResponseCredits) GetUsed() int

func (*ScrapeResponseCredits) MarshalJSON 

func (s *ScrapeResponseCredits) MarshalJSON() ([]byte, error)

func (*ScrapeResponseCredits) SetUsed 

func (s *ScrapeResponseCredits) SetUsed(used int)

SetUsed sets the Used field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScrapeResponseCredits) String 

func (s *ScrapeResponseCredits) String() string

func (*ScrapeResponseCredits) UnmarshalJSON 

func (s *ScrapeResponseCredits) UnmarshalJSON(data []byte) error

type ScreenshotClipDto 

type ScreenshotClipDto struct {
	Height float64 `json:"height" url:"height"`
	Width  float64 `json:"width" url:"width"`
	X      float64 `json:"x" url:"x"`
	Y      float64 `json:"y" url:"y"`
	// contains filtered or unexported fields
}

func (*ScreenshotClipDto) GetExtraProperties 

func (s *ScreenshotClipDto) GetExtraProperties() map[string]interface{}

func (*ScreenshotClipDto) GetHeight 

func (s *ScreenshotClipDto) GetHeight() float64

func (*ScreenshotClipDto) GetWidth 

func (s *ScreenshotClipDto) GetWidth() float64

func (*ScreenshotClipDto) GetX 

func (s *ScreenshotClipDto) GetX() float64

func (*ScreenshotClipDto) GetY 

func (s *ScreenshotClipDto) GetY() float64

func (*ScreenshotClipDto) MarshalJSON 

func (s *ScreenshotClipDto) MarshalJSON() ([]byte, error)

func (*ScreenshotClipDto) SetHeight 

func (s *ScreenshotClipDto) SetHeight(height float64)

SetHeight sets the Height field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotClipDto) SetWidth 

func (s *ScreenshotClipDto) SetWidth(width float64)

SetWidth sets the Width field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotClipDto) SetX 

func (s *ScreenshotClipDto) SetX(x float64)

SetX sets the X field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotClipDto) SetY 

func (s *ScreenshotClipDto) SetY(y float64)

SetY sets the Y field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotClipDto) String 

func (s *ScreenshotClipDto) String() string

func (*ScreenshotClipDto) UnmarshalJSON 

func (s *ScreenshotClipDto) UnmarshalJSON(data []byte) error

type ScreenshotCookieDto 

type ScreenshotCookieDto struct {
	Domain   *string                      `json:"domain,omitempty" url:"domain,omitempty"`
	HTTPOnly *bool                        `json:"httpOnly,omitempty" url:"httpOnly,omitempty"`
	Name     string                       `json:"name" url:"name"`
	Path     *string                      `json:"path,omitempty" url:"path,omitempty"`
	SameSite *ScreenshotCookieDtoSameSite `json:"sameSite,omitempty" url:"sameSite,omitempty"`
	Secure   *bool                        `json:"secure,omitempty" url:"secure,omitempty"`
	Value    string                       `json:"value" url:"value"`
	// contains filtered or unexported fields
}

func (*ScreenshotCookieDto) GetDomain 

func (s *ScreenshotCookieDto) GetDomain() *string

func (*ScreenshotCookieDto) GetExtraProperties 

func (s *ScreenshotCookieDto) GetExtraProperties() map[string]interface{}

func (*ScreenshotCookieDto) GetHTTPOnly 

func (s *ScreenshotCookieDto) GetHTTPOnly() *bool

func (*ScreenshotCookieDto) GetName 

func (s *ScreenshotCookieDto) GetName() string

func (*ScreenshotCookieDto) GetPath 

func (s *ScreenshotCookieDto) GetPath() *string

func (*ScreenshotCookieDto) GetSameSite 

func (s *ScreenshotCookieDto) GetSameSite() *ScreenshotCookieDtoSameSite

func (*ScreenshotCookieDto) GetSecure 

func (s *ScreenshotCookieDto) GetSecure() *bool

func (*ScreenshotCookieDto) GetValue 

func (s *ScreenshotCookieDto) GetValue() string

func (*ScreenshotCookieDto) MarshalJSON 

func (s *ScreenshotCookieDto) MarshalJSON() ([]byte, error)

func (*ScreenshotCookieDto) SetDomain 

func (s *ScreenshotCookieDto) SetDomain(domain *string)

SetDomain sets the Domain field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetHTTPOnly 

func (s *ScreenshotCookieDto) SetHTTPOnly(httpOnly *bool)

SetHTTPOnly sets the HTTPOnly field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetName 

func (s *ScreenshotCookieDto) SetName(name string)

SetName sets the Name field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetPath 

func (s *ScreenshotCookieDto) SetPath(path *string)

SetPath sets the Path field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetSameSite 

func (s *ScreenshotCookieDto) SetSameSite(sameSite *ScreenshotCookieDtoSameSite)

SetSameSite sets the SameSite field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetSecure 

func (s *ScreenshotCookieDto) SetSecure(secure *bool)

SetSecure sets the Secure field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) SetValue 

func (s *ScreenshotCookieDto) SetValue(value string)

SetValue sets the Value field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotCookieDto) String 

func (s *ScreenshotCookieDto) String() string

func (*ScreenshotCookieDto) UnmarshalJSON 

func (s *ScreenshotCookieDto) UnmarshalJSON(data []byte) error

type ScreenshotCookieDtoSameSite 

type ScreenshotCookieDtoSameSite string
const (
	ScreenshotCookieDtoSameSiteStrict ScreenshotCookieDtoSameSite = "Strict"
	ScreenshotCookieDtoSameSiteLax    ScreenshotCookieDtoSameSite = "Lax"
	ScreenshotCookieDtoSameSiteNone   ScreenshotCookieDtoSameSite = "None"
)

func NewScreenshotCookieDtoSameSiteFromString 

func NewScreenshotCookieDtoSameSiteFromString(s string) (ScreenshotCookieDtoSameSite, error)

func (ScreenshotCookieDtoSameSite) Ptr 

func (s ScreenshotCookieDtoSameSite) Ptr() *ScreenshotCookieDtoSameSite

type ScreenshotDto 

type ScreenshotDto struct {
	// Block common advertising and analytics requests
	BlockAds *bool `json:"blockAds,omitempty" url:"-"`
	// Click this CSS selector before capture
	ClickSelector *string `json:"clickSelector,omitempty" url:"-"`
	// Capture an exact pixel rectangle instead of the page
	Clip        *ScreenshotClipDto        `json:"clip,omitempty" url:"-"`
	ColorScheme *ScreenshotDtoColorScheme `json:"colorScheme,omitempty" url:"-"`
	// Cookies to set before loading the page
	Cookies []*ScreenshotCookieDto `json:"cookies,omitempty" url:"-"`
	// Extra settling time after the page is ready, in milliseconds
	Delay *float64 `json:"delay,omitempty" url:"-"`
	// Named viewport preset
	Device            *ScreenshotDtoDevice `json:"device,omitempty" url:"-"`
	DisableAnimations *bool                `json:"disableAnimations,omitempty" url:"-"`
	Format            *ScreenshotDtoFormat `json:"format,omitempty" url:"-"`
	// Capture the complete page instead of only the viewport
	FullPage *bool `json:"fullPage,omitempty" url:"-"`
	// auto uses native capture for normal pages and stitched slices for very tall pages
	FullPageAlgorithm *ScreenshotDtoFullPageAlgorithm `json:"fullPageAlgorithm,omitempty" url:"-"`
	// Headers sent while loading the page
	Headers map[string]any `json:"headers,omitempty" url:"-"`
	// Show fixed/sticky UI once instead of repeating it in stitched captures
	HideFixedElements *bool `json:"hideFixedElements,omitempty" url:"-"`
	// Hide matching elements before capture
	HideSelectors []string               `json:"hideSelectors,omitempty" url:"-"`
	Location      *ScreenshotLocationDto `json:"location,omitempty" url:"-"`
	MaskColor     *string                `json:"maskColor,omitempty" url:"-"`
	// Cover matching elements with a solid privacy mask
	MaskSelectors []string `json:"maskSelectors,omitempty" url:"-"`
	// Maximum full-page height. Prevents endless captures on infinite pages.
	MaxHeight *float64 `json:"maxHeight,omitempty" url:"-"`
	// Use a transparent background where the page allows it
	OmitBackground *bool `json:"omitBackground,omitempty" url:"-"`
	// Proxy mode
	Proxy *ScreenshotDtoProxy `json:"proxy,omitempty" url:"-"`
	// JPEG or WebP quality
	Quality       *float64 `json:"quality,omitempty" url:"-"`
	ReducedMotion *bool    `json:"reducedMotion,omitempty" url:"-"`
	// Hide common support and chat widgets
	RemoveChatWidgets *bool `json:"removeChatWidgets,omitempty" url:"-"`
	// Accept known consent dialogs, hide remaining cookie banners, and restore page scrolling
	RemoveCookieBanners *bool `json:"removeCookieBanners,omitempty" url:"-"`
	// Remove newsletter gates, modal backdrops, and blocking overlays
	RemoveOverlays *bool `json:"removeOverlays,omitempty" url:"-"`
	// Return a CDN URL or an inline data URL
	ResponseFormat *ScreenshotDtoResponseFormat `json:"responseFormat,omitempty" url:"-"`
	// Capture at CSS pixel size or the emulated device pixel ratio
	Scale *ScreenshotDtoScale `json:"scale,omitempty" url:"-"`
	// Pause between lazy-load scroll steps, in milliseconds
	ScrollDelay *float64 `json:"scrollDelay,omitempty" url:"-"`
	// Scroll through the page first so lazy content is loaded
	ScrollPage *bool `json:"scrollPage,omitempty" url:"-"`
	// Capture one element instead of the page
	Selector *string `json:"selector,omitempty" url:"-"`
	// CSS rules to apply before capture
	Styles  []string `json:"styles,omitempty" url:"-"`
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// Public webpage URL to capture
	URL string `json:"url" url:"-"`
	// Custom viewport. Overrides the named device dimensions.
	Viewport *ScreenshotViewportDto `json:"viewport,omitempty" url:"-"`
	// Wait for this CSS selector before capture
	WaitForSelector *string `json:"waitForSelector,omitempty" url:"-"`
	// Page readiness milestone used before capture
	WaitUntil *ScreenshotDtoWaitUntil `json:"waitUntil,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*ScreenshotDto) MarshalJSON 

func (s *ScreenshotDto) MarshalJSON() ([]byte, error)

func (*ScreenshotDto) SetBlockAds 

func (s *ScreenshotDto) SetBlockAds(blockAds *bool)

SetBlockAds sets the BlockAds field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetClickSelector 

func (s *ScreenshotDto) SetClickSelector(clickSelector *string)

SetClickSelector sets the ClickSelector field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetClip 

func (s *ScreenshotDto) SetClip(clip *ScreenshotClipDto)

SetClip sets the Clip field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetColorScheme 

func (s *ScreenshotDto) SetColorScheme(colorScheme *ScreenshotDtoColorScheme)

SetColorScheme sets the ColorScheme field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetCookies 

func (s *ScreenshotDto) SetCookies(cookies []*ScreenshotCookieDto)

SetCookies sets the Cookies field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetDelay 

func (s *ScreenshotDto) SetDelay(delay *float64)

SetDelay sets the Delay field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetDevice 

func (s *ScreenshotDto) SetDevice(device *ScreenshotDtoDevice)

SetDevice sets the Device field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetDisableAnimations 

func (s *ScreenshotDto) SetDisableAnimations(disableAnimations *bool)

SetDisableAnimations sets the DisableAnimations field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetFormat 

func (s *ScreenshotDto) SetFormat(format *ScreenshotDtoFormat)

SetFormat sets the Format field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetFullPage 

func (s *ScreenshotDto) SetFullPage(fullPage *bool)

SetFullPage sets the FullPage field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetFullPageAlgorithm 

func (s *ScreenshotDto) SetFullPageAlgorithm(fullPageAlgorithm *ScreenshotDtoFullPageAlgorithm)

SetFullPageAlgorithm sets the FullPageAlgorithm field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetHeaders 

func (s *ScreenshotDto) SetHeaders(headers map[string]any)

SetHeaders sets the Headers field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetHideFixedElements 

func (s *ScreenshotDto) SetHideFixedElements(hideFixedElements *bool)

SetHideFixedElements sets the HideFixedElements field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetHideSelectors 

func (s *ScreenshotDto) SetHideSelectors(hideSelectors []string)

SetHideSelectors sets the HideSelectors field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetLocation 

func (s *ScreenshotDto) SetLocation(location *ScreenshotLocationDto)

SetLocation sets the Location field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetMaskColor 

func (s *ScreenshotDto) SetMaskColor(maskColor *string)

SetMaskColor sets the MaskColor field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetMaskSelectors 

func (s *ScreenshotDto) SetMaskSelectors(maskSelectors []string)

SetMaskSelectors sets the MaskSelectors field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetMaxHeight 

func (s *ScreenshotDto) SetMaxHeight(maxHeight *float64)

SetMaxHeight sets the MaxHeight field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetOmitBackground 

func (s *ScreenshotDto) SetOmitBackground(omitBackground *bool)

SetOmitBackground sets the OmitBackground field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetProxy 

func (s *ScreenshotDto) SetProxy(proxy *ScreenshotDtoProxy)

SetProxy sets the Proxy field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetQuality 

func (s *ScreenshotDto) SetQuality(quality *float64)

SetQuality sets the Quality field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetReducedMotion 

func (s *ScreenshotDto) SetReducedMotion(reducedMotion *bool)

SetReducedMotion sets the ReducedMotion field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetRemoveChatWidgets 

func (s *ScreenshotDto) SetRemoveChatWidgets(removeChatWidgets *bool)

SetRemoveChatWidgets sets the RemoveChatWidgets field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetRemoveCookieBanners 

func (s *ScreenshotDto) SetRemoveCookieBanners(removeCookieBanners *bool)

SetRemoveCookieBanners sets the RemoveCookieBanners field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetRemoveOverlays 

func (s *ScreenshotDto) SetRemoveOverlays(removeOverlays *bool)

SetRemoveOverlays sets the RemoveOverlays field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetResponseFormat 

func (s *ScreenshotDto) SetResponseFormat(responseFormat *ScreenshotDtoResponseFormat)

SetResponseFormat sets the ResponseFormat field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetScale 

func (s *ScreenshotDto) SetScale(scale *ScreenshotDtoScale)

SetScale sets the Scale field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetScrollDelay 

func (s *ScreenshotDto) SetScrollDelay(scrollDelay *float64)

SetScrollDelay sets the ScrollDelay field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetScrollPage 

func (s *ScreenshotDto) SetScrollPage(scrollPage *bool)

SetScrollPage sets the ScrollPage field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetSelector 

func (s *ScreenshotDto) SetSelector(selector *string)

SetSelector sets the Selector field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetStyles 

func (s *ScreenshotDto) SetStyles(styles []string)

SetStyles sets the Styles field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetTimeout 

func (s *ScreenshotDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetURL 

func (s *ScreenshotDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetViewport 

func (s *ScreenshotDto) SetViewport(viewport *ScreenshotViewportDto)

SetViewport sets the Viewport field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetWaitForSelector 

func (s *ScreenshotDto) SetWaitForSelector(waitForSelector *string)

SetWaitForSelector sets the WaitForSelector field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) SetWaitUntil 

func (s *ScreenshotDto) SetWaitUntil(waitUntil *ScreenshotDtoWaitUntil)

SetWaitUntil sets the WaitUntil field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotDto) UnmarshalJSON 

func (s *ScreenshotDto) UnmarshalJSON(data []byte) error

type ScreenshotDtoColorScheme 

type ScreenshotDtoColorScheme string
const (
	ScreenshotDtoColorSchemeLight ScreenshotDtoColorScheme = "light"
	ScreenshotDtoColorSchemeDark  ScreenshotDtoColorScheme = "dark"
)

func NewScreenshotDtoColorSchemeFromString 

func NewScreenshotDtoColorSchemeFromString(s string) (ScreenshotDtoColorScheme, error)

func (ScreenshotDtoColorScheme) Ptr 

func (s ScreenshotDtoColorScheme) Ptr() *ScreenshotDtoColorScheme

type ScreenshotDtoDevice 

type ScreenshotDtoDevice string

Named viewport preset 

const (
	ScreenshotDtoDeviceDesktop   ScreenshotDtoDevice = "desktop"
	ScreenshotDtoDeviceDesktopHd ScreenshotDtoDevice = "desktop-hd"
	ScreenshotDtoDeviceTablet    ScreenshotDtoDevice = "tablet"
	ScreenshotDtoDeviceIphone15  ScreenshotDtoDevice = "iphone-15"
	ScreenshotDtoDevicePixel8    ScreenshotDtoDevice = "pixel-8"
)

func NewScreenshotDtoDeviceFromString 

func NewScreenshotDtoDeviceFromString(s string) (ScreenshotDtoDevice, error)

func (ScreenshotDtoDevice) Ptr 

func (s ScreenshotDtoDevice) Ptr() *ScreenshotDtoDevice

type ScreenshotDtoFormat 

type ScreenshotDtoFormat string
const (
	ScreenshotDtoFormatPng  ScreenshotDtoFormat = "png"
	ScreenshotDtoFormatJpeg ScreenshotDtoFormat = "jpeg"
	ScreenshotDtoFormatWebp ScreenshotDtoFormat = "webp"
)

func NewScreenshotDtoFormatFromString 

func NewScreenshotDtoFormatFromString(s string) (ScreenshotDtoFormat, error)

func (ScreenshotDtoFormat) Ptr 

func (s ScreenshotDtoFormat) Ptr() *ScreenshotDtoFormat

type ScreenshotDtoFullPageAlgorithm 

type ScreenshotDtoFullPageAlgorithm string

auto uses native capture for normal pages and stitched slices for very tall pages 

const (
	ScreenshotDtoFullPageAlgorithmAuto   ScreenshotDtoFullPageAlgorithm = "auto"
	ScreenshotDtoFullPageAlgorithmNative ScreenshotDtoFullPageAlgorithm = "native"
	ScreenshotDtoFullPageAlgorithmStitch ScreenshotDtoFullPageAlgorithm = "stitch"
)

func NewScreenshotDtoFullPageAlgorithmFromString 

func NewScreenshotDtoFullPageAlgorithmFromString(s string) (ScreenshotDtoFullPageAlgorithm, error)

func (ScreenshotDtoFullPageAlgorithm) Ptr 

func (s ScreenshotDtoFullPageAlgorithm) Ptr() *ScreenshotDtoFullPageAlgorithm

type ScreenshotDtoProxy 

type ScreenshotDtoProxy string

Proxy mode 

const (
	ScreenshotDtoProxyNone        ScreenshotDtoProxy = "none"
	ScreenshotDtoProxyBasic       ScreenshotDtoProxy = "basic"
	ScreenshotDtoProxyDatacenter  ScreenshotDtoProxy = "datacenter"
	ScreenshotDtoProxyResidential ScreenshotDtoProxy = "residential"
	ScreenshotDtoProxyStealth     ScreenshotDtoProxy = "stealth"
	ScreenshotDtoProxyAuto        ScreenshotDtoProxy = "auto"
)

func NewScreenshotDtoProxyFromString 

func NewScreenshotDtoProxyFromString(s string) (ScreenshotDtoProxy, error)

func (ScreenshotDtoProxy) Ptr 

func (s ScreenshotDtoProxy) Ptr() *ScreenshotDtoProxy

type ScreenshotDtoResponseFormat 

type ScreenshotDtoResponseFormat string

Return a CDN URL or an inline data URL 

const (
	ScreenshotDtoResponseFormatURL    ScreenshotDtoResponseFormat = "url"
	ScreenshotDtoResponseFormatBase64 ScreenshotDtoResponseFormat = "base64"
)

func NewScreenshotDtoResponseFormatFromString 

func NewScreenshotDtoResponseFormatFromString(s string) (ScreenshotDtoResponseFormat, error)

func (ScreenshotDtoResponseFormat) Ptr 

func (s ScreenshotDtoResponseFormat) Ptr() *ScreenshotDtoResponseFormat

type ScreenshotDtoScale 

type ScreenshotDtoScale string

Capture at CSS pixel size or the emulated device pixel ratio 

const (
	ScreenshotDtoScaleCSS    ScreenshotDtoScale = "css"
	ScreenshotDtoScaleDevice ScreenshotDtoScale = "device"
)

func NewScreenshotDtoScaleFromString 

func NewScreenshotDtoScaleFromString(s string) (ScreenshotDtoScale, error)

func (ScreenshotDtoScale) Ptr 

func (s ScreenshotDtoScale) Ptr() *ScreenshotDtoScale

type ScreenshotDtoWaitUntil 

type ScreenshotDtoWaitUntil string

Page readiness milestone used before capture 

const (
	ScreenshotDtoWaitUntilDomcontentloaded ScreenshotDtoWaitUntil = "domcontentloaded"
	ScreenshotDtoWaitUntilLoad             ScreenshotDtoWaitUntil = "load"
	ScreenshotDtoWaitUntilNetworkidle      ScreenshotDtoWaitUntil = "networkidle"
)

func NewScreenshotDtoWaitUntilFromString 

func NewScreenshotDtoWaitUntilFromString(s string) (ScreenshotDtoWaitUntil, error)

func (ScreenshotDtoWaitUntil) Ptr 

func (s ScreenshotDtoWaitUntil) Ptr() *ScreenshotDtoWaitUntil

type ScreenshotLocationDto 

type ScreenshotLocationDto struct {
	Country   *string  `json:"country,omitempty" url:"country,omitempty"`
	Languages []string `json:"languages,omitempty" url:"languages,omitempty"`
	// contains filtered or unexported fields
}

func (*ScreenshotLocationDto) GetCountry 

func (s *ScreenshotLocationDto) GetCountry() *string

func (*ScreenshotLocationDto) GetExtraProperties 

func (s *ScreenshotLocationDto) GetExtraProperties() map[string]interface{}

func (*ScreenshotLocationDto) GetLanguages 

func (s *ScreenshotLocationDto) GetLanguages() []string

func (*ScreenshotLocationDto) MarshalJSON 

func (s *ScreenshotLocationDto) MarshalJSON() ([]byte, error)

func (*ScreenshotLocationDto) SetCountry 

func (s *ScreenshotLocationDto) SetCountry(country *string)

SetCountry sets the Country field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotLocationDto) SetLanguages 

func (s *ScreenshotLocationDto) SetLanguages(languages []string)

SetLanguages sets the Languages field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotLocationDto) String 

func (s *ScreenshotLocationDto) String() string

func (*ScreenshotLocationDto) UnmarshalJSON 

func (s *ScreenshotLocationDto) UnmarshalJSON(data []byte) error

type ScreenshotViewportDto 

type ScreenshotViewportDto struct {
	Height float64 `json:"height" url:"height"`
	Width  float64 `json:"width" url:"width"`
	// contains filtered or unexported fields
}

func (*ScreenshotViewportDto) GetExtraProperties 

func (s *ScreenshotViewportDto) GetExtraProperties() map[string]interface{}

func (*ScreenshotViewportDto) GetHeight 

func (s *ScreenshotViewportDto) GetHeight() float64

func (*ScreenshotViewportDto) GetWidth 

func (s *ScreenshotViewportDto) GetWidth() float64

func (*ScreenshotViewportDto) MarshalJSON 

func (s *ScreenshotViewportDto) MarshalJSON() ([]byte, error)

func (*ScreenshotViewportDto) SetHeight 

func (s *ScreenshotViewportDto) SetHeight(height float64)

SetHeight sets the Height field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotViewportDto) SetWidth 

func (s *ScreenshotViewportDto) SetWidth(width float64)

SetWidth sets the Width field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*ScreenshotViewportDto) String 

func (s *ScreenshotViewportDto) String() string

func (*ScreenshotViewportDto) UnmarshalJSON 

func (s *ScreenshotViewportDto) UnmarshalJSON(data []byte) error

type SearchDto 

type SearchDto struct {
	// Category filters
	Categories []string `json:"categories,omitempty" url:"-"`
	// Country code
	Country *string `json:"country,omitempty" url:"-"`
	// Maximum number of results
	Limit *float64 `json:"limit,omitempty" url:"-"`
	// Location for geo-targeting
	Location *string `json:"location,omitempty" url:"-"`
	// Search query
	Query string `json:"query" url:"-"`
	// Source types to search
	Sources []string `json:"sources,omitempty" url:"-"`
	// Time-based filter (e.g., qdr:d for past day)
	Tbs *string `json:"tbs,omitempty" url:"-"`
	// Timeout for search operation in milliseconds
	Timeout *float64 `json:"timeout,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*SearchDto) MarshalJSON 

func (s *SearchDto) MarshalJSON() ([]byte, error)

func (*SearchDto) SetCategories 

func (s *SearchDto) SetCategories(categories []string)

SetCategories sets the Categories field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetCountry 

func (s *SearchDto) SetCountry(country *string)

SetCountry sets the Country field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetLimit 

func (s *SearchDto) SetLimit(limit *float64)

SetLimit sets the Limit field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetLocation 

func (s *SearchDto) SetLocation(location *string)

SetLocation sets the Location field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetQuery 

func (s *SearchDto) SetQuery(query string)

SetQuery sets the Query field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetSources 

func (s *SearchDto) SetSources(sources []string)

SetSources sets the Sources field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetTbs 

func (s *SearchDto) SetTbs(tbs *string)

SetTbs sets the Tbs field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) SetTimeout 

func (s *SearchDto) SetTimeout(timeout *float64)

SetTimeout sets the Timeout field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchDto) UnmarshalJSON 

func (s *SearchDto) UnmarshalJSON(data []byte) error

type SearchResponse 

type SearchResponse struct {
	CreditsUsed int             `json:"creditsUsed" url:"creditsUsed"`
	Data        []*SearchResult `json:"data" url:"data"`
	Query       string          `json:"query" url:"query"`
	Success     bool            `json:"success" url:"success"`
	Total       int             `json:"total" url:"total"`
	// contains filtered or unexported fields
}

func (*SearchResponse) GetCreditsUsed 

func (s *SearchResponse) GetCreditsUsed() int

func (*SearchResponse) GetData 

func (s *SearchResponse) GetData() []*SearchResult

func (*SearchResponse) GetExtraProperties 

func (s *SearchResponse) GetExtraProperties() map[string]interface{}

func (*SearchResponse) GetQuery 

func (s *SearchResponse) GetQuery() string

func (*SearchResponse) GetSuccess 

func (s *SearchResponse) GetSuccess() bool

func (*SearchResponse) GetTotal 

func (s *SearchResponse) GetTotal() int

func (*SearchResponse) MarshalJSON 

func (s *SearchResponse) MarshalJSON() ([]byte, error)

func (*SearchResponse) SetCreditsUsed 

func (s *SearchResponse) SetCreditsUsed(creditsUsed int)

SetCreditsUsed sets the CreditsUsed field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResponse) SetData 

func (s *SearchResponse) SetData(data []*SearchResult)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResponse) SetQuery 

func (s *SearchResponse) SetQuery(query string)

SetQuery sets the Query field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResponse) SetSuccess 

func (s *SearchResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResponse) SetTotal 

func (s *SearchResponse) SetTotal(total int)

SetTotal sets the Total field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResponse) String 

func (s *SearchResponse) String() string

func (*SearchResponse) UnmarshalJSON 

func (s *SearchResponse) UnmarshalJSON(data []byte) error

type SearchResult 

type SearchResult struct {
	PublishedDate *string `json:"publishedDate,omitempty" url:"publishedDate,omitempty"`
	Snippet       string  `json:"snippet" url:"snippet"`
	Source        string  `json:"source" url:"source"`
	Title         string  `json:"title" url:"title"`
	URL           string  `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*SearchResult) GetExtraProperties 

func (s *SearchResult) GetExtraProperties() map[string]interface{}

func (*SearchResult) GetPublishedDate 

func (s *SearchResult) GetPublishedDate() *string

func (*SearchResult) GetSnippet 

func (s *SearchResult) GetSnippet() string

func (*SearchResult) GetSource 

func (s *SearchResult) GetSource() string

func (*SearchResult) GetTitle 

func (s *SearchResult) GetTitle() string

func (*SearchResult) GetURL 

func (s *SearchResult) GetURL() string

func (*SearchResult) MarshalJSON 

func (s *SearchResult) MarshalJSON() ([]byte, error)

func (*SearchResult) SetPublishedDate 

func (s *SearchResult) SetPublishedDate(publishedDate *string)

SetPublishedDate sets the PublishedDate field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResult) SetSnippet 

func (s *SearchResult) SetSnippet(snippet string)

SetSnippet sets the Snippet field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResult) SetSource 

func (s *SearchResult) SetSource(source string)

SetSource sets the Source field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResult) SetTitle 

func (s *SearchResult) SetTitle(title string)

SetTitle sets the Title field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResult) SetURL 

func (s *SearchResult) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SearchResult) String 

func (s *SearchResult) String() string

func (*SearchResult) UnmarshalJSON 

func (s *SearchResult) UnmarshalJSON(data []byte) error

type SummaryFormatDto 

type SummaryFormatDto struct {
	// Specific query for focused summarization
	Query *string `json:"query,omitempty" url:"query,omitempty"`
	// Format type
	Type SummaryFormatDtoType `json:"type" url:"type"`
	// contains filtered or unexported fields
}

func (*SummaryFormatDto) GetExtraProperties 

func (s *SummaryFormatDto) GetExtraProperties() map[string]interface{}

func (*SummaryFormatDto) GetQuery 

func (s *SummaryFormatDto) GetQuery() *string

func (*SummaryFormatDto) GetType 

func (s *SummaryFormatDto) GetType() SummaryFormatDtoType

func (*SummaryFormatDto) MarshalJSON 

func (s *SummaryFormatDto) MarshalJSON() ([]byte, error)

func (*SummaryFormatDto) SetQuery 

func (s *SummaryFormatDto) SetQuery(query *string)

SetQuery sets the Query field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SummaryFormatDto) SetType 

func (s *SummaryFormatDto) SetType(type_ SummaryFormatDtoType)

SetType sets the Type field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*SummaryFormatDto) String 

func (s *SummaryFormatDto) String() string

func (*SummaryFormatDto) UnmarshalJSON 

func (s *SummaryFormatDto) UnmarshalJSON(data []byte) error

type SummaryFormatDtoType 

type SummaryFormatDtoType string

Format type 

const (
	SummaryFormatDtoTypeSummary SummaryFormatDtoType = "summary"
)

func NewSummaryFormatDtoTypeFromString 

func NewSummaryFormatDtoTypeFromString(s string) (SummaryFormatDtoType, error)

func (SummaryFormatDtoType) Ptr 

func (s SummaryFormatDtoType) Ptr() *SummaryFormatDtoType

type TestWebhookDto 

type TestWebhookDto struct {
	ID string `json:"-" url:"-"`
	// Event type to test
	Event string `json:"event" url:"-"`
	// Optional custom payload for testing
	Payload map[string]any `json:"payload,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*TestWebhookDto) MarshalJSON 

func (t *TestWebhookDto) MarshalJSON() ([]byte, error)

func (*TestWebhookDto) SetEvent 

func (t *TestWebhookDto) SetEvent(event string)

SetEvent sets the Event field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookDto) SetID 

func (t *TestWebhookDto) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookDto) SetPayload 

func (t *TestWebhookDto) SetPayload(payload map[string]any)

SetPayload sets the Payload field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookDto) UnmarshalJSON 

func (t *TestWebhookDto) UnmarshalJSON(data []byte) error

type TestWebhookResponse 

type TestWebhookResponse struct {
	Event   string         `json:"event" url:"event"`
	Message string         `json:"message" url:"message"`
	Payload map[string]any `json:"payload" url:"payload"`
	Success bool           `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*TestWebhookResponse) GetEvent 

func (t *TestWebhookResponse) GetEvent() string

func (*TestWebhookResponse) GetExtraProperties 

func (t *TestWebhookResponse) GetExtraProperties() map[string]interface{}

func (*TestWebhookResponse) GetMessage 

func (t *TestWebhookResponse) GetMessage() string

func (*TestWebhookResponse) GetPayload 

func (t *TestWebhookResponse) GetPayload() map[string]any

func (*TestWebhookResponse) GetSuccess 

func (t *TestWebhookResponse) GetSuccess() bool

func (*TestWebhookResponse) MarshalJSON 

func (t *TestWebhookResponse) MarshalJSON() ([]byte, error)

func (*TestWebhookResponse) SetEvent 

func (t *TestWebhookResponse) SetEvent(event string)

SetEvent sets the Event field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookResponse) SetMessage 

func (t *TestWebhookResponse) SetMessage(message string)

SetMessage sets the Message field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookResponse) SetPayload 

func (t *TestWebhookResponse) SetPayload(payload map[string]any)

SetPayload sets the Payload field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookResponse) SetSuccess 

func (t *TestWebhookResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*TestWebhookResponse) String 

func (t *TestWebhookResponse) String() string

func (*TestWebhookResponse) UnmarshalJSON 

func (t *TestWebhookResponse) UnmarshalJSON(data []byte) error

type TooManyRequestsError 

type TooManyRequestsError struct {
	*core.APIError
	Body any
}

Rate or concurrency limit exceeded

func (*TooManyRequestsError) MarshalJSON 

func (t *TooManyRequestsError) MarshalJSON() ([]byte, error)

func (*TooManyRequestsError) UnmarshalJSON 

func (t *TooManyRequestsError) UnmarshalJSON(data []byte) error

func (*TooManyRequestsError) Unwrap 

func (t *TooManyRequestsError) Unwrap() error

type UnauthorizedError 

type UnauthorizedError struct {
	*core.APIError
	Body any
}

Invalid API key

func (*UnauthorizedError) MarshalJSON 

func (u *UnauthorizedError) MarshalJSON() ([]byte, error)

func (*UnauthorizedError) UnmarshalJSON 

func (u *UnauthorizedError) UnmarshalJSON(data []byte) error

func (*UnauthorizedError) Unwrap 

func (u *UnauthorizedError) Unwrap() error

type UpdateWebhookDto 

type UpdateWebhookDto struct {
	ID string `json:"-" url:"-"`
	// Event types to subscribe to
	Events []string `json:"events,omitempty" url:"-"`
	// Enable or disable webhook
	IsActive *bool `json:"isActive,omitempty" url:"-"`
	// Webhook URL to send events to
	URL *string `json:"url,omitempty" url:"-"`
	// contains filtered or unexported fields
}

func (*UpdateWebhookDto) MarshalJSON 

func (u *UpdateWebhookDto) MarshalJSON() ([]byte, error)

func (*UpdateWebhookDto) SetEvents 

func (u *UpdateWebhookDto) SetEvents(events []string)

SetEvents sets the Events field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateWebhookDto) SetID 

func (u *UpdateWebhookDto) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateWebhookDto) SetIsActive 

func (u *UpdateWebhookDto) SetIsActive(isActive *bool)

SetIsActive sets the IsActive field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateWebhookDto) SetURL 

func (u *UpdateWebhookDto) SetURL(url *string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*UpdateWebhookDto) UnmarshalJSON 

func (u *UpdateWebhookDto) UnmarshalJSON(data []byte) error

type Webhook 

type Webhook struct {
	CreatedAt        *time.Time       `json:"createdAt,omitempty" url:"createdAt,omitempty"`
	Events           []string         `json:"events" url:"events"`
	ID               string           `json:"id" url:"id"`
	IsActive         bool             `json:"isActive" url:"isActive"`
	RecentDeliveries []map[string]any `json:"recentDeliveries,omitempty" url:"recentDeliveries,omitempty"`
	Secret           *string          `json:"secret,omitempty" url:"secret,omitempty"`
	UpdatedAt        *time.Time       `json:"updatedAt,omitempty" url:"updatedAt,omitempty"`
	URL              string           `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*Webhook) GetCreatedAt 

func (w *Webhook) GetCreatedAt() *time.Time

func (*Webhook) GetEvents 

func (w *Webhook) GetEvents() []string

func (*Webhook) GetExtraProperties 

func (w *Webhook) GetExtraProperties() map[string]interface{}

func (*Webhook) GetID 

func (w *Webhook) GetID() string

func (*Webhook) GetIsActive 

func (w *Webhook) GetIsActive() bool

func (*Webhook) GetRecentDeliveries 

func (w *Webhook) GetRecentDeliveries() []map[string]any

func (*Webhook) GetSecret 

func (w *Webhook) GetSecret() *string

func (*Webhook) GetURL 

func (w *Webhook) GetURL() string

func (*Webhook) GetUpdatedAt 

func (w *Webhook) GetUpdatedAt() *time.Time

func (*Webhook) MarshalJSON 

func (w *Webhook) MarshalJSON() ([]byte, error)

func (*Webhook) SetCreatedAt 

func (w *Webhook) SetCreatedAt(createdAt *time.Time)

SetCreatedAt sets the CreatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetEvents 

func (w *Webhook) SetEvents(events []string)

SetEvents sets the Events field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetID 

func (w *Webhook) SetID(id string)

SetID sets the ID field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetIsActive 

func (w *Webhook) SetIsActive(isActive bool)

SetIsActive sets the IsActive field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetRecentDeliveries 

func (w *Webhook) SetRecentDeliveries(recentDeliveries []map[string]any)

SetRecentDeliveries sets the RecentDeliveries field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetSecret 

func (w *Webhook) SetSecret(secret *string)

SetSecret sets the Secret field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetURL 

func (w *Webhook) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) SetUpdatedAt 

func (w *Webhook) SetUpdatedAt(updatedAt *time.Time)

SetUpdatedAt sets the UpdatedAt field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*Webhook) String 

func (w *Webhook) String() string

func (*Webhook) UnmarshalJSON 

func (w *Webhook) UnmarshalJSON(data []byte) error

type WebhookConfigDto 

type WebhookConfigDto struct {
	// Events to subscribe to
	Events []string `json:"events" url:"events"`
	// Additional metadata
	Metadata map[string]any `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Optional secret used to sign direct webhook deliveries
	Secret *string `json:"secret,omitempty" url:"secret,omitempty"`
	// Webhook URL
	URL string `json:"url" url:"url"`
	// contains filtered or unexported fields
}

func (*WebhookConfigDto) GetEvents 

func (w *WebhookConfigDto) GetEvents() []string

func (*WebhookConfigDto) GetExtraProperties 

func (w *WebhookConfigDto) GetExtraProperties() map[string]interface{}

func (*WebhookConfigDto) GetMetadata 

func (w *WebhookConfigDto) GetMetadata() map[string]any

func (*WebhookConfigDto) GetSecret 

func (w *WebhookConfigDto) GetSecret() *string

func (*WebhookConfigDto) GetURL 

func (w *WebhookConfigDto) GetURL() string

func (*WebhookConfigDto) MarshalJSON 

func (w *WebhookConfigDto) MarshalJSON() ([]byte, error)

func (*WebhookConfigDto) SetEvents 

func (w *WebhookConfigDto) SetEvents(events []string)

SetEvents sets the Events field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookConfigDto) SetMetadata 

func (w *WebhookConfigDto) SetMetadata(metadata map[string]any)

SetMetadata sets the Metadata field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookConfigDto) SetSecret 

func (w *WebhookConfigDto) SetSecret(secret *string)

SetSecret sets the Secret field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookConfigDto) SetURL 

func (w *WebhookConfigDto) SetURL(url string)

SetURL sets the URL field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookConfigDto) String 

func (w *WebhookConfigDto) String() string

func (*WebhookConfigDto) UnmarshalJSON 

func (w *WebhookConfigDto) UnmarshalJSON(data []byte) error

type WebhookResponse 

type WebhookResponse struct {
	Data    *Webhook `json:"data" url:"data"`
	Success bool     `json:"success" url:"success"`
	// contains filtered or unexported fields
}

func (*WebhookResponse) GetData 

func (w *WebhookResponse) GetData() *Webhook

func (*WebhookResponse) GetExtraProperties 

func (w *WebhookResponse) GetExtraProperties() map[string]interface{}

func (*WebhookResponse) GetSuccess 

func (w *WebhookResponse) GetSuccess() bool

func (*WebhookResponse) MarshalJSON 

func (w *WebhookResponse) MarshalJSON() ([]byte, error)

func (*WebhookResponse) SetData 

func (w *WebhookResponse) SetData(data *Webhook)

SetData sets the Data field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookResponse) SetSuccess 

func (w *WebhookResponse) SetSuccess(success bool)

SetSuccess sets the Success field and marks it as non-optional; this prevents an empty or null value for this field from being omitted during serialization.

func (*WebhookResponse) String 

func (w *WebhookResponse) String() string

func (*WebhookResponse) UnmarshalJSON 

func (w *WebhookResponse) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis
Credits, plan, and limits
 Credits, plan, and limits
Get the complete public brand for a website
 Get the complete public brand for a website
Follow and cancel background work
 Follow and cancel background work
Manage webhook destinations
 Manage webhook destinations

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.