domainradar

package
v0.21.4 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelBulkCheckRequest added in v0.20.0

func NewCancelBulkCheckRequest(server string, id string) (*http.Request, error)

NewCancelBulkCheckRequest generates requests for CancelBulkCheck

func NewCheckDomainRequest

func NewCheckDomainRequest(server string, body CheckDomainJSONRequestBody) (*http.Request, error)

NewCheckDomainRequest calls the generic CheckDomain builder with application/json body

func NewCheckDomainRequestWithBody

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

NewCheckDomainRequestWithBody generates requests for CheckDomain with any type of body

func NewCheckNameJobNamesRequest added in v0.20.0

func NewCheckNameJobNamesRequest(server string, jobId string, body CheckNameJobNamesJSONRequestBody) (*http.Request, error)

NewCheckNameJobNamesRequest calls the generic CheckNameJobNames builder with application/json body

func NewCheckNameJobNamesRequestWithBody added in v0.20.0

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

NewCheckNameJobNamesRequestWithBody generates requests for CheckNameJobNames with any type of body

func NewCountBrandWatcherHitsRequest added in v0.20.0

func NewCountBrandWatcherHitsRequest(server string, id string) (*http.Request, error)

NewCountBrandWatcherHitsRequest generates requests for CountBrandWatcherHits

func NewCreateBrandWatcherRequest added in v0.20.0

func NewCreateBrandWatcherRequest(server string, body CreateBrandWatcherJSONRequestBody) (*http.Request, error)

NewCreateBrandWatcherRequest calls the generic CreateBrandWatcher builder with application/json body

func NewCreateBrandWatcherRequestWithBody added in v0.20.0

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

NewCreateBrandWatcherRequestWithBody generates requests for CreateBrandWatcher with any type of body

func NewCreateBulkCheckRequest added in v0.20.0

func NewCreateBulkCheckRequest(server string, body CreateBulkCheckJSONRequestBody) (*http.Request, error)

NewCreateBulkCheckRequest calls the generic CreateBulkCheck builder with application/json body

func NewCreateBulkCheckRequestWithBody added in v0.20.0

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

NewCreateBulkCheckRequestWithBody generates requests for CreateBulkCheck with any type of body

func NewCreateNameJobRequest added in v0.20.0

func NewCreateNameJobRequest(server string, body CreateNameJobJSONRequestBody) (*http.Request, error)

NewCreateNameJobRequest calls the generic CreateNameJob builder with application/json body

func NewCreateNameJobRequestWithBody added in v0.20.0

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

NewCreateNameJobRequestWithBody generates requests for CreateNameJob with any type of body

func NewDeleteBrandWatcherRequest added in v0.20.0

func NewDeleteBrandWatcherRequest(server string, id string) (*http.Request, error)

NewDeleteBrandWatcherRequest generates requests for DeleteBrandWatcher

func NewDeleteBulkCheckRequest added in v0.20.0

func NewDeleteBulkCheckRequest(server string, id string) (*http.Request, error)

NewDeleteBulkCheckRequest generates requests for DeleteBulkCheck

func NewDeleteNameJobRequest added in v0.20.0

func NewDeleteNameJobRequest(server string, jobId string) (*http.Request, error)

NewDeleteNameJobRequest generates requests for DeleteNameJob

func NewExportBulkCheckResultsRequest added in v0.20.0

func NewExportBulkCheckResultsRequest(server string, id string, params *ExportBulkCheckResultsParams) (*http.Request, error)

NewExportBulkCheckResultsRequest generates requests for ExportBulkCheckResults

func NewGetBrandHitRequest added in v0.20.0

func NewGetBrandHitRequest(server string, id string) (*http.Request, error)

NewGetBrandHitRequest generates requests for GetBrandHit

func NewGetBrandWatcherRequest added in v0.20.0

func NewGetBrandWatcherRequest(server string, id string) (*http.Request, error)

NewGetBrandWatcherRequest generates requests for GetBrandWatcher

func NewGetBulkCheckRequest added in v0.20.0

func NewGetBulkCheckRequest(server string, id string) (*http.Request, error)

NewGetBulkCheckRequest generates requests for GetBulkCheck

func NewGetNameJobRequest added in v0.20.0

func NewGetNameJobRequest(server string, jobId string) (*http.Request, error)

NewGetNameJobRequest generates requests for GetNameJob

func NewListBrandHitsRequest added in v0.20.0

func NewListBrandHitsRequest(server string, params *ListBrandHitsParams) (*http.Request, error)

NewListBrandHitsRequest generates requests for ListBrandHits

func NewListBrandWatcherHitsRequest added in v0.20.0

func NewListBrandWatcherHitsRequest(server string, id string, params *ListBrandWatcherHitsParams) (*http.Request, error)

NewListBrandWatcherHitsRequest generates requests for ListBrandWatcherHits

func NewListBrandWatchersRequest added in v0.20.0

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

NewListBrandWatchersRequest generates requests for ListBrandWatchers

func NewListBulkCheckResultsRequest added in v0.20.0

func NewListBulkCheckResultsRequest(server string, id string, params *ListBulkCheckResultsParams) (*http.Request, error)

NewListBulkCheckResultsRequest generates requests for ListBulkCheckResults

func NewListBulkChecksRequest added in v0.20.0

func NewListBulkChecksRequest(server string, params *ListBulkChecksParams) (*http.Request, error)

NewListBulkChecksRequest generates requests for ListBulkChecks

func NewListNameJobNamesRequest added in v0.20.0

func NewListNameJobNamesRequest(server string, jobId string, params *ListNameJobNamesParams) (*http.Request, error)

NewListNameJobNamesRequest generates requests for ListNameJobNames

func NewListNameJobsRequest added in v0.20.0

func NewListNameJobsRequest(server string, params *ListNameJobsParams) (*http.Request, error)

NewListNameJobsRequest generates requests for ListNameJobs

func NewListSavedDomainsRequest added in v0.20.0

func NewListSavedDomainsRequest(server string, params *ListSavedDomainsParams) (*http.Request, error)

NewListSavedDomainsRequest generates requests for ListSavedDomains

func NewRemoveSavedDomainRequest added in v0.20.0

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

NewRemoveSavedDomainRequest generates requests for RemoveSavedDomain

func NewSaveDomainRequest added in v0.20.0

func NewSaveDomainRequest(server string, body SaveDomainJSONRequestBody) (*http.Request, error)

NewSaveDomainRequest calls the generic SaveDomain builder with application/json body

func NewSaveDomainRequestWithBody added in v0.20.0

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

NewSaveDomainRequestWithBody generates requests for SaveDomain with any type of body

func NewStreamBulkCheckRequest added in v0.20.0

func NewStreamBulkCheckRequest(server string, id string) (*http.Request, error)

NewStreamBulkCheckRequest generates requests for StreamBulkCheck

func NewUpdateBrandWatcherRequest added in v0.20.0

func NewUpdateBrandWatcherRequest(server string, id string, body UpdateBrandWatcherJSONRequestBody) (*http.Request, error)

NewUpdateBrandWatcherRequest calls the generic UpdateBrandWatcher builder with application/json body

func NewUpdateBrandWatcherRequestWithBody added in v0.20.0

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

NewUpdateBrandWatcherRequestWithBody generates requests for UpdateBrandWatcher with any type of body

Types

type BrandmonitorhandlerCreateWatcherRequest

type BrandmonitorhandlerCreateWatcherRequest struct {
	AiContentCheck       *bool     `json:"aiContentCheck,omitempty"`
	Allowlist            *[]string `json:"allowlist,omitempty"`
	MinNotificationScore *int      `json:"minNotificationScore,omitempty"`
	NotificationEmail    *string   `json:"notificationEmail,omitempty"`
	Word                 *string   `json:"word,omitempty"`
}

BrandmonitorhandlerCreateWatcherRequest defines model for brandmonitorhandler.createWatcherRequest.

type BrandmonitorhandlerListHitsResponse

type BrandmonitorhandlerListHitsResponse struct {
	List  *[]DtoMonitorHit `json:"list,omitempty"`
	Next  *string          `json:"next,omitempty"`
	Prev  *string          `json:"prev,omitempty"`
	Total *int             `json:"total,omitempty"`
}

BrandmonitorhandlerListHitsResponse defines model for brandmonitorhandler.listHitsResponse.

type BrandmonitorhandlerUpdateWatcherRequest

type BrandmonitorhandlerUpdateWatcherRequest struct {
	AiContentCheck       *bool     `json:"aiContentCheck,omitempty"`
	Allowlist            *[]string `json:"allowlist,omitempty"`
	Enabled              *bool     `json:"enabled,omitempty"`
	MinNotificationScore *int      `json:"minNotificationScore,omitempty"`
	NotificationEmail    *string   `json:"notificationEmail,omitempty"`
	Word                 *string   `json:"word,omitempty"`
}

BrandmonitorhandlerUpdateWatcherRequest defines model for brandmonitorhandler.updateWatcherRequest.

type BrandmonitorhandlerWatcherHitCountResponse added in v0.20.0

type BrandmonitorhandlerWatcherHitCountResponse struct {
	Count int `json:"count"`
}

BrandmonitorhandlerWatcherHitCountResponse defines model for brandmonitorhandler.watcherHitCountResponse.

type CancelBulkCheckResponse added in v0.20.0

type CancelBulkCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoBulkCheckJob
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCancelBulkCheckResponse added in v0.20.0

func ParseCancelBulkCheckResponse(rsp *http.Response) (*CancelBulkCheckResponse, error)

ParseCancelBulkCheckResponse parses an HTTP response from a CancelBulkCheckWithResponse call

func (CancelBulkCheckResponse) ContentType added in v0.20.0

func (r CancelBulkCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CancelBulkCheckResponse) Status added in v0.20.0

func (r CancelBulkCheckResponse) Status() string

Status returns HTTPResponse.Status

func (CancelBulkCheckResponse) StatusCode added in v0.20.0

func (r CancelBulkCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CheckDomainJSONRequestBody

type CheckDomainJSONRequestBody = CheckhandlerCheckRequest

CheckDomainJSONRequestBody defines body for CheckDomain for application/json ContentType.

type CheckDomainResponse

type CheckDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoDomainCheck
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCheckDomainResponse

func ParseCheckDomainResponse(rsp *http.Response) (*CheckDomainResponse, error)

ParseCheckDomainResponse parses an HTTP response from a CheckDomainWithResponse call

func (CheckDomainResponse) ContentType

func (r CheckDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CheckDomainResponse) Status

func (r CheckDomainResponse) Status() string

Status returns HTTPResponse.Status

func (CheckDomainResponse) StatusCode

func (r CheckDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CheckNameJobNamesJSONRequestBody added in v0.20.0

type CheckNameJobNamesJSONRequestBody = NamegenhandlerCheckNamesRequest

CheckNameJobNamesJSONRequestBody defines body for CheckNameJobNames for application/json ContentType.

type CheckNameJobNamesResponse added in v0.20.0

type CheckNameJobNamesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *DtoBulkCheckJob
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCheckNameJobNamesResponse added in v0.20.0

func ParseCheckNameJobNamesResponse(rsp *http.Response) (*CheckNameJobNamesResponse, error)

ParseCheckNameJobNamesResponse parses an HTTP response from a CheckNameJobNamesWithResponse call

func (CheckNameJobNamesResponse) ContentType added in v0.20.0

func (r CheckNameJobNamesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CheckNameJobNamesResponse) Status added in v0.20.0

func (r CheckNameJobNamesResponse) Status() string

Status returns HTTPResponse.Status

func (CheckNameJobNamesResponse) StatusCode added in v0.20.0

func (r CheckNameJobNamesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CheckhandlerBulkCheckRequest

type CheckhandlerBulkCheckRequest struct {
	Domains *[]string           `json:"domains,omitempty"`
	MaxAge  *string             `json:"maxAge,omitempty"`
	Mode    *ConstantsCheckMode `json:"mode,omitempty"`
}

CheckhandlerBulkCheckRequest defines model for checkhandler.bulkCheckRequest.

type CheckhandlerCheckRequest

type CheckhandlerCheckRequest struct {
	Domain *string             `json:"domain,omitempty"`
	MaxAge *string             `json:"maxAge,omitempty"`
	Mode   *ConstantsCheckMode `json:"mode,omitempty"`
}

CheckhandlerCheckRequest defines model for checkhandler.checkRequest.

type Client

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

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

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

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

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

Creates a new Client, with reasonable defaults

func (*Client) CancelBulkCheck added in v0.20.0

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

func (*Client) CheckDomain

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

func (*Client) CheckDomainWithBody

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

func (*Client) CheckNameJobNames added in v0.20.0

func (c *Client) CheckNameJobNames(ctx context.Context, jobId string, body CheckNameJobNamesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CheckNameJobNamesWithBody added in v0.20.0

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

func (*Client) CountBrandWatcherHits added in v0.20.0

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

func (*Client) CreateBrandWatcher added in v0.20.0

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

func (*Client) CreateBrandWatcherWithBody added in v0.20.0

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

func (*Client) CreateBulkCheck added in v0.20.0

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

func (*Client) CreateBulkCheckWithBody added in v0.20.0

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

func (*Client) CreateNameJob added in v0.20.0

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

func (*Client) CreateNameJobWithBody added in v0.20.0

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

func (*Client) DeleteBrandWatcher added in v0.20.0

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

func (*Client) DeleteBulkCheck added in v0.20.0

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

func (*Client) DeleteNameJob added in v0.20.0

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

func (*Client) ExportBulkCheckResults added in v0.20.0

func (c *Client) ExportBulkCheckResults(ctx context.Context, id string, params *ExportBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBrandHit added in v0.20.0

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

func (*Client) GetBrandWatcher added in v0.20.0

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

func (*Client) GetBulkCheck added in v0.20.0

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

func (*Client) GetNameJob added in v0.20.0

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

func (*Client) ListBrandHits added in v0.20.0

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

func (*Client) ListBrandWatcherHits added in v0.20.0

func (c *Client) ListBrandWatcherHits(ctx context.Context, id string, params *ListBrandWatcherHitsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBrandWatchers added in v0.20.0

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

func (*Client) ListBulkCheckResults added in v0.20.0

func (c *Client) ListBulkCheckResults(ctx context.Context, id string, params *ListBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBulkChecks added in v0.20.0

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

func (*Client) ListNameJobNames added in v0.20.0

func (c *Client) ListNameJobNames(ctx context.Context, jobId string, params *ListNameJobNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListNameJobs added in v0.20.0

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

func (*Client) ListSavedDomains added in v0.20.0

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

func (*Client) RemoveSavedDomain added in v0.20.0

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

func (*Client) SaveDomain added in v0.20.0

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

func (*Client) SaveDomainWithBody added in v0.20.0

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

func (*Client) StreamBulkCheck added in v0.20.0

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

func (*Client) UpdateBrandWatcher added in v0.20.0

func (c *Client) UpdateBrandWatcher(ctx context.Context, id string, body UpdateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateBrandWatcherWithBody added in v0.20.0

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

type ClientInterface

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

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

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

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

	CreateBrandWatcher(ctx context.Context, body CreateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	UpdateBrandWatcher(ctx context.Context, id string, body UpdateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListBrandWatcherHits request
	ListBrandWatcherHits(ctx context.Context, id string, params *ListBrandWatcherHitsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CheckDomain(ctx context.Context, body CheckDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateBulkCheck(ctx context.Context, body CreateBulkCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	// ExportBulkCheckResults request
	ExportBulkCheckResults(ctx context.Context, id string, params *ExportBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListBulkCheckResults request
	ListBulkCheckResults(ctx context.Context, id string, params *ListBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	SaveDomain(ctx context.Context, body SaveDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	CreateNameJob(ctx context.Context, body CreateNameJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	CheckNameJobNames(ctx context.Context, jobId string, body CheckNameJobNamesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListNameJobNames request
	ListNameJobNames(ctx context.Context, jobId string, params *ListNameJobNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

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

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

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

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

func (*ClientWithResponses) CancelBulkCheckWithResponse added in v0.20.0

func (c *ClientWithResponses) CancelBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*CancelBulkCheckResponse, error)

CancelBulkCheckWithResponse request returning *CancelBulkCheckResponse

func (*ClientWithResponses) CheckDomainWithBodyWithResponse

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

CheckDomainWithBodyWithResponse request with arbitrary body returning *CheckDomainResponse

func (*ClientWithResponses) CheckDomainWithResponse

func (c *ClientWithResponses) CheckDomainWithResponse(ctx context.Context, body CheckDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckDomainResponse, error)

func (*ClientWithResponses) CheckNameJobNamesWithBodyWithResponse added in v0.20.0

func (c *ClientWithResponses) CheckNameJobNamesWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckNameJobNamesResponse, error)

CheckNameJobNamesWithBodyWithResponse request with arbitrary body returning *CheckNameJobNamesResponse

func (*ClientWithResponses) CheckNameJobNamesWithResponse added in v0.20.0

func (c *ClientWithResponses) CheckNameJobNamesWithResponse(ctx context.Context, jobId string, body CheckNameJobNamesJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckNameJobNamesResponse, error)

func (*ClientWithResponses) CountBrandWatcherHitsWithResponse added in v0.20.0

func (c *ClientWithResponses) CountBrandWatcherHitsWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*CountBrandWatcherHitsResponse, error)

CountBrandWatcherHitsWithResponse request returning *CountBrandWatcherHitsResponse

func (*ClientWithResponses) CreateBrandWatcherWithBodyWithResponse added in v0.20.0

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

CreateBrandWatcherWithBodyWithResponse request with arbitrary body returning *CreateBrandWatcherResponse

func (*ClientWithResponses) CreateBrandWatcherWithResponse added in v0.20.0

func (c *ClientWithResponses) CreateBrandWatcherWithResponse(ctx context.Context, body CreateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBrandWatcherResponse, error)

func (*ClientWithResponses) CreateBulkCheckWithBodyWithResponse added in v0.20.0

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

CreateBulkCheckWithBodyWithResponse request with arbitrary body returning *CreateBulkCheckResponse

func (*ClientWithResponses) CreateBulkCheckWithResponse added in v0.20.0

func (c *ClientWithResponses) CreateBulkCheckWithResponse(ctx context.Context, body CreateBulkCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBulkCheckResponse, error)

func (*ClientWithResponses) CreateNameJobWithBodyWithResponse added in v0.20.0

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

CreateNameJobWithBodyWithResponse request with arbitrary body returning *CreateNameJobResponse

func (*ClientWithResponses) CreateNameJobWithResponse added in v0.20.0

func (c *ClientWithResponses) CreateNameJobWithResponse(ctx context.Context, body CreateNameJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNameJobResponse, error)

func (*ClientWithResponses) DeleteBrandWatcherWithResponse added in v0.20.0

func (c *ClientWithResponses) DeleteBrandWatcherWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteBrandWatcherResponse, error)

DeleteBrandWatcherWithResponse request returning *DeleteBrandWatcherResponse

func (*ClientWithResponses) DeleteBulkCheckWithResponse added in v0.20.0

func (c *ClientWithResponses) DeleteBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteBulkCheckResponse, error)

DeleteBulkCheckWithResponse request returning *DeleteBulkCheckResponse

func (*ClientWithResponses) DeleteNameJobWithResponse added in v0.20.0

func (c *ClientWithResponses) DeleteNameJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteNameJobResponse, error)

DeleteNameJobWithResponse request returning *DeleteNameJobResponse

func (*ClientWithResponses) ExportBulkCheckResultsWithResponse added in v0.20.0

func (c *ClientWithResponses) ExportBulkCheckResultsWithResponse(ctx context.Context, id string, params *ExportBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*ExportBulkCheckResultsResponse, error)

ExportBulkCheckResultsWithResponse request returning *ExportBulkCheckResultsResponse

func (*ClientWithResponses) GetBrandHitWithResponse added in v0.20.0

func (c *ClientWithResponses) GetBrandHitWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBrandHitResponse, error)

GetBrandHitWithResponse request returning *GetBrandHitResponse

func (*ClientWithResponses) GetBrandWatcherWithResponse added in v0.20.0

func (c *ClientWithResponses) GetBrandWatcherWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBrandWatcherResponse, error)

GetBrandWatcherWithResponse request returning *GetBrandWatcherResponse

func (*ClientWithResponses) GetBulkCheckWithResponse added in v0.20.0

func (c *ClientWithResponses) GetBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBulkCheckResponse, error)

GetBulkCheckWithResponse request returning *GetBulkCheckResponse

func (*ClientWithResponses) GetNameJobWithResponse added in v0.20.0

func (c *ClientWithResponses) GetNameJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetNameJobResponse, error)

GetNameJobWithResponse request returning *GetNameJobResponse

func (*ClientWithResponses) ListBrandHitsWithResponse added in v0.20.0

func (c *ClientWithResponses) ListBrandHitsWithResponse(ctx context.Context, params *ListBrandHitsParams, reqEditors ...RequestEditorFn) (*ListBrandHitsResponse, error)

ListBrandHitsWithResponse request returning *ListBrandHitsResponse

func (*ClientWithResponses) ListBrandWatcherHitsWithResponse added in v0.20.0

func (c *ClientWithResponses) ListBrandWatcherHitsWithResponse(ctx context.Context, id string, params *ListBrandWatcherHitsParams, reqEditors ...RequestEditorFn) (*ListBrandWatcherHitsResponse, error)

ListBrandWatcherHitsWithResponse request returning *ListBrandWatcherHitsResponse

func (*ClientWithResponses) ListBrandWatchersWithResponse added in v0.20.0

func (c *ClientWithResponses) ListBrandWatchersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListBrandWatchersResponse, error)

ListBrandWatchersWithResponse request returning *ListBrandWatchersResponse

func (*ClientWithResponses) ListBulkCheckResultsWithResponse added in v0.20.0

func (c *ClientWithResponses) ListBulkCheckResultsWithResponse(ctx context.Context, id string, params *ListBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*ListBulkCheckResultsResponse, error)

ListBulkCheckResultsWithResponse request returning *ListBulkCheckResultsResponse

func (*ClientWithResponses) ListBulkChecksWithResponse added in v0.20.0

func (c *ClientWithResponses) ListBulkChecksWithResponse(ctx context.Context, params *ListBulkChecksParams, reqEditors ...RequestEditorFn) (*ListBulkChecksResponse, error)

ListBulkChecksWithResponse request returning *ListBulkChecksResponse

func (*ClientWithResponses) ListNameJobNamesWithResponse added in v0.20.0

func (c *ClientWithResponses) ListNameJobNamesWithResponse(ctx context.Context, jobId string, params *ListNameJobNamesParams, reqEditors ...RequestEditorFn) (*ListNameJobNamesResponse, error)

ListNameJobNamesWithResponse request returning *ListNameJobNamesResponse

func (*ClientWithResponses) ListNameJobsWithResponse added in v0.20.0

func (c *ClientWithResponses) ListNameJobsWithResponse(ctx context.Context, params *ListNameJobsParams, reqEditors ...RequestEditorFn) (*ListNameJobsResponse, error)

ListNameJobsWithResponse request returning *ListNameJobsResponse

func (*ClientWithResponses) ListSavedDomainsWithResponse added in v0.20.0

func (c *ClientWithResponses) ListSavedDomainsWithResponse(ctx context.Context, params *ListSavedDomainsParams, reqEditors ...RequestEditorFn) (*ListSavedDomainsResponse, error)

ListSavedDomainsWithResponse request returning *ListSavedDomainsResponse

func (*ClientWithResponses) RemoveSavedDomainWithResponse added in v0.20.0

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

RemoveSavedDomainWithResponse request returning *RemoveSavedDomainResponse

func (*ClientWithResponses) SaveDomainWithBodyWithResponse added in v0.20.0

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

SaveDomainWithBodyWithResponse request with arbitrary body returning *SaveDomainResponse

func (*ClientWithResponses) SaveDomainWithResponse added in v0.20.0

func (c *ClientWithResponses) SaveDomainWithResponse(ctx context.Context, body SaveDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*SaveDomainResponse, error)

func (*ClientWithResponses) StreamBulkCheckWithResponse added in v0.20.0

func (c *ClientWithResponses) StreamBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*StreamBulkCheckResponse, error)

StreamBulkCheckWithResponse request returning *StreamBulkCheckResponse

func (*ClientWithResponses) UpdateBrandWatcherWithBodyWithResponse added in v0.20.0

func (c *ClientWithResponses) UpdateBrandWatcherWithBodyWithResponse(ctx context.Context, id string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateBrandWatcherResponse, error)

UpdateBrandWatcherWithBodyWithResponse request with arbitrary body returning *UpdateBrandWatcherResponse

func (*ClientWithResponses) UpdateBrandWatcherWithResponse added in v0.20.0

func (c *ClientWithResponses) UpdateBrandWatcherWithResponse(ctx context.Context, id string, body UpdateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBrandWatcherResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListBrandHitsWithResponse request
	ListBrandHitsWithResponse(ctx context.Context, params *ListBrandHitsParams, reqEditors ...RequestEditorFn) (*ListBrandHitsResponse, error)

	// GetBrandHitWithResponse request
	GetBrandHitWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBrandHitResponse, error)

	// ListBrandWatchersWithResponse request
	ListBrandWatchersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListBrandWatchersResponse, error)

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

	CreateBrandWatcherWithResponse(ctx context.Context, body CreateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBrandWatcherResponse, error)

	// DeleteBrandWatcherWithResponse request
	DeleteBrandWatcherWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteBrandWatcherResponse, error)

	// GetBrandWatcherWithResponse request
	GetBrandWatcherWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBrandWatcherResponse, error)

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

	UpdateBrandWatcherWithResponse(ctx context.Context, id string, body UpdateBrandWatcherJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBrandWatcherResponse, error)

	// ListBrandWatcherHitsWithResponse request
	ListBrandWatcherHitsWithResponse(ctx context.Context, id string, params *ListBrandWatcherHitsParams, reqEditors ...RequestEditorFn) (*ListBrandWatcherHitsResponse, error)

	// CountBrandWatcherHitsWithResponse request
	CountBrandWatcherHitsWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*CountBrandWatcherHitsResponse, error)

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

	CheckDomainWithResponse(ctx context.Context, body CheckDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckDomainResponse, error)

	// ListBulkChecksWithResponse request
	ListBulkChecksWithResponse(ctx context.Context, params *ListBulkChecksParams, reqEditors ...RequestEditorFn) (*ListBulkChecksResponse, error)

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

	CreateBulkCheckWithResponse(ctx context.Context, body CreateBulkCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBulkCheckResponse, error)

	// DeleteBulkCheckWithResponse request
	DeleteBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteBulkCheckResponse, error)

	// GetBulkCheckWithResponse request
	GetBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetBulkCheckResponse, error)

	// CancelBulkCheckWithResponse request
	CancelBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*CancelBulkCheckResponse, error)

	// ExportBulkCheckResultsWithResponse request
	ExportBulkCheckResultsWithResponse(ctx context.Context, id string, params *ExportBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*ExportBulkCheckResultsResponse, error)

	// ListBulkCheckResultsWithResponse request
	ListBulkCheckResultsWithResponse(ctx context.Context, id string, params *ListBulkCheckResultsParams, reqEditors ...RequestEditorFn) (*ListBulkCheckResultsResponse, error)

	// StreamBulkCheckWithResponse request
	StreamBulkCheckWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*StreamBulkCheckResponse, error)

	// ListSavedDomainsWithResponse request
	ListSavedDomainsWithResponse(ctx context.Context, params *ListSavedDomainsParams, reqEditors ...RequestEditorFn) (*ListSavedDomainsResponse, error)

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

	SaveDomainWithResponse(ctx context.Context, body SaveDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*SaveDomainResponse, error)

	// RemoveSavedDomainWithResponse request
	RemoveSavedDomainWithResponse(ctx context.Context, domain string, reqEditors ...RequestEditorFn) (*RemoveSavedDomainResponse, error)

	// ListNameJobsWithResponse request
	ListNameJobsWithResponse(ctx context.Context, params *ListNameJobsParams, reqEditors ...RequestEditorFn) (*ListNameJobsResponse, error)

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

	CreateNameJobWithResponse(ctx context.Context, body CreateNameJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNameJobResponse, error)

	// DeleteNameJobWithResponse request
	DeleteNameJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteNameJobResponse, error)

	// GetNameJobWithResponse request
	GetNameJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetNameJobResponse, error)

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

	CheckNameJobNamesWithResponse(ctx context.Context, jobId string, body CheckNameJobNamesJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckNameJobNamesResponse, error)

	// ListNameJobNamesWithResponse request
	ListNameJobNamesWithResponse(ctx context.Context, jobId string, params *ListNameJobNamesParams, reqEditors ...RequestEditorFn) (*ListNameJobNamesResponse, error)
}

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

type ConstantsAIRisk

type ConstantsAIRisk string

ConstantsAIRisk defines model for constants.AIRisk.

const (
	AIRiskHigh   ConstantsAIRisk = "high"
	AIRiskLow    ConstantsAIRisk = "low"
	AIRiskMedium ConstantsAIRisk = "medium"
)

Defines values for ConstantsAIRisk.

func (ConstantsAIRisk) Valid

func (e ConstantsAIRisk) Valid() bool

Valid indicates whether the value is a known member of the ConstantsAIRisk enum.

type ConstantsCheckMode

type ConstantsCheckMode string

ConstantsCheckMode defines model for constants.CheckMode.

const (
	CheckModeBloom    ConstantsCheckMode = "bloom"
	CheckModeFull     ConstantsCheckMode = "full"
	CheckModeInfo     ConstantsCheckMode = "info"
	CheckModeVerified ConstantsCheckMode = "verified"
)

Defines values for ConstantsCheckMode.

func (ConstantsCheckMode) Valid

func (e ConstantsCheckMode) Valid() bool

Valid indicates whether the value is a known member of the ConstantsCheckMode enum.

type ConstantsNameGenSortBy

type ConstantsNameGenSortBy string

ConstantsNameGenSortBy defines model for constants.NameGenSortBy.

const (
	NameGenSortByLength ConstantsNameGenSortBy = "length"
	NameGenSortByName   ConstantsNameGenSortBy = "name"
)

Defines values for ConstantsNameGenSortBy.

func (ConstantsNameGenSortBy) Valid

func (e ConstantsNameGenSortBy) Valid() bool

Valid indicates whether the value is a known member of the ConstantsNameGenSortBy enum.

type ConstantsNameGeneratorJobStatus

type ConstantsNameGeneratorJobStatus string

ConstantsNameGeneratorJobStatus defines model for constants.NameGeneratorJobStatus.

const (
	NameGenStatusCompleted  ConstantsNameGeneratorJobStatus = "completed"
	NameGenStatusFailed     ConstantsNameGeneratorJobStatus = "failed"
	NameGenStatusGenerating ConstantsNameGeneratorJobStatus = "generating"
)

Defines values for ConstantsNameGeneratorJobStatus.

func (ConstantsNameGeneratorJobStatus) Valid

Valid indicates whether the value is a known member of the ConstantsNameGeneratorJobStatus enum.

type ConstantsNameGeneratorSize

type ConstantsNameGeneratorSize string

ConstantsNameGeneratorSize defines model for constants.NameGeneratorSize.

const (
	NameGenSizeLarge  ConstantsNameGeneratorSize = "large"
	NameGenSizeMedium ConstantsNameGeneratorSize = "medium"
	NameGenSizeSmall  ConstantsNameGeneratorSize = "small"
)

Defines values for ConstantsNameGeneratorSize.

func (ConstantsNameGeneratorSize) Valid

func (e ConstantsNameGeneratorSize) Valid() bool

Valid indicates whether the value is a known member of the ConstantsNameGeneratorSize enum.

type ConstantsSavedDomainSortBy

type ConstantsSavedDomainSortBy string

ConstantsSavedDomainSortBy defines model for constants.SavedDomainSortBy.

const (
	SavedDomainSortByCreatedAt  ConstantsSavedDomainSortBy = "created_at"
	SavedDomainSortByDomain     ConstantsSavedDomainSortBy = "domain"
	SavedDomainSortByExpiryDate ConstantsSavedDomainSortBy = "expiry_date"
	SavedDomainSortByRegistrar  ConstantsSavedDomainSortBy = "registrar"
)

Defines values for ConstantsSavedDomainSortBy.

func (ConstantsSavedDomainSortBy) Valid

func (e ConstantsSavedDomainSortBy) Valid() bool

Valid indicates whether the value is a known member of the ConstantsSavedDomainSortBy enum.

type ConstantsSortDir

type ConstantsSortDir string

ConstantsSortDir defines model for constants.SortDir.

const (
	SortAsc  ConstantsSortDir = "asc"
	SortDesc ConstantsSortDir = "desc"
)

Defines values for ConstantsSortDir.

func (ConstantsSortDir) Valid

func (e ConstantsSortDir) Valid() bool

Valid indicates whether the value is a known member of the ConstantsSortDir enum.

type CountBrandWatcherHitsResponse added in v0.20.0

type CountBrandWatcherHitsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BrandmonitorhandlerWatcherHitCountResponse
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCountBrandWatcherHitsResponse added in v0.20.0

func ParseCountBrandWatcherHitsResponse(rsp *http.Response) (*CountBrandWatcherHitsResponse, error)

ParseCountBrandWatcherHitsResponse parses an HTTP response from a CountBrandWatcherHitsWithResponse call

func (CountBrandWatcherHitsResponse) ContentType added in v0.20.0

func (r CountBrandWatcherHitsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CountBrandWatcherHitsResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (CountBrandWatcherHitsResponse) StatusCode added in v0.20.0

func (r CountBrandWatcherHitsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateBrandWatcherJSONRequestBody added in v0.20.0

type CreateBrandWatcherJSONRequestBody = BrandmonitorhandlerCreateWatcherRequest

CreateBrandWatcherJSONRequestBody defines body for CreateBrandWatcher for application/json ContentType.

type CreateBrandWatcherResponse added in v0.20.0

type CreateBrandWatcherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *DtoWatcher
	JSON400      *ResponseAPIError
	JSON409      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCreateBrandWatcherResponse added in v0.20.0

func ParseCreateBrandWatcherResponse(rsp *http.Response) (*CreateBrandWatcherResponse, error)

ParseCreateBrandWatcherResponse parses an HTTP response from a CreateBrandWatcherWithResponse call

func (CreateBrandWatcherResponse) ContentType added in v0.20.0

func (r CreateBrandWatcherResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateBrandWatcherResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (CreateBrandWatcherResponse) StatusCode added in v0.20.0

func (r CreateBrandWatcherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateBulkCheckJSONRequestBody added in v0.20.0

type CreateBulkCheckJSONRequestBody = CheckhandlerBulkCheckRequest

CreateBulkCheckJSONRequestBody defines body for CreateBulkCheck for application/json ContentType.

type CreateBulkCheckResponse added in v0.20.0

type CreateBulkCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *DtoBulkCheckJob
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCreateBulkCheckResponse added in v0.20.0

func ParseCreateBulkCheckResponse(rsp *http.Response) (*CreateBulkCheckResponse, error)

ParseCreateBulkCheckResponse parses an HTTP response from a CreateBulkCheckWithResponse call

func (CreateBulkCheckResponse) ContentType added in v0.20.0

func (r CreateBulkCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateBulkCheckResponse) Status added in v0.20.0

func (r CreateBulkCheckResponse) Status() string

Status returns HTTPResponse.Status

func (CreateBulkCheckResponse) StatusCode added in v0.20.0

func (r CreateBulkCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateNameJobJSONRequestBody added in v0.20.0

type CreateNameJobJSONRequestBody = NamegenhandlerCreateJobRequest

CreateNameJobJSONRequestBody defines body for CreateNameJob for application/json ContentType.

type CreateNameJobResponse added in v0.20.0

type CreateNameJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *DtoNameGeneratorJob
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseCreateNameJobResponse added in v0.20.0

func ParseCreateNameJobResponse(rsp *http.Response) (*CreateNameJobResponse, error)

ParseCreateNameJobResponse parses an HTTP response from a CreateNameJobWithResponse call

func (CreateNameJobResponse) ContentType added in v0.20.0

func (r CreateNameJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateNameJobResponse) Status added in v0.20.0

func (r CreateNameJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateNameJobResponse) StatusCode added in v0.20.0

func (r CreateNameJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteBrandWatcherResponse added in v0.20.0

type DeleteBrandWatcherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseDeleteBrandWatcherResponse added in v0.20.0

func ParseDeleteBrandWatcherResponse(rsp *http.Response) (*DeleteBrandWatcherResponse, error)

ParseDeleteBrandWatcherResponse parses an HTTP response from a DeleteBrandWatcherWithResponse call

func (DeleteBrandWatcherResponse) ContentType added in v0.20.0

func (r DeleteBrandWatcherResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteBrandWatcherResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (DeleteBrandWatcherResponse) StatusCode added in v0.20.0

func (r DeleteBrandWatcherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteBulkCheckResponse added in v0.20.0

type DeleteBulkCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseDeleteBulkCheckResponse added in v0.20.0

func ParseDeleteBulkCheckResponse(rsp *http.Response) (*DeleteBulkCheckResponse, error)

ParseDeleteBulkCheckResponse parses an HTTP response from a DeleteBulkCheckWithResponse call

func (DeleteBulkCheckResponse) ContentType added in v0.20.0

func (r DeleteBulkCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteBulkCheckResponse) Status added in v0.20.0

func (r DeleteBulkCheckResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteBulkCheckResponse) StatusCode added in v0.20.0

func (r DeleteBulkCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteNameJobResponse added in v0.20.0

type DeleteNameJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseDeleteNameJobResponse added in v0.20.0

func ParseDeleteNameJobResponse(rsp *http.Response) (*DeleteNameJobResponse, error)

ParseDeleteNameJobResponse parses an HTTP response from a DeleteNameJobWithResponse call

func (DeleteNameJobResponse) ContentType added in v0.20.0

func (r DeleteNameJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteNameJobResponse) Status added in v0.20.0

func (r DeleteNameJobResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteNameJobResponse) StatusCode added in v0.20.0

func (r DeleteNameJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DtoBulkCheckJob

type DtoBulkCheckJob struct {
	CompletedDomains *int                `json:"completedDomains,omitempty"`
	CreatedAt        *string             `json:"createdAt,omitempty"`
	Id               *string             `json:"id,omitempty"`
	MaxAge           *string             `json:"maxAge,omitempty"`
	Mode             *ConstantsCheckMode `json:"mode,omitempty"`
	Status           *string             `json:"status,omitempty"`
	Tlds             *[]string           `json:"tlds,omitempty"`
	TotalDomains     *int                `json:"totalDomains,omitempty"`
}

DtoBulkCheckJob defines model for dto.BulkCheckJob.

type DtoDomainCheck

type DtoDomainCheck struct {
	Available         *bool                `json:"available,omitempty"`
	CacheHit          *bool                `json:"cacheHit,omitempty"`
	CheckedAt         *string              `json:"checkedAt,omitempty"`
	CreatedDate       *string              `json:"createdDate,omitempty"`
	DnsRecords        *map[string][]string `json:"dnsRecords,omitempty"`
	Domain            *string              `json:"domain,omitempty"`
	Error             *string              `json:"error,omitempty"`
	ExpiryDate        *string              `json:"expiryDate,omitempty"`
	IsSaved           *bool                `json:"isSaved,omitempty"`
	MaxAge            *string              `json:"maxAge,omitempty"`
	Method            *string              `json:"method,omitempty"`
	ProcessingTimeMs  *int                 `json:"processingTimeMs,omitempty"`
	RawRdapResponse   *string              `json:"rawRdapResponse,omitempty"`
	RawWhoisResponse  *string              `json:"rawWhoisResponse,omitempty"`
	RdapSourceServer  *string              `json:"rdapSourceServer,omitempty"`
	Registrar         *string              `json:"registrar,omitempty"`
	Status            *string              `json:"status,omitempty"`
	UpdatedDate       *string              `json:"updatedDate,omitempty"`
	WhoisSourceServer *string              `json:"whoisSourceServer,omitempty"`
}

DtoDomainCheck defines model for dto.DomainCheck.

type DtoGeneratedName

type DtoGeneratedName struct {
	Length *int    `json:"length,omitempty"`
	Name   *string `json:"name,omitempty"`
}

DtoGeneratedName defines model for dto.GeneratedName.

type DtoMonitorHit

type DtoMonitorHit struct {
	AiBrandImpersonation *bool            `json:"aiBrandImpersonation,omitempty"`
	AiCheckedAt          *string          `json:"aiCheckedAt,omitempty"`
	AiIndicators         *[]string        `json:"aiIndicators,omitempty"`
	AiReasoning          *string          `json:"aiReasoning,omitempty"`
	AiRisk               *ConstantsAIRisk `json:"aiRisk,omitempty"`
	AllDomains           *[]string        `json:"allDomains,omitempty"`
	CreatedAt            *string          `json:"createdAt,omitempty"`
	CtLog                *string          `json:"ctLog,omitempty"`
	Domain               *string          `json:"domain,omitempty"`
	DomainCheckId        *string          `json:"domainCheckId,omitempty"`
	Id                   *string          `json:"id,omitempty"`
	Issuer               *string          `json:"issuer,omitempty"`
	Keyword              *string          `json:"keyword,omitempty"`
	MatchReason          *string          `json:"matchReason,omitempty"`
	NotificationSent     *bool            `json:"notificationSent,omitempty"`
	RegistrationDate     *string          `json:"registrationDate,omitempty"`
	Score                *int             `json:"score,omitempty"`
	ScoreLevel           *string          `json:"scoreLevel,omitempty"`
	WatcherId            *string          `json:"watcherId,omitempty"`
}

DtoMonitorHit defines model for dto.MonitorHit.

type DtoNameGeneratorJob

type DtoNameGeneratorJob struct {
	Category    *string                          `json:"category,omitempty"`
	CompletedAt *string                          `json:"completedAt,omitempty"`
	CreatedAt   *string                          `json:"createdAt,omitempty"`
	Description *string                          `json:"description,omitempty"`
	Error       *string                          `json:"error,omitempty"`
	Id          *string                          `json:"id,omitempty"`
	MaxLength   *int                             `json:"maxLength,omitempty"`
	Size        *ConstantsNameGeneratorSize      `json:"size,omitempty"`
	Status      *ConstantsNameGeneratorJobStatus `json:"status,omitempty"`
	Style       *string                          `json:"style,omitempty"`
	TotalNames  *int                             `json:"totalNames,omitempty"`
}

DtoNameGeneratorJob defines model for dto.NameGeneratorJob.

type DtoSavedDomain

type DtoSavedDomain struct {
	Domain      *string         `json:"domain,omitempty"`
	LatestCheck *DtoDomainCheck `json:"latestCheck,omitempty"`
	Notes       *string         `json:"notes,omitempty"`
	SavedAt     *string         `json:"savedAt,omitempty"`
	Tld         *string         `json:"tld,omitempty"`
}

DtoSavedDomain defines model for dto.SavedDomain.

type DtoWatcher

type DtoWatcher struct {
	AiContentCheck       *bool     `json:"aiContentCheck,omitempty"`
	Allowlist            *[]string `json:"allowlist,omitempty"`
	CreatedAt            *string   `json:"createdAt,omitempty"`
	Enabled              *bool     `json:"enabled,omitempty"`
	Id                   *string   `json:"id,omitempty"`
	MinNotificationScore *int      `json:"minNotificationScore,omitempty"`
	NotificationEmail    *string   `json:"notificationEmail,omitempty"`
	UpdatedAt            *string   `json:"updatedAt,omitempty"`
	Word                 *string   `json:"word,omitempty"`
}

DtoWatcher defines model for dto.Watcher.

type ExportBulkCheckResultsParams added in v0.20.0

type ExportBulkCheckResultsParams struct {
	Available *[]bool   `form:"available,omitempty" json:"available,omitempty"`
	Cursor    *string   `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit     *int      `form:"limit,omitempty" json:"limit,omitempty"`
	Search    *string   `form:"search,omitempty" json:"search,omitempty"`
	Tld       *[]string `form:"tld,omitempty" json:"tld,omitempty"`
}

ExportBulkCheckResultsParams defines parameters for ExportBulkCheckResults.

type ExportBulkCheckResultsResponse added in v0.20.0

type ExportBulkCheckResultsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseExportBulkCheckResultsResponse added in v0.20.0

func ParseExportBulkCheckResultsResponse(rsp *http.Response) (*ExportBulkCheckResultsResponse, error)

ParseExportBulkCheckResultsResponse parses an HTTP response from a ExportBulkCheckResultsWithResponse call

func (ExportBulkCheckResultsResponse) ContentType added in v0.20.0

func (r ExportBulkCheckResultsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExportBulkCheckResultsResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (ExportBulkCheckResultsResponse) StatusCode added in v0.20.0

func (r ExportBulkCheckResultsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBrandHitResponse added in v0.20.0

type GetBrandHitResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoMonitorHit
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseGetBrandHitResponse added in v0.20.0

func ParseGetBrandHitResponse(rsp *http.Response) (*GetBrandHitResponse, error)

ParseGetBrandHitResponse parses an HTTP response from a GetBrandHitWithResponse call

func (GetBrandHitResponse) ContentType added in v0.20.0

func (r GetBrandHitResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBrandHitResponse) Status added in v0.20.0

func (r GetBrandHitResponse) Status() string

Status returns HTTPResponse.Status

func (GetBrandHitResponse) StatusCode added in v0.20.0

func (r GetBrandHitResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBrandWatcherResponse added in v0.20.0

type GetBrandWatcherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoWatcher
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseGetBrandWatcherResponse added in v0.20.0

func ParseGetBrandWatcherResponse(rsp *http.Response) (*GetBrandWatcherResponse, error)

ParseGetBrandWatcherResponse parses an HTTP response from a GetBrandWatcherWithResponse call

func (GetBrandWatcherResponse) ContentType added in v0.20.0

func (r GetBrandWatcherResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBrandWatcherResponse) Status added in v0.20.0

func (r GetBrandWatcherResponse) Status() string

Status returns HTTPResponse.Status

func (GetBrandWatcherResponse) StatusCode added in v0.20.0

func (r GetBrandWatcherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBulkCheckResponse added in v0.20.0

type GetBulkCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoBulkCheckJob
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
}

func ParseGetBulkCheckResponse added in v0.20.0

func ParseGetBulkCheckResponse(rsp *http.Response) (*GetBulkCheckResponse, error)

ParseGetBulkCheckResponse parses an HTTP response from a GetBulkCheckWithResponse call

func (GetBulkCheckResponse) ContentType added in v0.20.0

func (r GetBulkCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBulkCheckResponse) Status added in v0.20.0

func (r GetBulkCheckResponse) Status() string

Status returns HTTPResponse.Status

func (GetBulkCheckResponse) StatusCode added in v0.20.0

func (r GetBulkCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNameJobResponse added in v0.20.0

type GetNameJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoNameGeneratorJob
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
}

func ParseGetNameJobResponse added in v0.20.0

func ParseGetNameJobResponse(rsp *http.Response) (*GetNameJobResponse, error)

ParseGetNameJobResponse parses an HTTP response from a GetNameJobWithResponse call

func (GetNameJobResponse) ContentType added in v0.20.0

func (r GetNameJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetNameJobResponse) Status added in v0.20.0

func (r GetNameJobResponse) Status() string

Status returns HTTPResponse.Status

func (GetNameJobResponse) StatusCode added in v0.20.0

func (r GetNameJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListBrandHitsParams added in v0.20.0

type ListBrandHitsParams struct {
	Cursor   *string `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit    *int    `form:"limit,omitempty" json:"limit,omitempty"`
	ScoreMax *int    `form:"scoreMax,omitempty" json:"scoreMax,omitempty"`
	ScoreMin *int    `form:"scoreMin,omitempty" json:"scoreMin,omitempty"`
	Search   *string `form:"search,omitempty" json:"search,omitempty"`

	// WatcherId WatcherIDs filters to these watchers: repeat the parameter
	// (watcherId=a&watcherId=b) or comma-separate the ids.
	WatcherId *[]string `form:"watcherId,omitempty" json:"watcherId,omitempty"`
}

ListBrandHitsParams defines parameters for ListBrandHits.

type ListBrandHitsResponse added in v0.20.0

type ListBrandHitsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BrandmonitorhandlerListHitsResponse
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseListBrandHitsResponse added in v0.20.0

func ParseListBrandHitsResponse(rsp *http.Response) (*ListBrandHitsResponse, error)

ParseListBrandHitsResponse parses an HTTP response from a ListBrandHitsWithResponse call

func (ListBrandHitsResponse) ContentType added in v0.20.0

func (r ListBrandHitsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBrandHitsResponse) Status added in v0.20.0

func (r ListBrandHitsResponse) Status() string

Status returns HTTPResponse.Status

func (ListBrandHitsResponse) StatusCode added in v0.20.0

func (r ListBrandHitsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBrandWatcherHitsParams added in v0.20.0

type ListBrandWatcherHitsParams struct {
	Cursor   *string `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit    *int    `form:"limit,omitempty" json:"limit,omitempty"`
	ScoreMax *int    `form:"scoreMax,omitempty" json:"scoreMax,omitempty"`
	ScoreMin *int    `form:"scoreMin,omitempty" json:"scoreMin,omitempty"`
	Search   *string `form:"search,omitempty" json:"search,omitempty"`

	// WatcherId WatcherIDs filters to these watchers: repeat the parameter
	// (watcherId=a&watcherId=b) or comma-separate the ids.
	WatcherId *[]string `form:"watcherId,omitempty" json:"watcherId,omitempty"`
}

ListBrandWatcherHitsParams defines parameters for ListBrandWatcherHits.

type ListBrandWatcherHitsResponse added in v0.20.0

type ListBrandWatcherHitsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BrandmonitorhandlerListHitsResponse
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseListBrandWatcherHitsResponse added in v0.20.0

func ParseListBrandWatcherHitsResponse(rsp *http.Response) (*ListBrandWatcherHitsResponse, error)

ParseListBrandWatcherHitsResponse parses an HTTP response from a ListBrandWatcherHitsWithResponse call

func (ListBrandWatcherHitsResponse) ContentType added in v0.20.0

func (r ListBrandWatcherHitsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBrandWatcherHitsResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (ListBrandWatcherHitsResponse) StatusCode added in v0.20.0

func (r ListBrandWatcherHitsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBrandWatchersResponse added in v0.20.0

type ListBrandWatchersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]DtoWatcher
	JSON500      *ResponseAPIError
}

func ParseListBrandWatchersResponse added in v0.20.0

func ParseListBrandWatchersResponse(rsp *http.Response) (*ListBrandWatchersResponse, error)

ParseListBrandWatchersResponse parses an HTTP response from a ListBrandWatchersWithResponse call

func (ListBrandWatchersResponse) ContentType added in v0.20.0

func (r ListBrandWatchersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBrandWatchersResponse) Status added in v0.20.0

func (r ListBrandWatchersResponse) Status() string

Status returns HTTPResponse.Status

func (ListBrandWatchersResponse) StatusCode added in v0.20.0

func (r ListBrandWatchersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBulkCheckResultsParams added in v0.20.0

type ListBulkCheckResultsParams struct {
	Available *[]bool   `form:"available,omitempty" json:"available,omitempty"`
	Cursor    *string   `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit     *int      `form:"limit,omitempty" json:"limit,omitempty"`
	Search    *string   `form:"search,omitempty" json:"search,omitempty"`
	Tld       *[]string `form:"tld,omitempty" json:"tld,omitempty"`
}

ListBulkCheckResultsParams defines parameters for ListBulkCheckResults.

type ListBulkCheckResultsResponse added in v0.20.0

type ListBulkCheckResultsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
		List    []DtoDomainCheck                     `json:"list"`
		Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
	}
	JSON400 *ResponseAPIError
	JSON404 *ResponseAPIError
	JSON500 *ResponseAPIError
}

func ParseListBulkCheckResultsResponse added in v0.20.0

func ParseListBulkCheckResultsResponse(rsp *http.Response) (*ListBulkCheckResultsResponse, error)

ParseListBulkCheckResultsResponse parses an HTTP response from a ListBulkCheckResultsWithResponse call

func (ListBulkCheckResultsResponse) ContentType added in v0.20.0

func (r ListBulkCheckResultsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBulkCheckResultsResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (ListBulkCheckResultsResponse) StatusCode added in v0.20.0

func (r ListBulkCheckResultsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBulkChecksParams added in v0.20.0

type ListBulkChecksParams struct {
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
}

ListBulkChecksParams defines parameters for ListBulkChecks.

type ListBulkChecksResponse added in v0.20.0

type ListBulkChecksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
		List    []DtoBulkCheckJob                    `json:"list"`
		Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
	}
	JSON500 *ResponseAPIError
}

func ParseListBulkChecksResponse added in v0.20.0

func ParseListBulkChecksResponse(rsp *http.Response) (*ListBulkChecksResponse, error)

ParseListBulkChecksResponse parses an HTTP response from a ListBulkChecksWithResponse call

func (ListBulkChecksResponse) ContentType added in v0.20.0

func (r ListBulkChecksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBulkChecksResponse) Status added in v0.20.0

func (r ListBulkChecksResponse) Status() string

Status returns HTTPResponse.Status

func (ListBulkChecksResponse) StatusCode added in v0.20.0

func (r ListBulkChecksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNameJobNamesParams added in v0.20.0

type ListNameJobNamesParams struct {
	Cursor    *string                        `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit     *int                           `form:"limit,omitempty" json:"limit,omitempty"`
	MaxLength *int                           `form:"maxLength,omitempty" json:"maxLength,omitempty"`
	MinLength *int                           `form:"minLength,omitempty" json:"minLength,omitempty"`
	Search    *string                        `form:"search,omitempty" json:"search,omitempty"`
	SortBy    *ListNameJobNamesParamsSortBy  `form:"sortBy,omitempty" json:"sortBy,omitempty"`
	SortDir   *ListNameJobNamesParamsSortDir `form:"sortDir,omitempty" json:"sortDir,omitempty"`
}

ListNameJobNamesParams defines parameters for ListNameJobNames.

type ListNameJobNamesParamsSortBy added in v0.20.0

type ListNameJobNamesParamsSortBy string

ListNameJobNamesParamsSortBy defines parameters for ListNameJobNames.

const (
	Length ListNameJobNamesParamsSortBy = "length"
	Name   ListNameJobNamesParamsSortBy = "name"
)

Defines values for ListNameJobNamesParamsSortBy.

func (ListNameJobNamesParamsSortBy) Valid added in v0.20.0

Valid indicates whether the value is a known member of the ListNameJobNamesParamsSortBy enum.

type ListNameJobNamesParamsSortDir added in v0.20.0

type ListNameJobNamesParamsSortDir string

ListNameJobNamesParamsSortDir defines parameters for ListNameJobNames.

const (
	ListNameJobNamesParamsSortDirAsc  ListNameJobNamesParamsSortDir = "asc"
	ListNameJobNamesParamsSortDirDesc ListNameJobNamesParamsSortDir = "desc"
)

Defines values for ListNameJobNamesParamsSortDir.

func (ListNameJobNamesParamsSortDir) Valid added in v0.20.0

Valid indicates whether the value is a known member of the ListNameJobNamesParamsSortDir enum.

type ListNameJobNamesResponse added in v0.20.0

type ListNameJobNamesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
		List    []DtoGeneratedName                   `json:"list"`
		Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
	}
	JSON400 *ResponseAPIError
	JSON500 *ResponseAPIError
}

func ParseListNameJobNamesResponse added in v0.20.0

func ParseListNameJobNamesResponse(rsp *http.Response) (*ListNameJobNamesResponse, error)

ParseListNameJobNamesResponse parses an HTTP response from a ListNameJobNamesWithResponse call

func (ListNameJobNamesResponse) ContentType added in v0.20.0

func (r ListNameJobNamesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListNameJobNamesResponse) Status added in v0.20.0

func (r ListNameJobNamesResponse) Status() string

Status returns HTTPResponse.Status

func (ListNameJobNamesResponse) StatusCode added in v0.20.0

func (r ListNameJobNamesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNameJobsParams added in v0.20.0

type ListNameJobsParams struct {
	// Limit Results per page (default 20, max 100)
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Pagination cursor
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListNameJobsParams defines parameters for ListNameJobs.

type ListNameJobsResponse added in v0.20.0

type ListNameJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
		List    []DtoNameGeneratorJob                `json:"list"`
		Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
	}
	JSON500 *ResponseAPIError
}

func ParseListNameJobsResponse added in v0.20.0

func ParseListNameJobsResponse(rsp *http.Response) (*ListNameJobsResponse, error)

ParseListNameJobsResponse parses an HTTP response from a ListNameJobsWithResponse call

func (ListNameJobsResponse) ContentType added in v0.20.0

func (r ListNameJobsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListNameJobsResponse) Status added in v0.20.0

func (r ListNameJobsResponse) Status() string

Status returns HTTPResponse.Status

func (ListNameJobsResponse) StatusCode added in v0.20.0

func (r ListNameJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSavedDomainsParams added in v0.20.0

type ListSavedDomainsParams struct {
	Available    *[]bool                        `form:"available,omitempty" json:"available,omitempty"`
	Cursor       *string                        `form:"cursor,omitempty" json:"cursor,omitempty"`
	ExpiryAfter  *string                        `form:"expiryAfter,omitempty" json:"expiryAfter,omitempty"`
	ExpiryBefore *string                        `form:"expiryBefore,omitempty" json:"expiryBefore,omitempty"`
	Limit        *int                           `form:"limit,omitempty" json:"limit,omitempty"`
	Registrar    *string                        `form:"registrar,omitempty" json:"registrar,omitempty"`
	Search       *string                        `form:"search,omitempty" json:"search,omitempty"`
	SortBy       *ListSavedDomainsParamsSortBy  `form:"sortBy,omitempty" json:"sortBy,omitempty"`
	SortDir      *ListSavedDomainsParamsSortDir `form:"sortDir,omitempty" json:"sortDir,omitempty"`
	Tld          *[]string                      `form:"tld,omitempty" json:"tld,omitempty"`
}

ListSavedDomainsParams defines parameters for ListSavedDomains.

type ListSavedDomainsParamsSortBy added in v0.20.0

type ListSavedDomainsParamsSortBy string

ListSavedDomainsParamsSortBy defines parameters for ListSavedDomains.

const (
	CreatedAt  ListSavedDomainsParamsSortBy = "created_at"
	Domain     ListSavedDomainsParamsSortBy = "domain"
	ExpiryDate ListSavedDomainsParamsSortBy = "expiry_date"
	Registrar  ListSavedDomainsParamsSortBy = "registrar"
)

Defines values for ListSavedDomainsParamsSortBy.

func (ListSavedDomainsParamsSortBy) Valid added in v0.20.0

Valid indicates whether the value is a known member of the ListSavedDomainsParamsSortBy enum.

type ListSavedDomainsParamsSortDir added in v0.20.0

type ListSavedDomainsParamsSortDir string

ListSavedDomainsParamsSortDir defines parameters for ListSavedDomains.

const (
	ListSavedDomainsParamsSortDirAsc  ListSavedDomainsParamsSortDir = "asc"
	ListSavedDomainsParamsSortDirDesc ListSavedDomainsParamsSortDir = "desc"
)

Defines values for ListSavedDomainsParamsSortDir.

func (ListSavedDomainsParamsSortDir) Valid added in v0.20.0

Valid indicates whether the value is a known member of the ListSavedDomainsParamsSortDir enum.

type ListSavedDomainsResponse added in v0.20.0

type ListSavedDomainsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
		List    []DtoSavedDomain                     `json:"list"`
		Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
	}
	JSON500 *ResponseAPIError
}

func ParseListSavedDomainsResponse added in v0.20.0

func ParseListSavedDomainsResponse(rsp *http.Response) (*ListSavedDomainsResponse, error)

ParseListSavedDomainsResponse parses an HTTP response from a ListSavedDomainsWithResponse call

func (ListSavedDomainsResponse) ContentType added in v0.20.0

func (r ListSavedDomainsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSavedDomainsResponse) Status added in v0.20.0

func (r ListSavedDomainsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSavedDomainsResponse) StatusCode added in v0.20.0

func (r ListSavedDomainsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NamegenhandlerCheckNamesRequest

type NamegenhandlerCheckNamesRequest struct {
	MaxAge *string             `json:"maxAge,omitempty"`
	Mode   *ConstantsCheckMode `json:"mode,omitempty"`
	Names  *[]string           `json:"names,omitempty"`
	Tlds   *[]string           `json:"tlds,omitempty"`
}

NamegenhandlerCheckNamesRequest defines model for namegenhandler.checkNamesRequest.

type NamegenhandlerCreateJobRequest

type NamegenhandlerCreateJobRequest struct {
	Category    *string                     `json:"category,omitempty"`
	Description *string                     `json:"description,omitempty"`
	MaxLength   *int                        `json:"maxLength,omitempty"`
	Size        *ConstantsNameGeneratorSize `json:"size,omitempty"`
	Style       *string                     `json:"style,omitempty"`
}

NamegenhandlerCreateJobRequest defines model for namegenhandler.createJobRequest.

type RemoveSavedDomainResponse added in v0.20.0

type RemoveSavedDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON500      *ResponseAPIError
}

func ParseRemoveSavedDomainResponse added in v0.20.0

func ParseRemoveSavedDomainResponse(rsp *http.Response) (*RemoveSavedDomainResponse, error)

ParseRemoveSavedDomainResponse parses an HTTP response from a RemoveSavedDomainWithResponse call

func (RemoveSavedDomainResponse) ContentType added in v0.20.0

func (r RemoveSavedDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RemoveSavedDomainResponse) Status added in v0.20.0

func (r RemoveSavedDomainResponse) Status() string

Status returns HTTPResponse.Status

func (RemoveSavedDomainResponse) StatusCode added in v0.20.0

func (r RemoveSavedDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseAPIError

type ResponseAPIError struct {
	Data      interface{}        `json:"data,omitempty"`
	Fields    *map[string]string `json:"fields,omitempty"`
	Msg       string             `json:"msg"`
	Timestamp *string            `json:"timestamp,omitempty"`
	TraceId   *string            `json:"traceId,omitempty"`
	Type      ResponseType       `json:"type"`
}

ResponseAPIError defines model for response.APIError.

type ResponseAPIResponsePaginationCursors

type ResponseAPIResponsePaginationCursors struct {
	Next *string `json:"next,omitempty"`
	Prev *string `json:"prev,omitempty"`
}

ResponseAPIResponsePaginationCursors defines model for response.APIResponsePaginationCursors.

type ResponseAPIResponsePaginationMeta

type ResponseAPIResponsePaginationMeta struct {
	Timestamp *string `json:"timestamp,omitempty"`
}

ResponseAPIResponsePaginationMeta defines model for response.APIResponsePaginationMeta.

type ResponseAPIResponseWithPagination

type ResponseAPIResponseWithPagination struct {
	Cursors ResponseAPIResponsePaginationCursors `json:"cursors"`
	List    interface{}                          `json:"list"`
	Meta    ResponseAPIResponsePaginationMeta    `json:"meta"`
}

ResponseAPIResponseWithPagination defines model for response.APIResponseWithPagination.

type ResponseType

type ResponseType string

ResponseType defines model for response.Type.

const (
	ErrConflict              ResponseType = "CONFLICT"
	ErrForbidden             ResponseType = "FORBIDDEN"
	ErrInsufficientScope     ResponseType = "INSUFFICIENT_SCOPE"
	ErrInternal              ResponseType = "INTERNAL_ERROR"
	ErrInvalidPayload        ResponseType = "INVALID_PAYLOAD"
	ErrMissingOrganizationID ResponseType = "MISSING_ORGANIZATION_ID"
	ErrMissingUserID         ResponseType = "MISSING_USER_ID"
	ErrNotFound              ResponseType = "NOT_FOUND"
	ErrOrgBlocked            ResponseType = "ORG_BLOCKED"
	ErrTooManyRequests       ResponseType = "TOO_MANY_REQUESTS"
	ErrUnauthorized          ResponseType = "UNAUTHORIZED"
	ErrValidationFailed      ResponseType = "VALIDATION_FAILED"
)

Defines values for ResponseType.

func (ResponseType) Valid

func (e ResponseType) Valid() bool

Valid indicates whether the value is a known member of the ResponseType enum.

type SaveDomainJSONRequestBody added in v0.20.0

type SaveDomainJSONRequestBody = SaveddomainhandlerSaveRequest

SaveDomainJSONRequestBody defines body for SaveDomain for application/json ContentType.

type SaveDomainResponse added in v0.20.0

type SaveDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseSaveDomainResponse added in v0.20.0

func ParseSaveDomainResponse(rsp *http.Response) (*SaveDomainResponse, error)

ParseSaveDomainResponse parses an HTTP response from a SaveDomainWithResponse call

func (SaveDomainResponse) ContentType added in v0.20.0

func (r SaveDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SaveDomainResponse) Status added in v0.20.0

func (r SaveDomainResponse) Status() string

Status returns HTTPResponse.Status

func (SaveDomainResponse) StatusCode added in v0.20.0

func (r SaveDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SaveddomainhandlerSaveRequest

type SaveddomainhandlerSaveRequest struct {
	Domain *string `json:"domain,omitempty"`
	Notes  *string `json:"notes,omitempty"`
}

SaveddomainhandlerSaveRequest defines model for saveddomainhandler.saveRequest.

type StreamBulkCheckResponse added in v0.20.0

type StreamBulkCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseStreamBulkCheckResponse added in v0.20.0

func ParseStreamBulkCheckResponse(rsp *http.Response) (*StreamBulkCheckResponse, error)

ParseStreamBulkCheckResponse parses an HTTP response from a StreamBulkCheckWithResponse call

func (StreamBulkCheckResponse) ContentType added in v0.20.0

func (r StreamBulkCheckResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StreamBulkCheckResponse) Status added in v0.20.0

func (r StreamBulkCheckResponse) Status() string

Status returns HTTPResponse.Status

func (StreamBulkCheckResponse) StatusCode added in v0.20.0

func (r StreamBulkCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateBrandWatcherJSONRequestBody added in v0.20.0

type UpdateBrandWatcherJSONRequestBody = BrandmonitorhandlerUpdateWatcherRequest

UpdateBrandWatcherJSONRequestBody defines body for UpdateBrandWatcher for application/json ContentType.

type UpdateBrandWatcherResponse added in v0.20.0

type UpdateBrandWatcherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DtoWatcher
	JSON400      *ResponseAPIError
	JSON404      *ResponseAPIError
	JSON500      *ResponseAPIError
}

func ParseUpdateBrandWatcherResponse added in v0.20.0

func ParseUpdateBrandWatcherResponse(rsp *http.Response) (*UpdateBrandWatcherResponse, error)

ParseUpdateBrandWatcherResponse parses an HTTP response from a UpdateBrandWatcherWithResponse call

func (UpdateBrandWatcherResponse) ContentType added in v0.20.0

func (r UpdateBrandWatcherResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateBrandWatcherResponse) Status added in v0.20.0

Status returns HTTPResponse.Status

func (UpdateBrandWatcherResponse) StatusCode added in v0.20.0

func (r UpdateBrandWatcherResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL