site_search

package
v2.0.1 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2022 License: MIT Imports: 23 Imported by: 0

README

Use these endpoints for searching content on your HubSpot hosted CMS website(s).

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v3
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import site_search "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), site_search.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), site_search.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), site_search.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), site_search.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class Method HTTP request Description
PublicApi GetByID Get /cms/v3/site-search/indexed-data/{contentId} Get indexed properties.
PublicApi Search Get /cms/v3/site-search/search Search your site.

Documentation For Models

Documentation For Authorization

hapikey
  • Type: API key
  • API key parameter name: hapikey
  • Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: hapikey and passed in as the auth context for each request.

oauth2_legacy

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
private_apps_legacy
  • Type: API key
  • API key parameter name: private-app-legacy
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

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

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	PublicApi *PublicApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the CMS Site Search API vv3 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiGetByIDRequest 

type ApiGetByIDRequest struct {
	ApiService *PublicApiService
	// contains filtered or unexported fields
}

func (ApiGetByIDRequest) Execute 

func (r ApiGetByIDRequest) Execute() (*IndexedData, *http.Response, error)

func (ApiGetByIDRequest) Type_ 

func (r ApiGetByIDRequest) Type_(type_ string) ApiGetByIDRequest

The type of document. Can be one of `SITE_PAGE`, `BLOG_POST`, or `KNOWLEDGE_ARTICLE`.

type ApiSearchRequest 

type ApiSearchRequest struct {
	ApiService *PublicApiService
	// contains filtered or unexported fields
}

func (ApiSearchRequest) Autocomplete 

func (r ApiSearchRequest) Autocomplete(autocomplete bool) ApiSearchRequest

Specifies whether or not you are showing autocomplete results. Defaults to false.

func (ApiSearchRequest) BoostLimit 

func (r ApiSearchRequest) BoostLimit(boostLimit float32) ApiSearchRequest

Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-boost.html).

func (ApiSearchRequest) BoostRecent 

func (r ApiSearchRequest) BoostRecent(boostRecent string) ApiSearchRequest

Specifies a relative time window where scores of documents published outside this time window decay. This can only be used for blog posts. For example, boostRecent=10d will boost documents published within the last 10 days. Supported timeunits are ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).

func (ApiSearchRequest) Domain 

func (r ApiSearchRequest) Domain(domain []string) ApiSearchRequest

A domain to match search results for. Multiple domains can be provided with &.

func (ApiSearchRequest) Execute 

func (r ApiSearchRequest) Execute() (*PublicSearchResults, *http.Response, error)

func (ApiSearchRequest) GroupId 

func (r ApiSearchRequest) GroupId(groupId []int64) ApiSearchRequest

Specifies which blog(s) to be searched by blog ID. Can be used multiple times to search more than one blog.

func (ApiSearchRequest) HubdbQuery 

func (r ApiSearchRequest) HubdbQuery(hubdbQuery string) ApiSearchRequest

Specify a HubDB query to further filter the search results.

func (ApiSearchRequest) Language 

func (r ApiSearchRequest) Language(language string) ApiSearchRequest

Specifies the language of content to be searched. This value must be a valid [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `es` for Spanish)

func (ApiSearchRequest) Length 

func (r ApiSearchRequest) Length(length string) ApiSearchRequest

Specifies the length of the search results. Can be set to `LONG` or `SHORT`. `SHORT` will return the first 128 characters of the content's meta description. `LONG` will build a more detailed content snippet based on the html/content of the page.

func (ApiSearchRequest) Limit 

func (r ApiSearchRequest) Limit(limit int32) ApiSearchRequest

Specifies the number of results to be returned in a single response. Defaults to `10`. Maximum value is `100`.

func (ApiSearchRequest) MatchPrefix 

func (r ApiSearchRequest) MatchPrefix(matchPrefix bool) ApiSearchRequest

Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`.

func (ApiSearchRequest) Offset 

func (r ApiSearchRequest) Offset(offset int32) ApiSearchRequest

Used to page through the results. If there are more results than specified by the `limit` parameter, you will need to use the value of offset returned in the previous request to get the next set of results.

func (ApiSearchRequest) PathPrefix 

func (r ApiSearchRequest) PathPrefix(pathPrefix []string) ApiSearchRequest

Specifies a path prefix to filter search results. Will only return results with URL paths that start with the specified parameter. Can be used multiple times.

func (ApiSearchRequest) PopularityBoost 

func (r ApiSearchRequest) PopularityBoost(popularityBoost float32) ApiSearchRequest

Specifies how strongly a result is boosted based on its view count. Defaults to 1.0.

func (ApiSearchRequest) Property 

func (r ApiSearchRequest) Property(property []string) ApiSearchRequest

Specifies which properties to include in the search. Options include `title`, `description`, and `html`. All properties will be searched by default.

func (ApiSearchRequest) Q 

func (r ApiSearchRequest) Q(q string) ApiSearchRequest

The term to search for.

func (ApiSearchRequest) TableId 

func (r ApiSearchRequest) TableId(tableId int64) ApiSearchRequest

Specifies a specific HubDB table to search. Only returns results from the specified table. Can be used in tandem with the `hubdbQuery` parameter to further filter results.

func (ApiSearchRequest) Type_ 

func (r ApiSearchRequest) Type_(type_ []string) ApiSearchRequest

Specifies the type of content to search. Can be one or more of SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and KNOWLEDGE_ARTICLE. Defaults to all content types except LANDING_PAGE and KNOWLEDGE_ARTICLE

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type ContentSearchResult 

type ContentSearchResult struct {
	// The ID of the content.
	Id int32 `json:"id"`
	// The matching score of the document.
	Score float32 `json:"score"`
	// The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
	Type string `json:"type"`
	// The domain the document is hosted on.
	Domain string `json:"domain"`
	// The url of the document.
	Url string `json:"url"`
	// URL of the featured image.
	FeaturedImageUrl *string `json:"featuredImageUrl,omitempty"`
	// The document's language.
	Language *string `json:"language,omitempty"`
	// The title of the returned document.
	Title *string `json:"title,omitempty"`
	// The result's description. The content will be determined by the value of `length` in the request.
	Description *string `json:"description,omitempty"`
	// For knowledge articles, the category of the article.
	Category *string `json:"category,omitempty"`
	// For knowledge articles, the subcategory of the article.
	Subcategory *string `json:"subcategory,omitempty"`
	// Name of the author.
	AuthorFullName *string `json:"authorFullName,omitempty"`
	// If a blog post, the tags associated with it.
	Tags []string `json:"tags,omitempty"`
	// If a dynamic page, the ID of the HubDB table.
	TableId *int64 `json:"tableId,omitempty"`
	// If a dynamic page, the row ID in the HubDB table.
	RowId *int64 `json:"rowId,omitempty"`
	// The date the content was published.
	PublishedDate *int64 `json:"publishedDate,omitempty"`
	// The ID of the document in HubSpot.
	CombinedId *string `json:"combinedId,omitempty"`
}

ContentSearchResult An individual search result.

func NewContentSearchResult 

func NewContentSearchResult(id int32, score float32, type_ string, domain string, url string) *ContentSearchResult

NewContentSearchResult instantiates a new ContentSearchResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewContentSearchResultWithDefaults 

func NewContentSearchResultWithDefaults() *ContentSearchResult

NewContentSearchResultWithDefaults instantiates a new ContentSearchResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ContentSearchResult) GetAuthorFullName 

func (o *ContentSearchResult) GetAuthorFullName() string

GetAuthorFullName returns the AuthorFullName field value if set, zero value otherwise.

func (*ContentSearchResult) GetAuthorFullNameOk 

func (o *ContentSearchResult) GetAuthorFullNameOk() (*string, bool)

GetAuthorFullNameOk returns a tuple with the AuthorFullName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetCategory 

func (o *ContentSearchResult) GetCategory() string

GetCategory returns the Category field value if set, zero value otherwise.

func (*ContentSearchResult) GetCategoryOk 

func (o *ContentSearchResult) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetCombinedId 

func (o *ContentSearchResult) GetCombinedId() string

GetCombinedId returns the CombinedId field value if set, zero value otherwise.

func (*ContentSearchResult) GetCombinedIdOk 

func (o *ContentSearchResult) GetCombinedIdOk() (*string, bool)

GetCombinedIdOk returns a tuple with the CombinedId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetDescription 

func (o *ContentSearchResult) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ContentSearchResult) GetDescriptionOk 

func (o *ContentSearchResult) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetDomain 

func (o *ContentSearchResult) GetDomain() string

GetDomain returns the Domain field value

func (*ContentSearchResult) GetDomainOk 

func (o *ContentSearchResult) GetDomainOk() (*string, bool)

GetDomainOk returns a tuple with the Domain field value and a boolean to check if the value has been set.

func (*ContentSearchResult) GetFeaturedImageUrl 

func (o *ContentSearchResult) GetFeaturedImageUrl() string

GetFeaturedImageUrl returns the FeaturedImageUrl field value if set, zero value otherwise.

func (*ContentSearchResult) GetFeaturedImageUrlOk 

func (o *ContentSearchResult) GetFeaturedImageUrlOk() (*string, bool)

GetFeaturedImageUrlOk returns a tuple with the FeaturedImageUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetId 

func (o *ContentSearchResult) GetId() int32

GetId returns the Id field value

func (*ContentSearchResult) GetIdOk 

func (o *ContentSearchResult) GetIdOk() (*int32, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*ContentSearchResult) GetLanguage 

func (o *ContentSearchResult) GetLanguage() string

GetLanguage returns the Language field value if set, zero value otherwise.

func (*ContentSearchResult) GetLanguageOk 

func (o *ContentSearchResult) GetLanguageOk() (*string, bool)

GetLanguageOk returns a tuple with the Language field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetPublishedDate 

func (o *ContentSearchResult) GetPublishedDate() int64

GetPublishedDate returns the PublishedDate field value if set, zero value otherwise.

func (*ContentSearchResult) GetPublishedDateOk 

func (o *ContentSearchResult) GetPublishedDateOk() (*int64, bool)

GetPublishedDateOk returns a tuple with the PublishedDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetRowId 

func (o *ContentSearchResult) GetRowId() int64

GetRowId returns the RowId field value if set, zero value otherwise.

func (*ContentSearchResult) GetRowIdOk 

func (o *ContentSearchResult) GetRowIdOk() (*int64, bool)

GetRowIdOk returns a tuple with the RowId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetScore 

func (o *ContentSearchResult) GetScore() float32

GetScore returns the Score field value

func (*ContentSearchResult) GetScoreOk 

func (o *ContentSearchResult) GetScoreOk() (*float32, bool)

GetScoreOk returns a tuple with the Score field value and a boolean to check if the value has been set.

func (*ContentSearchResult) GetSubcategory 

func (o *ContentSearchResult) GetSubcategory() string

GetSubcategory returns the Subcategory field value if set, zero value otherwise.

func (*ContentSearchResult) GetSubcategoryOk 

func (o *ContentSearchResult) GetSubcategoryOk() (*string, bool)

GetSubcategoryOk returns a tuple with the Subcategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetTableId 

func (o *ContentSearchResult) GetTableId() int64

GetTableId returns the TableId field value if set, zero value otherwise.

func (*ContentSearchResult) GetTableIdOk 

func (o *ContentSearchResult) GetTableIdOk() (*int64, bool)

GetTableIdOk returns a tuple with the TableId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetTags 

func (o *ContentSearchResult) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*ContentSearchResult) GetTagsOk 

func (o *ContentSearchResult) GetTagsOk() ([]string, bool)

GetTagsOk returns a tuple with the Tags field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetTitle 

func (o *ContentSearchResult) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*ContentSearchResult) GetTitleOk 

func (o *ContentSearchResult) GetTitleOk() (*string, bool)

GetTitleOk returns a tuple with the Title field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentSearchResult) GetType 

func (o *ContentSearchResult) GetType() string

GetType returns the Type field value

func (*ContentSearchResult) GetTypeOk 

func (o *ContentSearchResult) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*ContentSearchResult) GetUrl 

func (o *ContentSearchResult) GetUrl() string

GetUrl returns the Url field value

func (*ContentSearchResult) GetUrlOk 

func (o *ContentSearchResult) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*ContentSearchResult) HasAuthorFullName 

func (o *ContentSearchResult) HasAuthorFullName() bool

HasAuthorFullName returns a boolean if a field has been set.

func (*ContentSearchResult) HasCategory 

func (o *ContentSearchResult) HasCategory() bool

HasCategory returns a boolean if a field has been set.

func (*ContentSearchResult) HasCombinedId 

func (o *ContentSearchResult) HasCombinedId() bool

HasCombinedId returns a boolean if a field has been set.

func (*ContentSearchResult) HasDescription 

func (o *ContentSearchResult) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*ContentSearchResult) HasFeaturedImageUrl 

func (o *ContentSearchResult) HasFeaturedImageUrl() bool

HasFeaturedImageUrl returns a boolean if a field has been set.

func (*ContentSearchResult) HasLanguage 

func (o *ContentSearchResult) HasLanguage() bool

HasLanguage returns a boolean if a field has been set.

func (*ContentSearchResult) HasPublishedDate 

func (o *ContentSearchResult) HasPublishedDate() bool

HasPublishedDate returns a boolean if a field has been set.

func (*ContentSearchResult) HasRowId 

func (o *ContentSearchResult) HasRowId() bool

HasRowId returns a boolean if a field has been set.

func (*ContentSearchResult) HasSubcategory 

func (o *ContentSearchResult) HasSubcategory() bool

HasSubcategory returns a boolean if a field has been set.

func (*ContentSearchResult) HasTableId 

func (o *ContentSearchResult) HasTableId() bool

HasTableId returns a boolean if a field has been set.

func (*ContentSearchResult) HasTags 

func (o *ContentSearchResult) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*ContentSearchResult) HasTitle 

func (o *ContentSearchResult) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (ContentSearchResult) MarshalJSON 

func (o ContentSearchResult) MarshalJSON() ([]byte, error)

func (*ContentSearchResult) SetAuthorFullName 

func (o *ContentSearchResult) SetAuthorFullName(v string)

SetAuthorFullName gets a reference to the given string and assigns it to the AuthorFullName field.

func (*ContentSearchResult) SetCategory 

func (o *ContentSearchResult) SetCategory(v string)

SetCategory gets a reference to the given string and assigns it to the Category field.

func (*ContentSearchResult) SetCombinedId 

func (o *ContentSearchResult) SetCombinedId(v string)

SetCombinedId gets a reference to the given string and assigns it to the CombinedId field.

func (*ContentSearchResult) SetDescription 

func (o *ContentSearchResult) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ContentSearchResult) SetDomain 

func (o *ContentSearchResult) SetDomain(v string)

SetDomain sets field value

func (*ContentSearchResult) SetFeaturedImageUrl 

func (o *ContentSearchResult) SetFeaturedImageUrl(v string)

SetFeaturedImageUrl gets a reference to the given string and assigns it to the FeaturedImageUrl field.

func (*ContentSearchResult) SetId 

func (o *ContentSearchResult) SetId(v int32)

SetId sets field value

func (*ContentSearchResult) SetLanguage 

func (o *ContentSearchResult) SetLanguage(v string)

SetLanguage gets a reference to the given string and assigns it to the Language field.

func (*ContentSearchResult) SetPublishedDate 

func (o *ContentSearchResult) SetPublishedDate(v int64)

SetPublishedDate gets a reference to the given int64 and assigns it to the PublishedDate field.

func (*ContentSearchResult) SetRowId 

func (o *ContentSearchResult) SetRowId(v int64)

SetRowId gets a reference to the given int64 and assigns it to the RowId field.

func (*ContentSearchResult) SetScore 

func (o *ContentSearchResult) SetScore(v float32)

SetScore sets field value

func (*ContentSearchResult) SetSubcategory 

func (o *ContentSearchResult) SetSubcategory(v string)

SetSubcategory gets a reference to the given string and assigns it to the Subcategory field.

func (*ContentSearchResult) SetTableId 

func (o *ContentSearchResult) SetTableId(v int64)

SetTableId gets a reference to the given int64 and assigns it to the TableId field.

func (*ContentSearchResult) SetTags 

func (o *ContentSearchResult) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*ContentSearchResult) SetTitle 

func (o *ContentSearchResult) SetTitle(v string)

SetTitle gets a reference to the given string and assigns it to the Title field.

func (*ContentSearchResult) SetType 

func (o *ContentSearchResult) SetType(v string)

SetType sets field value

func (*ContentSearchResult) SetUrl 

func (o *ContentSearchResult) SetUrl(v string)

SetUrl sets field value

type Error 

type Error struct {
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`
	// The error category
	Category string `json:"category"`
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// further information about the error
	Errors []ErrorDetail `json:"errors,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *map[string]string `json:"links,omitempty"`
}

Error struct for Error

func NewError 

func NewError(message string, correlationId string, category string) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetCategory 

func (o *Error) GetCategory() string

GetCategory returns the Category field value

func (*Error) GetCategoryOk 

func (o *Error) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field value and a boolean to check if the value has been set.

func (*Error) GetContext 

func (o *Error) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*Error) GetContextOk 

func (o *Error) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetCorrelationId 

func (o *Error) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value

func (*Error) GetCorrelationIdOk 

func (o *Error) GetCorrelationIdOk() (*string, bool)

GetCorrelationIdOk returns a tuple with the CorrelationId field value and a boolean to check if the value has been set.

func (*Error) GetErrors 

func (o *Error) GetErrors() []ErrorDetail

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Error) GetErrorsOk 

func (o *Error) GetErrorsOk() ([]ErrorDetail, bool)

GetErrorsOk returns a tuple with the Errors field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *Error) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*Error) GetLinksOk 

func (o *Error) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Error) GetSubCategory 

func (o *Error) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*Error) GetSubCategoryOk 

func (o *Error) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasContext 

func (o *Error) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Error) HasErrors 

func (o *Error) HasErrors() bool

HasErrors returns a boolean if a field has been set. 

func (o *Error) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*Error) HasSubCategory 

func (o *Error) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (Error) MarshalJSON 

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetCategory 

func (o *Error) SetCategory(v string)

SetCategory sets field value

func (*Error) SetContext 

func (o *Error) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*Error) SetCorrelationId 

func (o *Error) SetCorrelationId(v string)

SetCorrelationId sets field value

func (*Error) SetErrors 

func (o *Error) SetErrors(v []ErrorDetail)

SetErrors gets a reference to the given []ErrorDetail and assigns it to the Errors field. 

func (o *Error) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetSubCategory 

func (o *Error) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type ErrorDetail 

type ErrorDetail struct {
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
}

ErrorDetail struct for ErrorDetail

func NewErrorDetail 

func NewErrorDetail(message string) *ErrorDetail

NewErrorDetail instantiates a new ErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorDetailWithDefaults 

func NewErrorDetailWithDefaults() *ErrorDetail

NewErrorDetailWithDefaults instantiates a new ErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorDetail) GetCode 

func (o *ErrorDetail) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*ErrorDetail) GetCodeOk 

func (o *ErrorDetail) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetContext 

func (o *ErrorDetail) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*ErrorDetail) GetContextOk 

func (o *ErrorDetail) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetIn 

func (o *ErrorDetail) GetIn() string

GetIn returns the In field value if set, zero value otherwise.

func (*ErrorDetail) GetInOk 

func (o *ErrorDetail) GetInOk() (*string, bool)

GetInOk returns a tuple with the In field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetMessage 

func (o *ErrorDetail) GetMessage() string

GetMessage returns the Message field value

func (*ErrorDetail) GetMessageOk 

func (o *ErrorDetail) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*ErrorDetail) GetSubCategory 

func (o *ErrorDetail) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*ErrorDetail) GetSubCategoryOk 

func (o *ErrorDetail) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) HasCode 

func (o *ErrorDetail) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorDetail) HasContext 

func (o *ErrorDetail) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*ErrorDetail) HasIn 

func (o *ErrorDetail) HasIn() bool

HasIn returns a boolean if a field has been set.

func (*ErrorDetail) HasSubCategory 

func (o *ErrorDetail) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (ErrorDetail) MarshalJSON 

func (o ErrorDetail) MarshalJSON() ([]byte, error)

func (*ErrorDetail) SetCode 

func (o *ErrorDetail) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*ErrorDetail) SetContext 

func (o *ErrorDetail) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*ErrorDetail) SetIn 

func (o *ErrorDetail) SetIn(v string)

SetIn gets a reference to the given string and assigns it to the In field.

func (*ErrorDetail) SetMessage 

func (o *ErrorDetail) SetMessage(v string)

SetMessage sets field value

func (*ErrorDetail) SetSubCategory 

func (o *ErrorDetail) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type IndexedData 

type IndexedData struct {
	// The ID of the document in HubSpot.
	Id string `json:"id"`
	// The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
	Type string `json:"type"`
	// The indexed fields in HubSpot.
	Fields map[string]IndexedField `json:"fields"`
}

IndexedData The indexed data in HubSpot

func NewIndexedData 

func NewIndexedData(id string, type_ string, fields map[string]IndexedField) *IndexedData

NewIndexedData instantiates a new IndexedData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIndexedDataWithDefaults 

func NewIndexedDataWithDefaults() *IndexedData

NewIndexedDataWithDefaults instantiates a new IndexedData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexedData) GetFields 

func (o *IndexedData) GetFields() map[string]IndexedField

GetFields returns the Fields field value

func (*IndexedData) GetFieldsOk 

func (o *IndexedData) GetFieldsOk() (*map[string]IndexedField, bool)

GetFieldsOk returns a tuple with the Fields field value and a boolean to check if the value has been set.

func (*IndexedData) GetId 

func (o *IndexedData) GetId() string

GetId returns the Id field value

func (*IndexedData) GetIdOk 

func (o *IndexedData) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*IndexedData) GetType 

func (o *IndexedData) GetType() string

GetType returns the Type field value

func (*IndexedData) GetTypeOk 

func (o *IndexedData) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (IndexedData) MarshalJSON 

func (o IndexedData) MarshalJSON() ([]byte, error)

func (*IndexedData) SetFields 

func (o *IndexedData) SetFields(v map[string]IndexedField)

SetFields sets field value

func (*IndexedData) SetId 

func (o *IndexedData) SetId(v string)

SetId sets field value

func (*IndexedData) SetType 

func (o *IndexedData) SetType(v string)

SetType sets field value

type IndexedField 

type IndexedField struct {
	Name          string                   `json:"name"`
	Value         map[string]interface{}   `json:"value"`
	Values        []map[string]interface{} `json:"values"`
	MetadataField bool                     `json:"metadataField"`
}

IndexedField struct for IndexedField

func NewIndexedField 

func NewIndexedField(name string, value map[string]interface{}, values []map[string]interface{}, metadataField bool) *IndexedField

NewIndexedField instantiates a new IndexedField object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIndexedFieldWithDefaults 

func NewIndexedFieldWithDefaults() *IndexedField

NewIndexedFieldWithDefaults instantiates a new IndexedField object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexedField) GetMetadataField 

func (o *IndexedField) GetMetadataField() bool

GetMetadataField returns the MetadataField field value

func (*IndexedField) GetMetadataFieldOk 

func (o *IndexedField) GetMetadataFieldOk() (*bool, bool)

GetMetadataFieldOk returns a tuple with the MetadataField field value and a boolean to check if the value has been set.

func (*IndexedField) GetName 

func (o *IndexedField) GetName() string

GetName returns the Name field value

func (*IndexedField) GetNameOk 

func (o *IndexedField) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*IndexedField) GetValue 

func (o *IndexedField) GetValue() map[string]interface{}

GetValue returns the Value field value

func (*IndexedField) GetValueOk 

func (o *IndexedField) GetValueOk() (map[string]interface{}, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (*IndexedField) GetValues 

func (o *IndexedField) GetValues() []map[string]interface{}

GetValues returns the Values field value

func (*IndexedField) GetValuesOk 

func (o *IndexedField) GetValuesOk() ([]map[string]interface{}, bool)

GetValuesOk returns a tuple with the Values field value and a boolean to check if the value has been set.

func (IndexedField) MarshalJSON 

func (o IndexedField) MarshalJSON() ([]byte, error)

func (*IndexedField) SetMetadataField 

func (o *IndexedField) SetMetadataField(v bool)

SetMetadataField sets field value

func (*IndexedField) SetName 

func (o *IndexedField) SetName(v string)

SetName sets field value

func (*IndexedField) SetValue 

func (o *IndexedField) SetValue(v map[string]interface{})

SetValue sets field value

func (*IndexedField) SetValues 

func (o *IndexedField) SetValues(v []map[string]interface{})

SetValues sets field value

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableContentSearchResult 

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

func NewNullableContentSearchResult 

func NewNullableContentSearchResult(val *ContentSearchResult) *NullableContentSearchResult

func (NullableContentSearchResult) Get 

func (v NullableContentSearchResult) Get() *ContentSearchResult

func (NullableContentSearchResult) IsSet 

func (v NullableContentSearchResult) IsSet() bool

func (NullableContentSearchResult) MarshalJSON 

func (v NullableContentSearchResult) MarshalJSON() ([]byte, error)

func (*NullableContentSearchResult) Set 

func (v *NullableContentSearchResult) Set(val *ContentSearchResult)

func (*NullableContentSearchResult) UnmarshalJSON 

func (v *NullableContentSearchResult) UnmarshalJSON(src []byte) error

func (*NullableContentSearchResult) Unset 

func (v *NullableContentSearchResult) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorDetail 

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

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

func (NullableErrorDetail) IsSet 

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON 

func (v NullableErrorDetail) MarshalJSON() ([]byte, error)

func (*NullableErrorDetail) Set 

func (v *NullableErrorDetail) Set(val *ErrorDetail)

func (*NullableErrorDetail) UnmarshalJSON 

func (v *NullableErrorDetail) UnmarshalJSON(src []byte) error

func (*NullableErrorDetail) Unset 

func (v *NullableErrorDetail) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableIndexedData 

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

func NewNullableIndexedData 

func NewNullableIndexedData(val *IndexedData) *NullableIndexedData

func (NullableIndexedData) Get 

func (v NullableIndexedData) Get() *IndexedData

func (NullableIndexedData) IsSet 

func (v NullableIndexedData) IsSet() bool

func (NullableIndexedData) MarshalJSON 

func (v NullableIndexedData) MarshalJSON() ([]byte, error)

func (*NullableIndexedData) Set 

func (v *NullableIndexedData) Set(val *IndexedData)

func (*NullableIndexedData) UnmarshalJSON 

func (v *NullableIndexedData) UnmarshalJSON(src []byte) error

func (*NullableIndexedData) Unset 

func (v *NullableIndexedData) Unset()

type NullableIndexedField 

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

func NewNullableIndexedField 

func NewNullableIndexedField(val *IndexedField) *NullableIndexedField

func (NullableIndexedField) Get 

func (v NullableIndexedField) Get() *IndexedField

func (NullableIndexedField) IsSet 

func (v NullableIndexedField) IsSet() bool

func (NullableIndexedField) MarshalJSON 

func (v NullableIndexedField) MarshalJSON() ([]byte, error)

func (*NullableIndexedField) Set 

func (v *NullableIndexedField) Set(val *IndexedField)

func (*NullableIndexedField) UnmarshalJSON 

func (v *NullableIndexedField) UnmarshalJSON(src []byte) error

func (*NullableIndexedField) Unset 

func (v *NullableIndexedField) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullablePublicSearchResults 

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

func NewNullablePublicSearchResults 

func NewNullablePublicSearchResults(val *PublicSearchResults) *NullablePublicSearchResults

func (NullablePublicSearchResults) Get 

func (v NullablePublicSearchResults) Get() *PublicSearchResults

func (NullablePublicSearchResults) IsSet 

func (v NullablePublicSearchResults) IsSet() bool

func (NullablePublicSearchResults) MarshalJSON 

func (v NullablePublicSearchResults) MarshalJSON() ([]byte, error)

func (*NullablePublicSearchResults) Set 

func (v *NullablePublicSearchResults) Set(val *PublicSearchResults)

func (*NullablePublicSearchResults) UnmarshalJSON 

func (v *NullablePublicSearchResults) UnmarshalJSON(src []byte) error

func (*NullablePublicSearchResults) Unset 

func (v *NullablePublicSearchResults) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type PublicApiService 

type PublicApiService service

PublicApiService PublicApi service

func (*PublicApiService) GetByID 

func (a *PublicApiService) GetByID(ctx context.Context, contentId string) ApiGetByIDRequest

GetByID Get indexed properties.

For a given account and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contentId ID of the target document when searching for indexed properties.
@return ApiGetByIDRequest

func (*PublicApiService) GetByIDExecute 

func (a *PublicApiService) GetByIDExecute(r ApiGetByIDRequest) (*IndexedData, *http.Response, error)

Execute executes the request 

@return IndexedData

func (*PublicApiService) Search 

func (a *PublicApiService) Search(ctx context.Context) ApiSearchRequest

Search Search your site.

Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiSearchRequest

func (*PublicApiService) SearchExecute 

func (a *PublicApiService) SearchExecute(r ApiSearchRequest) (*PublicSearchResults, *http.Response, error)

Execute executes the request 

@return PublicSearchResults

type PublicSearchResults 

type PublicSearchResults struct {
	Total      int32                 `json:"total"`
	Offset     int32                 `json:"offset"`
	Limit      int32                 `json:"limit"`
	Results    []ContentSearchResult `json:"results"`
	SearchTerm *string               `json:"searchTerm,omitempty"`
	Page       int32                 `json:"page"`
}

PublicSearchResults struct for PublicSearchResults

func NewPublicSearchResults 

func NewPublicSearchResults(total int32, offset int32, limit int32, results []ContentSearchResult, page int32) *PublicSearchResults

NewPublicSearchResults instantiates a new PublicSearchResults object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPublicSearchResultsWithDefaults 

func NewPublicSearchResultsWithDefaults() *PublicSearchResults

NewPublicSearchResultsWithDefaults instantiates a new PublicSearchResults object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PublicSearchResults) GetLimit 

func (o *PublicSearchResults) GetLimit() int32

GetLimit returns the Limit field value

func (*PublicSearchResults) GetLimitOk 

func (o *PublicSearchResults) GetLimitOk() (*int32, bool)

GetLimitOk returns a tuple with the Limit field value and a boolean to check if the value has been set.

func (*PublicSearchResults) GetOffset 

func (o *PublicSearchResults) GetOffset() int32

GetOffset returns the Offset field value

func (*PublicSearchResults) GetOffsetOk 

func (o *PublicSearchResults) GetOffsetOk() (*int32, bool)

GetOffsetOk returns a tuple with the Offset field value and a boolean to check if the value has been set.

func (*PublicSearchResults) GetPage 

func (o *PublicSearchResults) GetPage() int32

GetPage returns the Page field value

func (*PublicSearchResults) GetPageOk 

func (o *PublicSearchResults) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value and a boolean to check if the value has been set.

func (*PublicSearchResults) GetResults 

func (o *PublicSearchResults) GetResults() []ContentSearchResult

GetResults returns the Results field value

func (*PublicSearchResults) GetResultsOk 

func (o *PublicSearchResults) GetResultsOk() ([]ContentSearchResult, bool)

GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.

func (*PublicSearchResults) GetSearchTerm 

func (o *PublicSearchResults) GetSearchTerm() string

GetSearchTerm returns the SearchTerm field value if set, zero value otherwise.

func (*PublicSearchResults) GetSearchTermOk 

func (o *PublicSearchResults) GetSearchTermOk() (*string, bool)

GetSearchTermOk returns a tuple with the SearchTerm field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSearchResults) GetTotal 

func (o *PublicSearchResults) GetTotal() int32

GetTotal returns the Total field value

func (*PublicSearchResults) GetTotalOk 

func (o *PublicSearchResults) GetTotalOk() (*int32, bool)

GetTotalOk returns a tuple with the Total field value and a boolean to check if the value has been set.

func (*PublicSearchResults) HasSearchTerm 

func (o *PublicSearchResults) HasSearchTerm() bool

HasSearchTerm returns a boolean if a field has been set.

func (PublicSearchResults) MarshalJSON 

func (o PublicSearchResults) MarshalJSON() ([]byte, error)

func (*PublicSearchResults) SetLimit 

func (o *PublicSearchResults) SetLimit(v int32)

SetLimit sets field value

func (*PublicSearchResults) SetOffset 

func (o *PublicSearchResults) SetOffset(v int32)

SetOffset sets field value

func (*PublicSearchResults) SetPage 

func (o *PublicSearchResults) SetPage(v int32)

SetPage sets field value

func (*PublicSearchResults) SetResults 

func (o *PublicSearchResults) SetResults(v []ContentSearchResult)

SetResults sets field value

func (*PublicSearchResults) SetSearchTerm 

func (o *PublicSearchResults) SetSearchTerm(v string)

SetSearchTerm gets a reference to the given string and assigns it to the SearchTerm field.

func (*PublicSearchResults) SetTotal 

func (o *PublicSearchResults) SetTotal(v int32)

SetTotal sets field value

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Source Files

View all Source files

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.