suggestions

package
v4.10.2 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var AllowedLogLevelEnumValues = []LogLevel{
	"SKIP",
	"INFO",
	"ERROR",
}

All allowed values of LogLevel enum.

Functions

func WithContext 

func WithContext(ctx context.Context) requestOption

func WithHeaderParam 

func WithHeaderParam(key string, value any) requestOption

func WithQueryParam 

func WithQueryParam(key string, value any) requestOption

Types

type APIClient 

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

APIClient manages communication with the Query Suggestions API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewClient 

func NewClient(appID, apiKey string, region Region) (*APIClient, error)

NewClient creates a new API client with appID, apiKey and region.

func NewClientWithConfig 

func NewClientWithConfig(cfg QuerySuggestionsConfiguration) (*APIClient, error)

NewClientWithConfig creates a new API client with the given configuration to fully customize the client behaviour.

func (*APIClient) AddDefaultHeader 

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

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

func (*APIClient) CreateConfig 

func (c *APIClient) CreateConfig(r ApiCreateConfigRequest, opts ...RequestOption) (*BaseResponse, error)

CreateConfig casts the HTTP response body to a defined struct.

Creates a new Query Suggestions configuration.

You can have up to 100 configurations per Algolia application.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiCreateConfigRequest with parameters below. 

@param configurationWithIndex ConfigurationWithIndex
@return BaseResponse

func (*APIClient) CreateConfigWithHTTPInfo 

func (c *APIClient) CreateConfigWithHTTPInfo(r ApiCreateConfigRequest, opts ...RequestOption) (*http.Response, []byte, error)

CreateConfig calls the API and returns the raw response from it. 

Creates a new Query Suggestions configuration.

You can have up to 100 configurations per Algolia application. 

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiCreateConfigRequest with parameters below.
  @param configurationWithIndex ConfigurationWithIndex
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomDelete 

func (c *APIClient) CustomDelete(r ApiCustomDeleteRequest, opts ...RequestOption) (*map[string]any, error)

CustomDelete casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomDeleteWithHTTPInfo 

func (c *APIClient) CustomDeleteWithHTTPInfo(r ApiCustomDeleteRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomDelete calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomGet 

func (c *APIClient) CustomGet(r ApiCustomGetRequest, opts ...RequestOption) (*map[string]any, error)

CustomGet casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomGetWithHTTPInfo 

func (c *APIClient) CustomGetWithHTTPInfo(r ApiCustomGetRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomGet calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPost 

func (c *APIClient) CustomPost(r ApiCustomPostRequest, opts ...RequestOption) (*map[string]any, error)

CustomPost casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPostWithHTTPInfo 

func (c *APIClient) CustomPostWithHTTPInfo(r ApiCustomPostRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPost calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPut 

func (c *APIClient) CustomPut(r ApiCustomPutRequest, opts ...RequestOption) (*map[string]any, error)

CustomPut casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPutWithHTTPInfo 

func (c *APIClient) CustomPutWithHTTPInfo(r ApiCustomPutRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPut calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) DeleteConfig 

func (c *APIClient) DeleteConfig(r ApiDeleteConfigRequest, opts ...RequestOption) (*BaseResponse, error)

DeleteConfig casts the HTTP response body to a defined struct.

Deletes a Query Suggestions configuration.

Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiDeleteConfigRequest with parameters below. 

@param indexName string - Query Suggestions index name.
@return BaseResponse

func (*APIClient) DeleteConfigWithHTTPInfo 

func (c *APIClient) DeleteConfigWithHTTPInfo(r ApiDeleteConfigRequest, opts ...RequestOption) (*http.Response, []byte, error)

DeleteConfig calls the API and returns the raw response from it. 

Deletes a Query Suggestions configuration.

Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation. 

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiDeleteConfigRequest with parameters below.
  @param indexName string - Query Suggestions index name.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetAllConfigs 

func (c *APIClient) GetAllConfigs(opts ...RequestOption) ([]ConfigurationResponse, error)

GetAllConfigs casts the HTTP response body to a defined struct.

Retrieves all Query Suggestions configurations of your Algolia application.

Required API Key ACLs:

  • settings

Request can be constructed by NewApiGetAllConfigsRequest with parameters below. 

@return []ConfigurationResponse

func (*APIClient) GetAllConfigsWithHTTPInfo 

func (c *APIClient) GetAllConfigsWithHTTPInfo(opts ...RequestOption) (*http.Response, []byte, error)

GetAllConfigs calls the API and returns the raw response from it. 

  Retrieves all Query Suggestions configurations of your Algolia application.

    Required API Key ACLs:
    - settings

Request can be constructed by NewApiGetAllConfigsRequest with parameters below.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig(r ApiGetConfigRequest, opts ...RequestOption) (*ConfigurationResponse, error)

GetConfig casts the HTTP response body to a defined struct.

Retrieves a single Query Suggestions configuration by its index name.

Required API Key ACLs:

  • settings

Request can be constructed by NewApiGetConfigRequest with parameters below. 

@param indexName string - Query Suggestions index name.
@return ConfigurationResponse

func (*APIClient) GetConfigStatus 

func (c *APIClient) GetConfigStatus(r ApiGetConfigStatusRequest, opts ...RequestOption) (*ConfigStatus, error)

GetConfigStatus casts the HTTP response body to a defined struct.

Reports the status of a Query Suggestions index.

Required API Key ACLs:

  • settings

Request can be constructed by NewApiGetConfigStatusRequest with parameters below. 

@param indexName string - Query Suggestions index name.
@return ConfigStatus

func (*APIClient) GetConfigStatusWithHTTPInfo 

func (c *APIClient) GetConfigStatusWithHTTPInfo(r ApiGetConfigStatusRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetConfigStatus calls the API and returns the raw response from it. 

  Reports the status of a Query Suggestions index.

    Required API Key ACLs:
    - settings

Request can be constructed by NewApiGetConfigStatusRequest with parameters below.
  @param indexName string - Query Suggestions index name.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetConfigWithHTTPInfo 

func (c *APIClient) GetConfigWithHTTPInfo(r ApiGetConfigRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetConfig calls the API and returns the raw response from it. 

  Retrieves a single Query Suggestions configuration by its index name.

    Required API Key ACLs:
    - settings

Request can be constructed by NewApiGetConfigRequest with parameters below.
  @param indexName string - Query Suggestions index name.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetConfiguration 

func (c *APIClient) GetConfiguration() *QuerySuggestionsConfiguration

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

func (*APIClient) GetLogFile 

func (c *APIClient) GetLogFile(r ApiGetLogFileRequest, opts ...RequestOption) (*LogFile, error)

GetLogFile casts the HTTP response body to a defined struct.

Retrieves the logs for a single Query Suggestions index.

Required API Key ACLs:

  • settings

Request can be constructed by NewApiGetLogFileRequest with parameters below. 

@param indexName string - Query Suggestions index name.
@return LogFile

func (*APIClient) GetLogFileWithHTTPInfo 

func (c *APIClient) GetLogFileWithHTTPInfo(r ApiGetLogFileRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetLogFile calls the API and returns the raw response from it. 

  Retrieves the logs for a single Query Suggestions index.

    Required API Key ACLs:
    - settings

Request can be constructed by NewApiGetLogFileRequest with parameters below.
  @param indexName string - Query Suggestions index name.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) NewApiCreateConfigRequest 

func (c *APIClient) NewApiCreateConfigRequest(configurationWithIndex *ConfigurationWithIndex) ApiCreateConfigRequest

NewApiCreateConfigRequest creates an instance of the ApiCreateConfigRequest to be used for the API call.

func (*APIClient) NewApiCustomDeleteRequest 

func (c *APIClient) NewApiCustomDeleteRequest(path string) ApiCustomDeleteRequest

NewApiCustomDeleteRequest creates an instance of the ApiCustomDeleteRequest to be used for the API call.

func (*APIClient) NewApiCustomGetRequest 

func (c *APIClient) NewApiCustomGetRequest(path string) ApiCustomGetRequest

NewApiCustomGetRequest creates an instance of the ApiCustomGetRequest to be used for the API call.

func (*APIClient) NewApiCustomPostRequest 

func (c *APIClient) NewApiCustomPostRequest(path string) ApiCustomPostRequest

NewApiCustomPostRequest creates an instance of the ApiCustomPostRequest to be used for the API call.

func (*APIClient) NewApiCustomPutRequest 

func (c *APIClient) NewApiCustomPutRequest(path string) ApiCustomPutRequest

NewApiCustomPutRequest creates an instance of the ApiCustomPutRequest to be used for the API call.

func (*APIClient) NewApiDeleteConfigRequest 

func (c *APIClient) NewApiDeleteConfigRequest(indexName string) ApiDeleteConfigRequest

NewApiDeleteConfigRequest creates an instance of the ApiDeleteConfigRequest to be used for the API call.

func (*APIClient) NewApiGetConfigRequest 

func (c *APIClient) NewApiGetConfigRequest(indexName string) ApiGetConfigRequest

NewApiGetConfigRequest creates an instance of the ApiGetConfigRequest to be used for the API call.

func (*APIClient) NewApiGetConfigStatusRequest 

func (c *APIClient) NewApiGetConfigStatusRequest(indexName string) ApiGetConfigStatusRequest

NewApiGetConfigStatusRequest creates an instance of the ApiGetConfigStatusRequest to be used for the API call.

func (*APIClient) NewApiGetLogFileRequest 

func (c *APIClient) NewApiGetLogFileRequest(indexName string) ApiGetLogFileRequest

NewApiGetLogFileRequest creates an instance of the ApiGetLogFileRequest to be used for the API call.

func (*APIClient) NewApiUpdateConfigRequest 

func (c *APIClient) NewApiUpdateConfigRequest(indexName string, configuration *Configuration) ApiUpdateConfigRequest

NewApiUpdateConfigRequest creates an instance of the ApiUpdateConfigRequest to be used for the API call.

func (*APIClient) SetClientApiKey added in v4.3.0 

func (c *APIClient) SetClientApiKey(apiKey string) error

Allow update of stored API key used to authenticate requests.

func (*APIClient) UpdateConfig 

func (c *APIClient) UpdateConfig(r ApiUpdateConfigRequest, opts ...RequestOption) (*BaseResponse, error)

UpdateConfig casts the HTTP response body to a defined struct.

Updates a QuerySuggestions configuration.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiUpdateConfigRequest with parameters below. 

@param indexName string - Query Suggestions index name.
@param configuration Configuration
@return BaseResponse

func (*APIClient) UpdateConfigWithHTTPInfo 

func (c *APIClient) UpdateConfigWithHTTPInfo(r ApiUpdateConfigRequest, opts ...RequestOption) (*http.Response, []byte, error)

UpdateConfig calls the API and returns the raw response from it. 

  Updates a QuerySuggestions configuration.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiUpdateConfigRequest with parameters below.
  @param indexName string - Query Suggestions index name.
  @param configuration Configuration
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

type APIError 

type APIError struct {
	Message              string
	Status               int
	AdditionalProperties map[string]any
}

func (APIError) Error 

func (e APIError) Error() string

func (APIError) MarshalJSON added in v4.8.0 

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

func (*APIError) UnmarshalJSON added in v4.8.0 

func (o *APIError) UnmarshalJSON(bytes []byte) error

type ApiCreateConfigRequest 

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

ApiCreateConfigRequest represents the request with all the parameters for the API call.

func (*ApiCreateConfigRequest) UnmarshalJSON 

func (r *ApiCreateConfigRequest) UnmarshalJSON(b []byte) error

type ApiCustomDeleteRequest 

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

ApiCustomDeleteRequest represents the request with all the parameters for the API call.

func (*ApiCustomDeleteRequest) UnmarshalJSON 

func (r *ApiCustomDeleteRequest) UnmarshalJSON(b []byte) error

func (ApiCustomDeleteRequest) WithParameters 

func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCustomDeleteRequest

WithParameters adds the parameters to the ApiCustomDeleteRequest and returns the request for chaining.

type ApiCustomGetRequest 

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

ApiCustomGetRequest represents the request with all the parameters for the API call.

func (*ApiCustomGetRequest) UnmarshalJSON 

func (r *ApiCustomGetRequest) UnmarshalJSON(b []byte) error

func (ApiCustomGetRequest) WithParameters 

func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustomGetRequest

WithParameters adds the parameters to the ApiCustomGetRequest and returns the request for chaining.

type ApiCustomPostRequest 

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

ApiCustomPostRequest represents the request with all the parameters for the API call.

func (*ApiCustomPostRequest) UnmarshalJSON 

func (r *ApiCustomPostRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPostRequest) WithBody 

func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest

WithBody adds the body to the ApiCustomPostRequest and returns the request for chaining.

func (ApiCustomPostRequest) WithParameters 

func (r ApiCustomPostRequest) WithParameters(parameters map[string]any) ApiCustomPostRequest

WithParameters adds the parameters to the ApiCustomPostRequest and returns the request for chaining.

type ApiCustomPutRequest 

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

ApiCustomPutRequest represents the request with all the parameters for the API call.

func (*ApiCustomPutRequest) UnmarshalJSON 

func (r *ApiCustomPutRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPutRequest) WithBody 

func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest

WithBody adds the body to the ApiCustomPutRequest and returns the request for chaining.

func (ApiCustomPutRequest) WithParameters 

func (r ApiCustomPutRequest) WithParameters(parameters map[string]any) ApiCustomPutRequest

WithParameters adds the parameters to the ApiCustomPutRequest and returns the request for chaining.

type ApiDeleteConfigRequest 

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

ApiDeleteConfigRequest represents the request with all the parameters for the API call.

func (*ApiDeleteConfigRequest) UnmarshalJSON 

func (r *ApiDeleteConfigRequest) UnmarshalJSON(b []byte) error

type ApiGetConfigRequest 

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

ApiGetConfigRequest represents the request with all the parameters for the API call.

func (*ApiGetConfigRequest) UnmarshalJSON 

func (r *ApiGetConfigRequest) UnmarshalJSON(b []byte) error

type ApiGetConfigStatusRequest 

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

ApiGetConfigStatusRequest represents the request with all the parameters for the API call.

func (*ApiGetConfigStatusRequest) UnmarshalJSON 

func (r *ApiGetConfigStatusRequest) UnmarshalJSON(b []byte) error

type ApiGetLogFileRequest 

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

ApiGetLogFileRequest represents the request with all the parameters for the API call.

func (*ApiGetLogFileRequest) UnmarshalJSON 

func (r *ApiGetLogFileRequest) UnmarshalJSON(b []byte) error

type ApiUpdateConfigRequest 

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

ApiUpdateConfigRequest represents the request with all the parameters for the API call.

func (*ApiUpdateConfigRequest) UnmarshalJSON 

func (r *ApiUpdateConfigRequest) UnmarshalJSON(b []byte) error

type BaseResponse 

type BaseResponse struct {
	// HTTP status code.
	Status *int32 `json:"status,omitempty"`
	// Details about the response, such as error messages.
	Message *string `json:"message,omitempty"`
}

BaseResponse struct for BaseResponse.

func NewBaseResponse 

func NewBaseResponse(opts ...BaseResponseOption) *BaseResponse

NewBaseResponse instantiates a new BaseResponse 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 NewEmptyBaseResponse 

func NewEmptyBaseResponse() *BaseResponse

NewEmptyBaseResponse return a pointer to an empty BaseResponse object.

func (*BaseResponse) GetMessage 

func (o *BaseResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*BaseResponse) GetMessageOk 

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

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

func (*BaseResponse) GetStatus 

func (o *BaseResponse) GetStatus() int32

GetStatus returns the Status field value if set, zero value otherwise.

func (*BaseResponse) GetStatusOk 

func (o *BaseResponse) GetStatusOk() (*int32, bool)

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

func (*BaseResponse) HasMessage 

func (o *BaseResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*BaseResponse) HasStatus 

func (o *BaseResponse) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (BaseResponse) MarshalJSON 

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

func (*BaseResponse) SetMessage 

func (o *BaseResponse) SetMessage(v string) *BaseResponse

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*BaseResponse) SetStatus 

func (o *BaseResponse) SetStatus(v int32) *BaseResponse

SetStatus gets a reference to the given int32 and assigns it to the Status field.

func (BaseResponse) String 

func (o BaseResponse) String() string

type BaseResponseOption 

type BaseResponseOption func(f *BaseResponse)

func WithBaseResponseMessage 

func WithBaseResponseMessage(val string) BaseResponseOption

func WithBaseResponseStatus 

func WithBaseResponseStatus(val int32) BaseResponseOption

type ConfigStatus 

type ConfigStatus struct {
	// Name of the Query Suggestions index (case-sensitive).
	IndexName *string `json:"indexName,omitempty"`
	// Whether the creation or update of the Query Suggestions index is in progress.
	IsRunning *bool `json:"isRunning,omitempty"`
	// Date and time when the Query Suggestions index was last built, in RFC 3339 format.
	LastBuiltAt *string `json:"lastBuiltAt,omitempty"`
	// Date and time when the Query Suggestions index was last updated successfully.
	LastSuccessfulBuiltAt *string `json:"lastSuccessfulBuiltAt,omitempty"`
	// Duration of the last successful build in seconds.
	LastSuccessfulBuildDuration *string `json:"lastSuccessfulBuildDuration,omitempty"`
}

ConfigStatus struct for ConfigStatus.

func NewConfigStatus 

func NewConfigStatus(opts ...ConfigStatusOption) *ConfigStatus

NewConfigStatus instantiates a new ConfigStatus 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 NewEmptyConfigStatus 

func NewEmptyConfigStatus() *ConfigStatus

NewEmptyConfigStatus return a pointer to an empty ConfigStatus object.

func (*ConfigStatus) GetIndexName 

func (o *ConfigStatus) GetIndexName() string

GetIndexName returns the IndexName field value if set, zero value otherwise.

func (*ConfigStatus) GetIndexNameOk 

func (o *ConfigStatus) GetIndexNameOk() (*string, bool)

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

func (*ConfigStatus) GetIsRunning 

func (o *ConfigStatus) GetIsRunning() bool

GetIsRunning returns the IsRunning field value if set, zero value otherwise.

func (*ConfigStatus) GetIsRunningOk 

func (o *ConfigStatus) GetIsRunningOk() (*bool, bool)

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

func (*ConfigStatus) GetLastBuiltAt 

func (o *ConfigStatus) GetLastBuiltAt() string

GetLastBuiltAt returns the LastBuiltAt field value if set, zero value otherwise.

func (*ConfigStatus) GetLastBuiltAtOk 

func (o *ConfigStatus) GetLastBuiltAtOk() (*string, bool)

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

func (*ConfigStatus) GetLastSuccessfulBuildDuration 

func (o *ConfigStatus) GetLastSuccessfulBuildDuration() string

GetLastSuccessfulBuildDuration returns the LastSuccessfulBuildDuration field value if set, zero value otherwise.

func (*ConfigStatus) GetLastSuccessfulBuildDurationOk 

func (o *ConfigStatus) GetLastSuccessfulBuildDurationOk() (*string, bool)

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

func (*ConfigStatus) GetLastSuccessfulBuiltAt 

func (o *ConfigStatus) GetLastSuccessfulBuiltAt() string

GetLastSuccessfulBuiltAt returns the LastSuccessfulBuiltAt field value if set, zero value otherwise.

func (*ConfigStatus) GetLastSuccessfulBuiltAtOk 

func (o *ConfigStatus) GetLastSuccessfulBuiltAtOk() (*string, bool)

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

func (*ConfigStatus) HasIndexName 

func (o *ConfigStatus) HasIndexName() bool

HasIndexName returns a boolean if a field has been set.

func (*ConfigStatus) HasIsRunning 

func (o *ConfigStatus) HasIsRunning() bool

HasIsRunning returns a boolean if a field has been set.

func (*ConfigStatus) HasLastBuiltAt 

func (o *ConfigStatus) HasLastBuiltAt() bool

HasLastBuiltAt returns a boolean if a field has been set.

func (*ConfigStatus) HasLastSuccessfulBuildDuration 

func (o *ConfigStatus) HasLastSuccessfulBuildDuration() bool

HasLastSuccessfulBuildDuration returns a boolean if a field has been set.

func (*ConfigStatus) HasLastSuccessfulBuiltAt 

func (o *ConfigStatus) HasLastSuccessfulBuiltAt() bool

HasLastSuccessfulBuiltAt returns a boolean if a field has been set.

func (ConfigStatus) MarshalJSON 

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

func (*ConfigStatus) SetIndexName 

func (o *ConfigStatus) SetIndexName(v string) *ConfigStatus

SetIndexName gets a reference to the given string and assigns it to the IndexName field.

func (*ConfigStatus) SetIsRunning 

func (o *ConfigStatus) SetIsRunning(v bool) *ConfigStatus

SetIsRunning gets a reference to the given bool and assigns it to the IsRunning field.

func (*ConfigStatus) SetLastBuiltAt 

func (o *ConfigStatus) SetLastBuiltAt(v string) *ConfigStatus

SetLastBuiltAt gets a reference to the given string and assigns it to the LastBuiltAt field.

func (*ConfigStatus) SetLastSuccessfulBuildDuration 

func (o *ConfigStatus) SetLastSuccessfulBuildDuration(v string) *ConfigStatus

SetLastSuccessfulBuildDuration gets a reference to the given string and assigns it to the LastSuccessfulBuildDuration field.

func (*ConfigStatus) SetLastSuccessfulBuiltAt 

func (o *ConfigStatus) SetLastSuccessfulBuiltAt(v string) *ConfigStatus

SetLastSuccessfulBuiltAt gets a reference to the given string and assigns it to the LastSuccessfulBuiltAt field.

func (ConfigStatus) String 

func (o ConfigStatus) String() string

type ConfigStatusOption 

type ConfigStatusOption func(f *ConfigStatus)

func WithConfigStatusIndexName 

func WithConfigStatusIndexName(val string) ConfigStatusOption

func WithConfigStatusIsRunning 

func WithConfigStatusIsRunning(val bool) ConfigStatusOption

func WithConfigStatusLastBuiltAt 

func WithConfigStatusLastBuiltAt(val string) ConfigStatusOption

func WithConfigStatusLastSuccessfulBuildDuration 

func WithConfigStatusLastSuccessfulBuildDuration(val string) ConfigStatusOption

func WithConfigStatusLastSuccessfulBuiltAt 

func WithConfigStatusLastSuccessfulBuiltAt(val string) ConfigStatusOption

type Configuration 

type Configuration struct {
	// Algolia indices from which to get the popular searches for query suggestions.
	SourceIndices []SourceIndex `json:"sourceIndices"`
	Languages     *Languages    `json:"languages,omitempty"`
	Exclude       []string      `json:"exclude,omitempty"`
	// Whether to turn on personalized query suggestions.
	EnablePersonalization *bool `json:"enablePersonalization,omitempty"`
	// Whether to include suggestions with special characters.
	AllowSpecialCharacters *bool `json:"allowSpecialCharacters,omitempty"`
}

Configuration Query Suggestions configuration.

func NewConfiguration 

func NewConfiguration(sourceIndices []SourceIndex, opts ...ConfigurationOption) *Configuration

NewConfiguration instantiates a new Configuration 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 NewEmptyConfiguration 

func NewEmptyConfiguration() *Configuration

NewEmptyConfiguration return a pointer to an empty Configuration object.

func (*Configuration) GetAllowSpecialCharacters 

func (o *Configuration) GetAllowSpecialCharacters() bool

GetAllowSpecialCharacters returns the AllowSpecialCharacters field value if set, zero value otherwise.

func (*Configuration) GetAllowSpecialCharactersOk 

func (o *Configuration) GetAllowSpecialCharactersOk() (*bool, bool)

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

func (*Configuration) GetEnablePersonalization 

func (o *Configuration) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value if set, zero value otherwise.

func (*Configuration) GetEnablePersonalizationOk 

func (o *Configuration) GetEnablePersonalizationOk() (*bool, bool)

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

func (*Configuration) GetExclude 

func (o *Configuration) GetExclude() []string

GetExclude returns the Exclude field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Configuration) GetExcludeOk 

func (o *Configuration) GetExcludeOk() ([]string, bool)

GetExcludeOk returns a tuple with the Exclude field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*Configuration) GetLanguages 

func (o *Configuration) GetLanguages() Languages

GetLanguages returns the Languages field value if set, zero value otherwise.

func (*Configuration) GetLanguagesOk 

func (o *Configuration) GetLanguagesOk() (*Languages, bool)

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

func (*Configuration) GetSourceIndices 

func (o *Configuration) GetSourceIndices() []SourceIndex

GetSourceIndices returns the SourceIndices field value.

func (*Configuration) GetSourceIndicesOk 

func (o *Configuration) GetSourceIndicesOk() ([]SourceIndex, bool)

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

func (*Configuration) HasAllowSpecialCharacters 

func (o *Configuration) HasAllowSpecialCharacters() bool

HasAllowSpecialCharacters returns a boolean if a field has been set.

func (*Configuration) HasEnablePersonalization 

func (o *Configuration) HasEnablePersonalization() bool

HasEnablePersonalization returns a boolean if a field has been set.

func (*Configuration) HasExclude 

func (o *Configuration) HasExclude() bool

HasExclude returns a boolean if a field has been set.

func (*Configuration) HasLanguages 

func (o *Configuration) HasLanguages() bool

HasLanguages returns a boolean if a field has been set.

func (Configuration) MarshalJSON 

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

func (*Configuration) SetAllowSpecialCharacters 

func (o *Configuration) SetAllowSpecialCharacters(v bool) *Configuration

SetAllowSpecialCharacters gets a reference to the given bool and assigns it to the AllowSpecialCharacters field.

func (*Configuration) SetEnablePersonalization 

func (o *Configuration) SetEnablePersonalization(v bool) *Configuration

SetEnablePersonalization gets a reference to the given bool and assigns it to the EnablePersonalization field.

func (*Configuration) SetExclude 

func (o *Configuration) SetExclude(v []string) *Configuration

SetExclude gets a reference to the given []string and assigns it to the Exclude field.

func (*Configuration) SetLanguages 

func (o *Configuration) SetLanguages(v *Languages) *Configuration

SetLanguages gets a reference to the given Languages and assigns it to the Languages field.

func (*Configuration) SetSourceIndices 

func (o *Configuration) SetSourceIndices(v []SourceIndex) *Configuration

SetSourceIndices sets field value.

func (Configuration) String 

func (o Configuration) String() string

type ConfigurationOption 

type ConfigurationOption func(f *Configuration)

func WithConfigurationAllowSpecialCharacters 

func WithConfigurationAllowSpecialCharacters(val bool) ConfigurationOption

func WithConfigurationEnablePersonalization 

func WithConfigurationEnablePersonalization(val bool) ConfigurationOption

func WithConfigurationExclude 

func WithConfigurationExclude(val []string) ConfigurationOption

func WithConfigurationLanguages 

func WithConfigurationLanguages(val Languages) ConfigurationOption

type ConfigurationResponse 

type ConfigurationResponse struct {
	// Algolia application ID to which this Query Suggestions configuration belongs.
	AppID string `json:"appID"`
	// Name of the Query Suggestions index (case-sensitive).
	IndexName string `json:"indexName"`
	// Algolia indices from which to get the popular searches for query suggestions.
	SourceIndices []SourceIndex `json:"sourceIndices"`
	Languages     Languages     `json:"languages"`
	Exclude       []string      `json:"exclude"`
	// Whether to turn on personalized query suggestions.
	EnablePersonalization bool `json:"enablePersonalization"`
	// Whether to include suggestions with special characters.
	AllowSpecialCharacters bool `json:"allowSpecialCharacters"`
}

ConfigurationResponse API response for retrieving Query Suggestions configurations.

func NewConfigurationResponse 

func NewConfigurationResponse(appID string, indexName string, sourceIndices []SourceIndex, languages Languages, exclude []string, enablePersonalization bool, allowSpecialCharacters bool) *ConfigurationResponse

NewConfigurationResponse instantiates a new ConfigurationResponse 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 NewEmptyConfigurationResponse 

func NewEmptyConfigurationResponse() *ConfigurationResponse

NewEmptyConfigurationResponse return a pointer to an empty ConfigurationResponse object.

func (*ConfigurationResponse) GetAllowSpecialCharacters 

func (o *ConfigurationResponse) GetAllowSpecialCharacters() bool

GetAllowSpecialCharacters returns the AllowSpecialCharacters field value.

func (*ConfigurationResponse) GetAllowSpecialCharactersOk 

func (o *ConfigurationResponse) GetAllowSpecialCharactersOk() (*bool, bool)

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

func (*ConfigurationResponse) GetAppID 

func (o *ConfigurationResponse) GetAppID() string

GetAppID returns the AppID field value.

func (*ConfigurationResponse) GetAppIDOk 

func (o *ConfigurationResponse) GetAppIDOk() (*string, bool)

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

func (*ConfigurationResponse) GetEnablePersonalization 

func (o *ConfigurationResponse) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value.

func (*ConfigurationResponse) GetEnablePersonalizationOk 

func (o *ConfigurationResponse) GetEnablePersonalizationOk() (*bool, bool)

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

func (*ConfigurationResponse) GetExclude 

func (o *ConfigurationResponse) GetExclude() []string

GetExclude returns the Exclude field value. If the value is explicit nil, the zero value for []string will be returned.

func (*ConfigurationResponse) GetExcludeOk 

func (o *ConfigurationResponse) GetExcludeOk() ([]string, bool)

GetExcludeOk returns a tuple with the Exclude field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*ConfigurationResponse) GetIndexName 

func (o *ConfigurationResponse) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*ConfigurationResponse) GetIndexNameOk 

func (o *ConfigurationResponse) GetIndexNameOk() (*string, bool)

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

func (*ConfigurationResponse) GetLanguages 

func (o *ConfigurationResponse) GetLanguages() Languages

GetLanguages returns the Languages field value.

func (*ConfigurationResponse) GetLanguagesOk 

func (o *ConfigurationResponse) GetLanguagesOk() (*Languages, bool)

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

func (*ConfigurationResponse) GetSourceIndices 

func (o *ConfigurationResponse) GetSourceIndices() []SourceIndex

GetSourceIndices returns the SourceIndices field value.

func (*ConfigurationResponse) GetSourceIndicesOk 

func (o *ConfigurationResponse) GetSourceIndicesOk() ([]SourceIndex, bool)

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

func (ConfigurationResponse) MarshalJSON 

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

func (*ConfigurationResponse) SetAllowSpecialCharacters 

func (o *ConfigurationResponse) SetAllowSpecialCharacters(v bool) *ConfigurationResponse

SetAllowSpecialCharacters sets field value.

func (*ConfigurationResponse) SetAppID 

func (o *ConfigurationResponse) SetAppID(v string) *ConfigurationResponse

SetAppID sets field value.

func (*ConfigurationResponse) SetEnablePersonalization 

func (o *ConfigurationResponse) SetEnablePersonalization(v bool) *ConfigurationResponse

SetEnablePersonalization sets field value.

func (*ConfigurationResponse) SetExclude 

func (o *ConfigurationResponse) SetExclude(v []string) *ConfigurationResponse

SetExclude sets field value.

func (*ConfigurationResponse) SetIndexName 

func (o *ConfigurationResponse) SetIndexName(v string) *ConfigurationResponse

SetIndexName sets field value.

func (*ConfigurationResponse) SetLanguages 

func (o *ConfigurationResponse) SetLanguages(v *Languages) *ConfigurationResponse

SetLanguages sets field value.

func (*ConfigurationResponse) SetSourceIndices 

func (o *ConfigurationResponse) SetSourceIndices(v []SourceIndex) *ConfigurationResponse

SetSourceIndices sets field value.

func (ConfigurationResponse) String 

func (o ConfigurationResponse) String() string

type ConfigurationWithIndex 

type ConfigurationWithIndex struct {
	// Algolia indices from which to get the popular searches for query suggestions.
	SourceIndices []SourceIndex `json:"sourceIndices"`
	Languages     *Languages    `json:"languages,omitempty"`
	Exclude       []string      `json:"exclude,omitempty"`
	// Whether to turn on personalized query suggestions.
	EnablePersonalization *bool `json:"enablePersonalization,omitempty"`
	// Whether to include suggestions with special characters.
	AllowSpecialCharacters *bool `json:"allowSpecialCharacters,omitempty"`
	// Name of the Query Suggestions index (case-sensitive).
	IndexName string `json:"indexName"`
}

ConfigurationWithIndex Query Suggestions configuration.

func NewConfigurationWithIndex 

func NewConfigurationWithIndex(sourceIndices []SourceIndex, indexName string, opts ...ConfigurationWithIndexOption) *ConfigurationWithIndex

NewConfigurationWithIndex instantiates a new ConfigurationWithIndex 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 NewEmptyConfigurationWithIndex 

func NewEmptyConfigurationWithIndex() *ConfigurationWithIndex

NewEmptyConfigurationWithIndex return a pointer to an empty ConfigurationWithIndex object.

func (*ConfigurationWithIndex) GetAllowSpecialCharacters 

func (o *ConfigurationWithIndex) GetAllowSpecialCharacters() bool

GetAllowSpecialCharacters returns the AllowSpecialCharacters field value if set, zero value otherwise.

func (*ConfigurationWithIndex) GetAllowSpecialCharactersOk 

func (o *ConfigurationWithIndex) GetAllowSpecialCharactersOk() (*bool, bool)

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

func (*ConfigurationWithIndex) GetEnablePersonalization 

func (o *ConfigurationWithIndex) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value if set, zero value otherwise.

func (*ConfigurationWithIndex) GetEnablePersonalizationOk 

func (o *ConfigurationWithIndex) GetEnablePersonalizationOk() (*bool, bool)

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

func (*ConfigurationWithIndex) GetExclude 

func (o *ConfigurationWithIndex) GetExclude() []string

GetExclude returns the Exclude field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ConfigurationWithIndex) GetExcludeOk 

func (o *ConfigurationWithIndex) GetExcludeOk() ([]string, bool)

GetExcludeOk returns a tuple with the Exclude field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*ConfigurationWithIndex) GetIndexName 

func (o *ConfigurationWithIndex) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*ConfigurationWithIndex) GetIndexNameOk 

func (o *ConfigurationWithIndex) GetIndexNameOk() (*string, bool)

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

func (*ConfigurationWithIndex) GetLanguages 

func (o *ConfigurationWithIndex) GetLanguages() Languages

GetLanguages returns the Languages field value if set, zero value otherwise.

func (*ConfigurationWithIndex) GetLanguagesOk 

func (o *ConfigurationWithIndex) GetLanguagesOk() (*Languages, bool)

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

func (*ConfigurationWithIndex) GetSourceIndices 

func (o *ConfigurationWithIndex) GetSourceIndices() []SourceIndex

GetSourceIndices returns the SourceIndices field value.

func (*ConfigurationWithIndex) GetSourceIndicesOk 

func (o *ConfigurationWithIndex) GetSourceIndicesOk() ([]SourceIndex, bool)

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

func (*ConfigurationWithIndex) HasAllowSpecialCharacters 

func (o *ConfigurationWithIndex) HasAllowSpecialCharacters() bool

HasAllowSpecialCharacters returns a boolean if a field has been set.

func (*ConfigurationWithIndex) HasEnablePersonalization 

func (o *ConfigurationWithIndex) HasEnablePersonalization() bool

HasEnablePersonalization returns a boolean if a field has been set.

func (*ConfigurationWithIndex) HasExclude 

func (o *ConfigurationWithIndex) HasExclude() bool

HasExclude returns a boolean if a field has been set.

func (*ConfigurationWithIndex) HasLanguages 

func (o *ConfigurationWithIndex) HasLanguages() bool

HasLanguages returns a boolean if a field has been set.

func (ConfigurationWithIndex) MarshalJSON 

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

func (*ConfigurationWithIndex) SetAllowSpecialCharacters 

func (o *ConfigurationWithIndex) SetAllowSpecialCharacters(v bool) *ConfigurationWithIndex

SetAllowSpecialCharacters gets a reference to the given bool and assigns it to the AllowSpecialCharacters field.

func (*ConfigurationWithIndex) SetEnablePersonalization 

func (o *ConfigurationWithIndex) SetEnablePersonalization(v bool) *ConfigurationWithIndex

SetEnablePersonalization gets a reference to the given bool and assigns it to the EnablePersonalization field.

func (*ConfigurationWithIndex) SetExclude 

func (o *ConfigurationWithIndex) SetExclude(v []string) *ConfigurationWithIndex

SetExclude gets a reference to the given []string and assigns it to the Exclude field.

func (*ConfigurationWithIndex) SetIndexName 

func (o *ConfigurationWithIndex) SetIndexName(v string) *ConfigurationWithIndex

SetIndexName sets field value.

func (*ConfigurationWithIndex) SetLanguages 

func (o *ConfigurationWithIndex) SetLanguages(v *Languages) *ConfigurationWithIndex

SetLanguages gets a reference to the given Languages and assigns it to the Languages field.

func (*ConfigurationWithIndex) SetSourceIndices 

func (o *ConfigurationWithIndex) SetSourceIndices(v []SourceIndex) *ConfigurationWithIndex

SetSourceIndices sets field value.

func (ConfigurationWithIndex) String 

func (o ConfigurationWithIndex) String() string

type ConfigurationWithIndexOption 

type ConfigurationWithIndexOption func(f *ConfigurationWithIndex)

func WithConfigurationWithIndexAllowSpecialCharacters 

func WithConfigurationWithIndexAllowSpecialCharacters(val bool) ConfigurationWithIndexOption

func WithConfigurationWithIndexEnablePersonalization 

func WithConfigurationWithIndexEnablePersonalization(val bool) ConfigurationWithIndexOption

func WithConfigurationWithIndexExclude 

func WithConfigurationWithIndexExclude(val []string) ConfigurationWithIndexOption

func WithConfigurationWithIndexLanguages 

func WithConfigurationWithIndexLanguages(val Languages) ConfigurationWithIndexOption

type ErrorBase 

type ErrorBase struct {
	Message              *string `json:"message,omitempty"`
	AdditionalProperties map[string]any
}

ErrorBase Error.

func NewEmptyErrorBase 

func NewEmptyErrorBase() *ErrorBase

NewEmptyErrorBase return a pointer to an empty ErrorBase object.

func NewErrorBase 

func NewErrorBase(opts ...ErrorBaseOption) *ErrorBase

NewErrorBase instantiates a new ErrorBase 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 (*ErrorBase) GetMessage 

func (o *ErrorBase) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*ErrorBase) GetMessageOk 

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

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

func (*ErrorBase) HasMessage 

func (o *ErrorBase) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (ErrorBase) MarshalJSON 

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

func (*ErrorBase) SetAdditionalProperty 

func (o *ErrorBase) SetAdditionalProperty(key string, value any) *ErrorBase

func (*ErrorBase) SetMessage 

func (o *ErrorBase) SetMessage(v string) *ErrorBase

SetMessage gets a reference to the given string and assigns it to the Message field.

func (ErrorBase) String 

func (o ErrorBase) String() string

func (*ErrorBase) UnmarshalJSON 

func (o *ErrorBase) UnmarshalJSON(bytes []byte) error

type ErrorBaseOption 

type ErrorBaseOption func(f *ErrorBase)

func WithErrorBaseMessage 

func WithErrorBaseMessage(val string) ErrorBaseOption

type Facet 

type Facet struct {
	// Facet name.
	Attribute *string `json:"attribute,omitempty"`
	// Number of suggestions.
	Amount *int32 `json:"amount,omitempty"`
}

Facet Facet to use as category.

func NewEmptyFacet 

func NewEmptyFacet() *Facet

NewEmptyFacet return a pointer to an empty Facet object.

func NewFacet 

func NewFacet(opts ...FacetOption) *Facet

NewFacet instantiates a new Facet 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 (*Facet) GetAmount 

func (o *Facet) GetAmount() int32

GetAmount returns the Amount field value if set, zero value otherwise.

func (*Facet) GetAmountOk 

func (o *Facet) GetAmountOk() (*int32, bool)

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

func (*Facet) GetAttribute 

func (o *Facet) GetAttribute() string

GetAttribute returns the Attribute field value if set, zero value otherwise.

func (*Facet) GetAttributeOk 

func (o *Facet) GetAttributeOk() (*string, bool)

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

func (*Facet) HasAmount 

func (o *Facet) HasAmount() bool

HasAmount returns a boolean if a field has been set.

func (*Facet) HasAttribute 

func (o *Facet) HasAttribute() bool

HasAttribute returns a boolean if a field has been set.

func (Facet) MarshalJSON 

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

func (*Facet) SetAmount 

func (o *Facet) SetAmount(v int32) *Facet

SetAmount gets a reference to the given int32 and assigns it to the Amount field.

func (*Facet) SetAttribute 

func (o *Facet) SetAttribute(v string) *Facet

SetAttribute gets a reference to the given string and assigns it to the Attribute field.

func (Facet) String 

func (o Facet) String() string

type FacetOption 

type FacetOption func(f *Facet)

func WithFacetAmount 

func WithFacetAmount(val int32) FacetOption

func WithFacetAttribute 

func WithFacetAttribute(val string) FacetOption

type Languages 

type Languages struct {
	ArrayOfString *[]string
	Bool          *bool
}

Languages - Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.

func ArrayOfStringAsLanguages 

func ArrayOfStringAsLanguages(v []string) *Languages

[]stringAsLanguages is a convenience function that returns []string wrapped in Languages.

func BoolAsLanguages 

func BoolAsLanguages(v bool) *Languages

boolAsLanguages is a convenience function that returns bool wrapped in Languages.

func (Languages) GetActualInstance 

func (obj Languages) GetActualInstance() any

Get the actual instance.

func (Languages) MarshalJSON 

func (src Languages) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*Languages) UnmarshalJSON 

func (dst *Languages) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct.

type LogFile 

type LogFile struct {
	// Date and time of the log entry, in RFC 3339 format.
	Timestamp *string   `json:"timestamp,omitempty"`
	Level     *LogLevel `json:"level,omitempty"`
	// Details about this log entry.
	Message *string `json:"message,omitempty"`
	// Level indicating the position of a suggestion in a hierarchy of records.  For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
	ContextLevel *int32 `json:"contextLevel,omitempty"`
}

LogFile struct for LogFile.

func NewEmptyLogFile 

func NewEmptyLogFile() *LogFile

NewEmptyLogFile return a pointer to an empty LogFile object.

func NewLogFile 

func NewLogFile(opts ...LogFileOption) *LogFile

NewLogFile instantiates a new LogFile 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 (*LogFile) GetContextLevel 

func (o *LogFile) GetContextLevel() int32

GetContextLevel returns the ContextLevel field value if set, zero value otherwise.

func (*LogFile) GetContextLevelOk 

func (o *LogFile) GetContextLevelOk() (*int32, bool)

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

func (*LogFile) GetLevel 

func (o *LogFile) GetLevel() LogLevel

GetLevel returns the Level field value if set, zero value otherwise.

func (*LogFile) GetLevelOk 

func (o *LogFile) GetLevelOk() (*LogLevel, bool)

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

func (*LogFile) GetMessage 

func (o *LogFile) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*LogFile) GetMessageOk 

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

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

func (*LogFile) GetTimestamp 

func (o *LogFile) GetTimestamp() string

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*LogFile) GetTimestampOk 

func (o *LogFile) GetTimestampOk() (*string, bool)

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

func (*LogFile) HasContextLevel 

func (o *LogFile) HasContextLevel() bool

HasContextLevel returns a boolean if a field has been set.

func (*LogFile) HasLevel 

func (o *LogFile) HasLevel() bool

HasLevel returns a boolean if a field has been set.

func (*LogFile) HasMessage 

func (o *LogFile) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*LogFile) HasTimestamp 

func (o *LogFile) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (LogFile) MarshalJSON 

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

func (*LogFile) SetContextLevel 

func (o *LogFile) SetContextLevel(v int32) *LogFile

SetContextLevel gets a reference to the given int32 and assigns it to the ContextLevel field.

func (*LogFile) SetLevel 

func (o *LogFile) SetLevel(v LogLevel) *LogFile

SetLevel gets a reference to the given LogLevel and assigns it to the Level field.

func (*LogFile) SetMessage 

func (o *LogFile) SetMessage(v string) *LogFile

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*LogFile) SetTimestamp 

func (o *LogFile) SetTimestamp(v string) *LogFile

SetTimestamp gets a reference to the given string and assigns it to the Timestamp field.

func (LogFile) String 

func (o LogFile) String() string

type LogFileOption 

type LogFileOption func(f *LogFile)

func WithLogFileContextLevel 

func WithLogFileContextLevel(val int32) LogFileOption

func WithLogFileLevel 

func WithLogFileLevel(val LogLevel) LogFileOption

func WithLogFileMessage 

func WithLogFileMessage(val string) LogFileOption

func WithLogFileTimestamp 

func WithLogFileTimestamp(val string) LogFileOption

type LogLevel 

type LogLevel string

LogLevel Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error. 

const (
	LOG_LEVEL_SKIP  LogLevel = "SKIP"
	LOG_LEVEL_INFO  LogLevel = "INFO"
	LOG_LEVEL_ERROR LogLevel = "ERROR"
)

List of LogLevel.

func NewLogLevelFromValue 

func NewLogLevelFromValue(v string) (*LogLevel, error)

NewLogLevelFromValue returns a pointer to a valid LogLevel for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (LogLevel) IsValid 

func (v LogLevel) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (LogLevel) Ptr 

func (v LogLevel) Ptr() *LogLevel

Ptr returns reference to LogLevel value.

func (*LogLevel) UnmarshalJSON 

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

type QuerySuggestionsConfiguration 

type QuerySuggestionsConfiguration struct {
	transport.Configuration

	Region Region
}

QuerySuggestionsConfiguration stores the configuration of the API client.

type Region 

type Region string
const (
	EU Region = "eu"
	US Region = "us"
)

type RequestOption 

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

type SourceIndex 

type SourceIndex struct {
	// Name of the Algolia index (case-sensitive) to use as source for query suggestions.
	IndexName string `json:"indexName"`
	// If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
	Replicas      *bool    `json:"replicas,omitempty"`
	AnalyticsTags []string `json:"analyticsTags,omitempty"`
	Facets        []Facet  `json:"facets,omitempty"`
	// Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
	MinHits *int32 `json:"minHits,omitempty"`
	// Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to be included in the Query Suggestions index.
	MinLetters *int32     `json:"minLetters,omitempty"`
	Generate   [][]string `json:"generate,omitempty"`
	External   []string   `json:"external,omitempty"`
}

SourceIndex Configuration of an Algolia index for Query Suggestions.

func NewEmptySourceIndex 

func NewEmptySourceIndex() *SourceIndex

NewEmptySourceIndex return a pointer to an empty SourceIndex object.

func NewSourceIndex 

func NewSourceIndex(indexName string, opts ...SourceIndexOption) *SourceIndex

NewSourceIndex instantiates a new SourceIndex 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 (*SourceIndex) GetAnalyticsTags 

func (o *SourceIndex) GetAnalyticsTags() []string

GetAnalyticsTags returns the AnalyticsTags field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SourceIndex) GetAnalyticsTagsOk 

func (o *SourceIndex) GetAnalyticsTagsOk() ([]string, bool)

GetAnalyticsTagsOk returns a tuple with the AnalyticsTags field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SourceIndex) GetExternal 

func (o *SourceIndex) GetExternal() []string

GetExternal returns the External field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SourceIndex) GetExternalOk 

func (o *SourceIndex) GetExternalOk() ([]string, bool)

GetExternalOk returns a tuple with the External field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SourceIndex) GetFacets 

func (o *SourceIndex) GetFacets() []Facet

GetFacets returns the Facets field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SourceIndex) GetFacetsOk 

func (o *SourceIndex) GetFacetsOk() ([]Facet, bool)

GetFacetsOk returns a tuple with the Facets field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SourceIndex) GetGenerate 

func (o *SourceIndex) GetGenerate() [][]string

GetGenerate returns the Generate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SourceIndex) GetGenerateOk 

func (o *SourceIndex) GetGenerateOk() ([][]string, bool)

GetGenerateOk returns a tuple with the Generate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SourceIndex) GetIndexName 

func (o *SourceIndex) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*SourceIndex) GetIndexNameOk 

func (o *SourceIndex) GetIndexNameOk() (*string, bool)

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

func (*SourceIndex) GetMinHits 

func (o *SourceIndex) GetMinHits() int32

GetMinHits returns the MinHits field value if set, zero value otherwise.

func (*SourceIndex) GetMinHitsOk 

func (o *SourceIndex) GetMinHitsOk() (*int32, bool)

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

func (*SourceIndex) GetMinLetters 

func (o *SourceIndex) GetMinLetters() int32

GetMinLetters returns the MinLetters field value if set, zero value otherwise.

func (*SourceIndex) GetMinLettersOk 

func (o *SourceIndex) GetMinLettersOk() (*int32, bool)

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

func (*SourceIndex) GetReplicas 

func (o *SourceIndex) GetReplicas() bool

GetReplicas returns the Replicas field value if set, zero value otherwise.

func (*SourceIndex) GetReplicasOk 

func (o *SourceIndex) GetReplicasOk() (*bool, bool)

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

func (*SourceIndex) HasAnalyticsTags 

func (o *SourceIndex) HasAnalyticsTags() bool

HasAnalyticsTags returns a boolean if a field has been set.

func (*SourceIndex) HasExternal 

func (o *SourceIndex) HasExternal() bool

HasExternal returns a boolean if a field has been set.

func (*SourceIndex) HasFacets 

func (o *SourceIndex) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*SourceIndex) HasGenerate 

func (o *SourceIndex) HasGenerate() bool

HasGenerate returns a boolean if a field has been set.

func (*SourceIndex) HasMinHits 

func (o *SourceIndex) HasMinHits() bool

HasMinHits returns a boolean if a field has been set.

func (*SourceIndex) HasMinLetters 

func (o *SourceIndex) HasMinLetters() bool

HasMinLetters returns a boolean if a field has been set.

func (*SourceIndex) HasReplicas 

func (o *SourceIndex) HasReplicas() bool

HasReplicas returns a boolean if a field has been set.

func (SourceIndex) MarshalJSON 

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

func (*SourceIndex) SetAnalyticsTags 

func (o *SourceIndex) SetAnalyticsTags(v []string) *SourceIndex

SetAnalyticsTags gets a reference to the given []string and assigns it to the AnalyticsTags field.

func (*SourceIndex) SetExternal 

func (o *SourceIndex) SetExternal(v []string) *SourceIndex

SetExternal gets a reference to the given []string and assigns it to the External field.

func (*SourceIndex) SetFacets 

func (o *SourceIndex) SetFacets(v []Facet) *SourceIndex

SetFacets gets a reference to the given []Facet and assigns it to the Facets field.

func (*SourceIndex) SetGenerate 

func (o *SourceIndex) SetGenerate(v [][]string) *SourceIndex

SetGenerate gets a reference to the given [][]string and assigns it to the Generate field.

func (*SourceIndex) SetIndexName 

func (o *SourceIndex) SetIndexName(v string) *SourceIndex

SetIndexName sets field value.

func (*SourceIndex) SetMinHits 

func (o *SourceIndex) SetMinHits(v int32) *SourceIndex

SetMinHits gets a reference to the given int32 and assigns it to the MinHits field.

func (*SourceIndex) SetMinLetters 

func (o *SourceIndex) SetMinLetters(v int32) *SourceIndex

SetMinLetters gets a reference to the given int32 and assigns it to the MinLetters field.

func (*SourceIndex) SetReplicas 

func (o *SourceIndex) SetReplicas(v bool) *SourceIndex

SetReplicas gets a reference to the given bool and assigns it to the Replicas field.

func (SourceIndex) String 

func (o SourceIndex) String() string

type SourceIndexOption 

type SourceIndexOption func(f *SourceIndex)

func WithSourceIndexAnalyticsTags 

func WithSourceIndexAnalyticsTags(val []string) SourceIndexOption

func WithSourceIndexExternal 

func WithSourceIndexExternal(val []string) SourceIndexOption

func WithSourceIndexFacets 

func WithSourceIndexFacets(val []Facet) SourceIndexOption

func WithSourceIndexGenerate 

func WithSourceIndexGenerate(val [][]string) SourceIndexOption

func WithSourceIndexMinHits 

func WithSourceIndexMinHits(val int32) SourceIndexOption

func WithSourceIndexMinLetters 

func WithSourceIndexMinLetters(val int32) SourceIndexOption

func WithSourceIndexReplicas 

func WithSourceIndexReplicas(val bool) SourceIndexOption

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.