diff --git a/clients/algoliasearch-client-go/algolia/abtesting/api_abtesting.go b/clients/algoliasearch-client-go/algolia/abtesting/api_abtesting.go index 2bfed8165b..9f7f6a1e4f 100644 --- a/clients/algoliasearch-client-go/algolia/abtesting/api_abtesting.go +++ b/clients/algoliasearch-client-go/algolia/abtesting/api_abtesting.go @@ -73,15 +73,18 @@ func (c *APIClient) NewApiAddABTestsRequest(addABTestsRequest *AddABTestsRequest /* AddABTests calls the API and returns the raw response from it. -Creates a new A/B test. - -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiAddABTestsRequest with parameters below. - - @param addABTestsRequest AddABTestsRequest - @return ABTestResponse + Creates a new A/B test. + + Required API Key ACLs: + - editSettings + + Request can be constructed by NewApiAddABTestsRequest with parameters below. + @param ctx context.Context - Context of the request + @param addABTestsRequest AddABTestsRequest + @param opts ...Option - 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 (c *APIClient) AddABTestsWithHTTPInfo(ctx context.Context, r ApiAddABTestsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -230,13 +233,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -385,13 +392,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -556,14 +567,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -736,14 +751,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -884,15 +903,18 @@ func (c *APIClient) NewApiDeleteABTestRequest(id int32) ApiDeleteABTestRequest { /* DeleteABTest calls the API and returns the raw response from it. -Deletes an A/B test by its ID. - -Required API Key ACLs: - - editSettings + Deletes an A/B test by its ID. -Request can be constructed by NewApiDeleteABTestRequest with parameters below. + Required API Key ACLs: + - editSettings - @param id int32 - Unique A/B test identifier. - @return ABTestResponse + Request can be constructed by NewApiDeleteABTestRequest with parameters below. + @param ctx context.Context - Context of the request + @param id int32 - Unique A/B test identifier. + @param opts ...Option - 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 (c *APIClient) DeleteABTestWithHTTPInfo(ctx context.Context, r ApiDeleteABTestRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1020,15 +1042,18 @@ func (c *APIClient) NewApiGetABTestRequest(id int32) ApiGetABTestRequest { /* GetABTest calls the API and returns the raw response from it. -Retrieves the details for an A/B test by its ID. - -Required API Key ACLs: - - analytics + Retrieves the details for an A/B test by its ID. -Request can be constructed by NewApiGetABTestRequest with parameters below. + Required API Key ACLs: + - analytics - @param id int32 - Unique A/B test identifier. - @return ABTest + Request can be constructed by NewApiGetABTestRequest with parameters below. + @param ctx context.Context - Context of the request + @param id int32 - Unique A/B test identifier. + @param opts ...Option - 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 (c *APIClient) GetABTestWithHTTPInfo(ctx context.Context, r ApiGetABTestRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1208,18 +1233,21 @@ func (r ApiListABTestsRequest) WithIndexSuffix(indexSuffix string) ApiListABTest /* ListABTests calls the API and returns the raw response from it. -Lists all A/B tests you configured for this application. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiListABTestsRequest with parameters below. - - @param offset int32 - Position of the first item to return. - @param limit int32 - Number of items to return. - @param indexPrefix string - Index name prefix. Only A/B tests for indices starting with this string are included in the response. - @param indexSuffix string - Index name suffix. Only A/B tests for indices ending with this string are included in the response. - @return ListABTestsResponse + Lists all A/B tests you configured for this application. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiListABTestsRequest with parameters below. + @param ctx context.Context - Context of the request + @param offset int32 - Position of the first item to return. + @param limit int32 - Number of items to return. + @param indexPrefix string - Index name prefix. Only A/B tests for indices starting with this string are included in the response. + @param indexSuffix string - Index name suffix. Only A/B tests for indices ending with this string are included in the response. + @param opts ...Option - 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 (c *APIClient) ListABTestsWithHTTPInfo(ctx context.Context, r ApiListABTestsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1365,17 +1393,20 @@ func (c *APIClient) NewApiStopABTestRequest(id int32) ApiStopABTestRequest { /* StopABTest calls the API and returns the raw response from it. -Stops an A/B test by its ID. + Stops an A/B test by its ID. You can't restart stopped A/B tests. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiStopABTestRequest with parameters below. + Required API Key ACLs: + - editSettings - @param id int32 - Unique A/B test identifier. - @return ABTestResponse + Request can be constructed by NewApiStopABTestRequest with parameters below. + @param ctx context.Context - Context of the request + @param id int32 - Unique A/B test identifier. + @param opts ...Option - 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 (c *APIClient) StopABTestWithHTTPInfo(ctx context.Context, r ApiStopABTestRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go b/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go index 3392ebacb5..1d23759423 100644 --- a/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go +++ b/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -786,20 +802,23 @@ func (r ApiGetAddToCartRateRequest) WithTags(tags string) ApiGetAddToCartRateReq /* GetAddToCartRate calls the API and returns the raw response from it. -Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. + Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetAddToCartRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetAddToCartRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetAddToCartRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetAddToCartRateWithHTTPInfo(ctx context.Context, r ApiGetAddToCartRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -998,22 +1017,25 @@ func (r ApiGetAverageClickPositionRequest) WithTags(tags string) ApiGetAverageCl /* GetAverageClickPosition calls the API and returns the raw response from it. -Retrieves the average click position of your search results, including a daily breakdown. + Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetAverageClickPositionRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetAverageClickPositionResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetAverageClickPositionRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetAverageClickPositionWithHTTPInfo(ctx context.Context, r ApiGetAverageClickPositionRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1216,20 +1238,23 @@ func (r ApiGetClickPositionsRequest) WithTags(tags string) ApiGetClickPositionsR /* GetClickPositions calls the API and returns the raw response from it. -Retrieves the positions in the search results and their associated number of clicks. + Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetClickPositionsRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetClickPositionsResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetClickPositionsRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetClickPositionsWithHTTPInfo(ctx context.Context, r ApiGetClickPositionsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1428,20 +1453,23 @@ func (r ApiGetClickThroughRateRequest) WithTags(tags string) ApiGetClickThroughR /* GetClickThroughRate calls the API and returns the raw response from it. -# Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown + Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetClickThroughRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetClickThroughRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetClickThroughRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetClickThroughRateWithHTTPInfo(ctx context.Context, r ApiGetClickThroughRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1640,20 +1668,23 @@ func (r ApiGetConversionRateRequest) WithTags(tags string) ApiGetConversionRateR /* GetConversionRate calls the API and returns the raw response from it. -Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. + Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetConversionRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetConversionRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetConversionRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetConversionRateWithHTTPInfo(ctx context.Context, r ApiGetConversionRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1852,20 +1883,23 @@ func (r ApiGetNoClickRateRequest) WithTags(tags string) ApiGetNoClickRateRequest /* GetNoClickRate calls the API and returns the raw response from it. -Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. + Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetNoClickRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetNoClickRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetNoClickRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetNoClickRateWithHTTPInfo(ctx context.Context, r ApiGetNoClickRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2064,20 +2098,23 @@ func (r ApiGetNoResultsRateRequest) WithTags(tags string) ApiGetNoResultsRateReq /* GetNoResultsRate calls the API and returns the raw response from it. -Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. + Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetNoResultsRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetNoResultsRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetNoResultsRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetNoResultsRateWithHTTPInfo(ctx context.Context, r ApiGetNoResultsRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2276,20 +2313,23 @@ func (r ApiGetPurchaseRateRequest) WithTags(tags string) ApiGetPurchaseRateReque /* GetPurchaseRate calls the API and returns the raw response from it. -Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. + Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetPurchaseRateRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetPurchaseRateResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetPurchaseRateRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetPurchaseRateWithHTTPInfo(ctx context.Context, r ApiGetPurchaseRateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2488,21 +2528,24 @@ func (r ApiGetRevenueRequest) WithTags(tags string) ApiGetRevenueRequest { /* GetRevenue calls the API and returns the raw response from it. -Retrieves revenue-related metrics, such as the total revenue or the average order value. + Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetRevenueRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetRevenue + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetRevenueRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetRevenueWithHTTPInfo(ctx context.Context, r ApiGetRevenueRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2703,20 +2746,23 @@ func (r ApiGetSearchesCountRequest) WithTags(tags string) ApiGetSearchesCountReq /* GetSearchesCount calls the API and returns the raw response from it. -Retrieves the number of searches within a time range, including a daily breakdown. + Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetSearchesCountRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetSearchesCountResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetSearchesCountRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetSearchesCountWithHTTPInfo(ctx context.Context, r ApiGetSearchesCountRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2947,20 +2993,23 @@ func (r ApiGetSearchesNoClicksRequest) WithTags(tags string) ApiGetSearchesNoCli /* GetSearchesNoClicks calls the API and returns the raw response from it. -Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetSearchesNoClicksResponse + Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetSearchesNoClicksWithHTTPInfo(ctx context.Context, r ApiGetSearchesNoClicksRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3197,20 +3246,23 @@ func (r ApiGetSearchesNoResultsRequest) WithTags(tags string) ApiGetSearchesNoRe /* GetSearchesNoResults calls the API and returns the raw response from it. -Retrieves the most popular searches that didn't return any results. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetSearchesNoResultsResponse + Retrieves the most popular searches that didn't return any results. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetSearchesNoResultsWithHTTPInfo(ctx context.Context, r ApiGetSearchesNoResultsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3367,17 +3419,20 @@ func (c *APIClient) NewApiGetStatusRequest(index string) ApiGetStatusRequest { /* GetStatus calls the API and returns the raw response from it. -Retrieves the time when the Analytics data for the specified index was last updated. + Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetStatusRequest with parameters below. + Required API Key ACLs: + - analytics - @param index string - Index name. - @return GetStatusResponse + Request can be constructed by NewApiGetStatusRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param opts ...Option - 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 (c *APIClient) GetStatusWithHTTPInfo(ctx context.Context, r ApiGetStatusRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3593,20 +3648,23 @@ func (r ApiGetTopCountriesRequest) WithTags(tags string) ApiGetTopCountriesReque /* GetTopCountries calls the API and returns the raw response from it. -Retrieves the countries with the most searches to your index. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopCountriesRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopCountriesResponse + Retrieves the countries with the most searches to your index. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopCountriesRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopCountriesWithHTTPInfo(ctx context.Context, r ApiGetTopCountriesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3859,23 +3917,26 @@ func (r ApiGetTopFilterAttributesRequest) WithTags(tags string) ApiGetTopFilterA /* GetTopFilterAttributes calls the API and returns the raw response from it. -Retrieves the most frequently used filter attributes. + Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopFilterAttributesRequest with parameters below. - - @param index string - Index name. - @param search string - Search query. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopFilterAttributesResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopFilterAttributesRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param search string - Search query. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopFilterAttributesWithHTTPInfo(ctx context.Context, r ApiGetTopFilterAttributesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4148,24 +4209,27 @@ func (r ApiGetTopFilterForAttributeRequest) WithTags(tags string) ApiGetTopFilte /* GetTopFilterForAttribute calls the API and returns the raw response from it. -Retrieves the most frequent filter (facet) values for a filter attribute. + Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopFilterForAttributeRequest with parameters below. - - @param attribute string - Attribute name. - @param index string - Index name. - @param search string - Search query. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopFilterForAttributeResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopFilterForAttributeRequest with parameters below. + @param ctx context.Context - Context of the request + @param attribute string - Attribute name. + @param index string - Index name. + @param search string - Search query. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopFilterForAttributeWithHTTPInfo(ctx context.Context, r ApiGetTopFilterForAttributeRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4433,23 +4497,26 @@ func (r ApiGetTopFiltersNoResultsRequest) WithTags(tags string) ApiGetTopFilters /* GetTopFiltersNoResults calls the API and returns the raw response from it. -Retrieves the most frequently used filters for a search that didn't return any results. + Retrieves the most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameters below. - - @param index string - Index name. - @param search string - Search query. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopFiltersNoResultsResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param search string - Search query. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopFiltersNoResultsWithHTTPInfo(ctx context.Context, r ApiGetTopFiltersNoResultsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4743,23 +4810,26 @@ func (r ApiGetTopHitsRequest) WithTags(tags string) ApiGetTopHitsRequest { /* GetTopHits calls the API and returns the raw response from it. -Retrieves the object IDs of the most frequent search results. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopHitsRequest with parameters below. - - @param index string - Index name. - @param search string - Search query. - @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopHitsResponse + Retrieves the object IDs of the most frequent search results. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopHitsRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param search string - Search query. + @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. + @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopHitsWithHTTPInfo(ctx context.Context, r ApiGetTopHitsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5075,24 +5145,27 @@ func (r ApiGetTopSearchesRequest) WithTags(tags string) ApiGetTopSearchesRequest /* GetTopSearches calls the API and returns the raw response from it. -Returns the most popular search terms. - -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetTopSearchesRequest with parameters below. - - @param index string - Index name. - @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. - @param direction Direction - Sorting direction of the results: ascending or descending. - @param limit int32 - Number of items to return. - @param offset int32 - Position of the first item to return. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetTopSearchesResponse + Returns the most popular search terms. + + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetTopSearchesRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. + @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. + @param direction Direction - Sorting direction of the results: ascending or descending. + @param limit int32 - Number of items to return. + @param offset int32 - Position of the first item to return. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetTopSearchesWithHTTPInfo(ctx context.Context, r ApiGetTopSearchesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5317,23 +5390,26 @@ func (r ApiGetUsersCountRequest) WithTags(tags string) ApiGetUsersCountRequest { /* GetUsersCount calls the API and returns the raw response from it. -Retrieves the number of unique users within a time range, including a daily breakdown. + Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. -Required API Key ACLs: - - analytics - -Request can be constructed by NewApiGetUsersCountRequest with parameters below. - - @param index string - Index name. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - @return GetUsersCountResponse + Required API Key ACLs: + - analytics + + Request can be constructed by NewApiGetUsersCountRequest with parameters below. + @param ctx context.Context - Context of the request + @param index string - Index name. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + @param opts ...Option - 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 (c *APIClient) GetUsersCountWithHTTPInfo(ctx context.Context, r ApiGetUsersCountRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go b/clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go index 5fd0e82907..2d2b290462 100644 --- a/clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go +++ b/clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go @@ -73,17 +73,20 @@ func (c *APIClient) NewApiCreateAuthenticationRequest(authenticationCreate *Auth /* CreateAuthentication calls the API and returns the raw response from it. -Creates a new authentication resource. + Creates a new authentication resource. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiCreateAuthenticationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param authenticationCreate AuthenticationCreate - - @return AuthenticationCreateResponse + Request can be constructed by NewApiCreateAuthenticationRequest with parameters below. + @param ctx context.Context - Context of the request + @param authenticationCreate AuthenticationCreate - + @param opts ...Option - 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 (c *APIClient) CreateAuthenticationWithHTTPInfo(ctx context.Context, r ApiCreateAuthenticationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -225,17 +228,20 @@ func (c *APIClient) NewApiCreateDestinationRequest(destinationCreate *Destinatio /* CreateDestination calls the API and returns the raw response from it. -Creates a new destination. + Creates a new destination. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiCreateDestinationRequest with parameters below. - - @param destinationCreate DestinationCreate - - @return DestinationCreateResponse + Request can be constructed by NewApiCreateDestinationRequest with parameters below. + @param ctx context.Context - Context of the request + @param destinationCreate DestinationCreate - + @param opts ...Option - 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 (c *APIClient) CreateDestinationWithHTTPInfo(ctx context.Context, r ApiCreateDestinationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -377,17 +383,20 @@ func (c *APIClient) NewApiCreateSourceRequest(sourceCreate *SourceCreate) ApiCre /* CreateSource calls the API and returns the raw response from it. -Creates a new source. + Creates a new source. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiCreateSourceRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceCreate SourceCreate - - @return SourceCreateResponse + Request can be constructed by NewApiCreateSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceCreate SourceCreate - + @param opts ...Option - 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 (c *APIClient) CreateSourceWithHTTPInfo(ctx context.Context, r ApiCreateSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -529,12 +538,16 @@ func (c *APIClient) NewApiCreateTaskRequest(taskCreate *TaskCreate) ApiCreateTas /* CreateTask calls the API and returns the raw response from it. -Creates a new task. + Creates a new task. -Request can be constructed by NewApiCreateTaskRequest with parameters below. - @param taskCreate TaskCreate - Request body for creating a task. - @return TaskCreateResponse + Request can be constructed by NewApiCreateTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskCreate TaskCreate - Request body for creating a task. + @param opts ...Option - 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 (c *APIClient) CreateTaskWithHTTPInfo(ctx context.Context, r ApiCreateTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -666,12 +679,16 @@ func (c *APIClient) NewApiCreateTransformationRequest(transformationCreate *Tran /* CreateTransformation calls the API and returns the raw response from it. -Creates a new transformation. + Creates a new transformation. -Request can be constructed by NewApiCreateTransformationRequest with parameters below. - @param transformationCreate TransformationCreate - Request body for creating a transformation. - @return TransformationCreateResponse + Request can be constructed by NewApiCreateTransformationRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationCreate TransformationCreate - Request body for creating a transformation. + @param opts ...Option - 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 (c *APIClient) CreateTransformationWithHTTPInfo(ctx context.Context, r ApiCreateTransformationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -814,13 +831,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -969,13 +990,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1140,14 +1165,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1320,14 +1349,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1468,17 +1501,20 @@ func (c *APIClient) NewApiDeleteAuthenticationRequest(authenticationID string) A /* DeleteAuthentication calls the API and returns the raw response from it. -Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination. + Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiDeleteAuthenticationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param authenticationID string - Unique identifier of an authentication resource. - @return DeleteResponse + Request can be constructed by NewApiDeleteAuthenticationRequest with parameters below. + @param ctx context.Context - Context of the request + @param authenticationID string - Unique identifier of an authentication resource. + @param opts ...Option - 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 (c *APIClient) DeleteAuthenticationWithHTTPInfo(ctx context.Context, r ApiDeleteAuthenticationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1613,17 +1649,20 @@ func (c *APIClient) NewApiDeleteDestinationRequest(destinationID string) ApiDele /* DeleteDestination calls the API and returns the raw response from it. -Deletes a destination by its ID. You can't delete destinations that are referenced in tasks. + Deletes a destination by its ID. You can't delete destinations that are referenced in tasks. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiDeleteDestinationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param destinationID string - Unique identifier of a destination. - @return DeleteResponse + Request can be constructed by NewApiDeleteDestinationRequest with parameters below. + @param ctx context.Context - Context of the request + @param destinationID string - Unique identifier of a destination. + @param opts ...Option - 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 (c *APIClient) DeleteDestinationWithHTTPInfo(ctx context.Context, r ApiDeleteDestinationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1758,17 +1797,20 @@ func (c *APIClient) NewApiDeleteSourceRequest(sourceID string) ApiDeleteSourceRe /* DeleteSource calls the API and returns the raw response from it. -Deletes a source by its ID. You can't delete sources that are referenced in tasks. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Deletes a source by its ID. You can't delete sources that are referenced in tasks. -Request can be constructed by NewApiDeleteSourceRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceID string - Unique identifier of a source. - @return DeleteResponse + Request can be constructed by NewApiDeleteSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceID string - Unique identifier of a source. + @param opts ...Option - 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 (c *APIClient) DeleteSourceWithHTTPInfo(ctx context.Context, r ApiDeleteSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1903,12 +1945,16 @@ func (c *APIClient) NewApiDeleteTaskRequest(taskID string) ApiDeleteTaskRequest /* DeleteTask calls the API and returns the raw response from it. -Deletes a task by its ID. + Deletes a task by its ID. -Request can be constructed by NewApiDeleteTaskRequest with parameters below. - @param taskID string - Unique identifier of a task. - @return DeleteResponse + Request can be constructed by NewApiDeleteTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param opts ...Option - 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 (c *APIClient) DeleteTaskWithHTTPInfo(ctx context.Context, r ApiDeleteTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2033,12 +2079,16 @@ func (c *APIClient) NewApiDeleteTransformationRequest(transformationID string) A /* DeleteTransformation calls the API and returns the raw response from it. -Deletes a transformation by its ID. + Deletes a transformation by its ID. -Request can be constructed by NewApiDeleteTransformationRequest with parameters below. - @param transformationID string - Unique identifier of a transformation. - @return DeleteResponse + Request can be constructed by NewApiDeleteTransformationRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationID string - Unique identifier of a transformation. + @param opts ...Option - 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 (c *APIClient) DeleteTransformationWithHTTPInfo(ctx context.Context, r ApiDeleteTransformationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2163,17 +2213,20 @@ func (c *APIClient) NewApiDisableTaskRequest(taskID string) ApiDisableTaskReques /* DisableTask calls the API and returns the raw response from it. -Disables a task. + Disables a task. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiDisableTaskRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param taskID string - Unique identifier of a task. - @return TaskUpdateResponse + Request can be constructed by NewApiDisableTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param opts ...Option - 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 (c *APIClient) DisableTaskWithHTTPInfo(ctx context.Context, r ApiDisableTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2308,17 +2361,20 @@ func (c *APIClient) NewApiEnableTaskRequest(taskID string) ApiEnableTaskRequest /* EnableTask calls the API and returns the raw response from it. -Enables a task. + Enables a task. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiEnableTaskRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param taskID string - Unique identifier of a task. - @return TaskUpdateResponse + Request can be constructed by NewApiEnableTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param opts ...Option - 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 (c *APIClient) EnableTaskWithHTTPInfo(ctx context.Context, r ApiEnableTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2453,17 +2509,20 @@ func (c *APIClient) NewApiGetAuthenticationRequest(authenticationID string) ApiG /* GetAuthentication calls the API and returns the raw response from it. -Retrieves an authentication resource by its ID. + Retrieves an authentication resource by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiGetAuthenticationRequest with parameters below. - - @param authenticationID string - Unique identifier of an authentication resource. - @return Authentication + Request can be constructed by NewApiGetAuthenticationRequest with parameters below. + @param ctx context.Context - Context of the request + @param authenticationID string - Unique identifier of an authentication resource. + @param opts ...Option - 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 (c *APIClient) GetAuthenticationWithHTTPInfo(ctx context.Context, r ApiGetAuthenticationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2682,22 +2741,25 @@ func (r ApiGetAuthenticationsRequest) WithOrder(order OrderKeys) ApiGetAuthentic /* GetAuthentications calls the API and returns the raw response from it. -Retrieves a list of all authentication resources. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetAuthenticationsRequest with parameters below. - - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param type_ []AuthenticationType - Type of authentication resource to retrieve. - @param platform []PlatformWithNone - Ecommerce platform for which to retrieve authentication resources. - @param sort AuthenticationSortKeys - Property by which to sort the list of authentication resources. - @param order OrderKeys - Sort order of the response, ascending or descending. - @return ListAuthenticationsResponse + Retrieves a list of all authentication resources. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetAuthenticationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param type_ []AuthenticationType - Type of authentication resource to retrieve. + @param platform []PlatformWithNone - Ecommerce platform for which to retrieve authentication resources. + @param sort AuthenticationSortKeys - Property by which to sort the list of authentication resources. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param opts ...Option - 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 (c *APIClient) GetAuthenticationsWithHTTPInfo(ctx context.Context, r ApiGetAuthenticationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2857,17 +2919,20 @@ func (c *APIClient) NewApiGetDestinationRequest(destinationID string) ApiGetDest /* GetDestination calls the API and returns the raw response from it. -Retrieves a destination by its ID. + Retrieves a destination by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetDestinationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param destinationID string - Unique identifier of a destination. - @return Destination + Request can be constructed by NewApiGetDestinationRequest with parameters below. + @param ctx context.Context - Context of the request + @param destinationID string - Unique identifier of a destination. + @param opts ...Option - 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 (c *APIClient) GetDestinationWithHTTPInfo(ctx context.Context, r ApiGetDestinationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3086,22 +3151,25 @@ func (r ApiGetDestinationsRequest) WithOrder(order OrderKeys) ApiGetDestinations /* GetDestinations calls the API and returns the raw response from it. -Retrieves a list of destinations. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetDestinationsRequest with parameters below. - - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param type_ []DestinationType - Destination type. - @param authenticationID []string - Authentication ID used by destinations. - @param sort DestinationSortKeys - Property by which to sort the destinations. - @param order OrderKeys - Sort order of the response, ascending or descending. - @return ListDestinationsResponse + Retrieves a list of destinations. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetDestinationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param type_ []DestinationType - Destination type. + @param authenticationID []string - Authentication ID used by destinations. + @param sort DestinationSortKeys - Property by which to sort the destinations. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param opts ...Option - 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 (c *APIClient) GetDestinationsWithHTTPInfo(ctx context.Context, r ApiGetDestinationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3272,18 +3340,21 @@ func (c *APIClient) NewApiGetEventRequest(runID string, eventID string) ApiGetEv /* GetEvent calls the API and returns the raw response from it. -Retrieves a single task run event by its ID. + Retrieves a single task run event by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetEventRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param runID string - Unique identifier of a task run. - @param eventID string - Unique identifier of an event. - @return Event + Request can be constructed by NewApiGetEventRequest with parameters below. + @param ctx context.Context - Context of the request + @param runID string - Unique identifier of a task run. + @param eventID string - Unique identifier of an event. + @param opts ...Option - 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 (c *APIClient) GetEventWithHTTPInfo(ctx context.Context, r ApiGetEventRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3552,25 +3623,28 @@ func (r ApiGetEventsRequest) WithEndDate(endDate string) ApiGetEventsRequest { /* GetEvents calls the API and returns the raw response from it. -Retrieves a list of events for a task run, identified by it's ID. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetEventsRequest with parameters below. - - @param runID string - Unique identifier of a task run. - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param status []EventStatus - Event status for filtering the list of task runs. - @param type_ []EventType - Event type for filtering the list of task runs. - @param sort EventSortKeys - Property by which to sort the list of task run events. - @param order OrderKeys - Sort order of the response, ascending or descending. - @param startDate string - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. - @param endDate string - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. - @return ListEventsResponse + Retrieves a list of events for a task run, identified by it's ID. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetEventsRequest with parameters below. + @param ctx context.Context - Context of the request + @param runID string - Unique identifier of a task run. + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param status []EventStatus - Event status for filtering the list of task runs. + @param type_ []EventType - Event type for filtering the list of task runs. + @param sort EventSortKeys - Property by which to sort the list of task run events. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param startDate string - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. + @param endDate string - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. + @param opts ...Option - 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 (c *APIClient) GetEventsWithHTTPInfo(ctx context.Context, r ApiGetEventsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3746,17 +3820,20 @@ func (c *APIClient) NewApiGetRunRequest(runID string) ApiGetRunRequest { /* GetRun calls the API and returns the raw response from it. -Retrieve a single task run by its ID. + Retrieve a single task run by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetRunRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param runID string - Unique identifier of a task run. - @return Run + Request can be constructed by NewApiGetRunRequest with parameters below. + @param ctx context.Context - Context of the request + @param runID string - Unique identifier of a task run. + @param opts ...Option - 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 (c *APIClient) GetRunWithHTTPInfo(ctx context.Context, r ApiGetRunRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4007,24 +4084,27 @@ func (r ApiGetRunsRequest) WithEndDate(endDate string) ApiGetRunsRequest { /* GetRuns calls the API and returns the raw response from it. -Retrieve a list of task runs. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetRunsRequest with parameters below. - - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param status []RunStatus - Run status for filtering the list of task runs. - @param taskID string - Task ID for filtering the list of task runs. - @param sort RunSortKeys - Property by which to sort the list of task runs. - @param order OrderKeys - Sort order of the response, ascending or descending. - @param startDate string - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. - @param endDate string - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. - @return RunListResponse + Retrieve a list of task runs. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetRunsRequest with parameters below. + @param ctx context.Context - Context of the request + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param status []RunStatus - Run status for filtering the list of task runs. + @param taskID string - Task ID for filtering the list of task runs. + @param sort RunSortKeys - Property by which to sort the list of task runs. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param startDate string - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. + @param endDate string - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. + @param opts ...Option - 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 (c *APIClient) GetRunsWithHTTPInfo(ctx context.Context, r ApiGetRunsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4194,17 +4274,20 @@ func (c *APIClient) NewApiGetSourceRequest(sourceID string) ApiGetSourceRequest /* GetSource calls the API and returns the raw response from it. -Retrieve a source by its ID. + Retrieve a source by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetSourceRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceID string - Unique identifier of a source. - @return Source + Request can be constructed by NewApiGetSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceID string - Unique identifier of a source. + @param opts ...Option - 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 (c *APIClient) GetSourceWithHTTPInfo(ctx context.Context, r ApiGetSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4423,22 +4506,25 @@ func (r ApiGetSourcesRequest) WithOrder(order OrderKeys) ApiGetSourcesRequest { /* GetSources calls the API and returns the raw response from it. -Retrieves a list of sources. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetSourcesRequest with parameters below. - - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param type_ []SourceType - Source type. Some sources require authentication. - @param authenticationID []string - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication resource. - @param sort SourceSortKeys - Property by which to sort the list of sources. - @param order OrderKeys - Sort order of the response, ascending or descending. - @return ListSourcesResponse + Retrieves a list of sources. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetSourcesRequest with parameters below. + @param ctx context.Context - Context of the request + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param type_ []SourceType - Source type. Some sources require authentication. + @param authenticationID []string - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication resource. + @param sort SourceSortKeys - Property by which to sort the list of sources. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param opts ...Option - 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 (c *APIClient) GetSourcesWithHTTPInfo(ctx context.Context, r ApiGetSourcesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4598,17 +4684,20 @@ func (c *APIClient) NewApiGetTaskRequest(taskID string) ApiGetTaskRequest { /* GetTask calls the API and returns the raw response from it. -Retrieves a task by its ID. + Retrieves a task by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiGetTaskRequest with parameters below. - - @param taskID string - Unique identifier of a task. - @return Task + Request can be constructed by NewApiGetTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param opts ...Option - 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 (c *APIClient) GetTaskWithHTTPInfo(ctx context.Context, r ApiGetTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4875,25 +4964,28 @@ func (r ApiGetTasksRequest) WithOrder(order OrderKeys) ApiGetTasksRequest { /* GetTasks calls the API and returns the raw response from it. -Retrieves a list of tasks. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetTasksRequest with parameters below. - - @param itemsPerPage int32 - Number of items per page. - @param page int32 - Page number of the paginated API response. - @param action []ActionType - Actions for filtering the list of tasks. - @param enabled bool - Whether to filter the list of tasks by the `enabled` status. - @param sourceID []string - Source IDs for filtering the list of tasks. - @param destinationID []string - Destination IDs for filtering the list of tasks. - @param triggerType []TriggerType - Type of task trigger for filtering the list of tasks. - @param sort TaskSortKeys - Property by which to sort the list of tasks. - @param order OrderKeys - Sort order of the response, ascending or descending. - @return ListTasksResponse + Retrieves a list of tasks. + + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings + + Request can be constructed by NewApiGetTasksRequest with parameters below. + @param ctx context.Context - Context of the request + @param itemsPerPage int32 - Number of items per page. + @param page int32 - Page number of the paginated API response. + @param action []ActionType - Actions for filtering the list of tasks. + @param enabled bool - Whether to filter the list of tasks by the `enabled` status. + @param sourceID []string - Source IDs for filtering the list of tasks. + @param destinationID []string - Destination IDs for filtering the list of tasks. + @param triggerType []TriggerType - Type of task trigger for filtering the list of tasks. + @param sort TaskSortKeys - Property by which to sort the list of tasks. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param opts ...Option - 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 (c *APIClient) GetTasksWithHTTPInfo(ctx context.Context, r ApiGetTasksRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5068,17 +5160,20 @@ func (c *APIClient) NewApiGetTransformationRequest(transformationID string) ApiG /* GetTransformation calls the API and returns the raw response from it. -Retrieves a transformation by its ID. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Retrieves a transformation by its ID. -Request can be constructed by NewApiGetTransformationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param transformationID string - Unique identifier of a transformation. - @return Transformation + Request can be constructed by NewApiGetTransformationRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationID string - Unique identifier of a transformation. + @param opts ...Option - 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 (c *APIClient) GetTransformationWithHTTPInfo(ctx context.Context, r ApiGetTransformationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5233,18 +5328,21 @@ func (r ApiGetTransformationsRequest) WithOrder(order OrderKeys) ApiGetTransform /* GetTransformations calls the API and returns the raw response from it. -Retrieves a list of transformations. + Retrieves a list of transformations. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiGetTransformationsRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sort SortKeys - Property by which to sort the list. - @param order OrderKeys - Sort order of the response, ascending or descending. - @return ListTransformationsResponse + Request can be constructed by NewApiGetTransformationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param sort SortKeys - Property by which to sort the list. + @param order OrderKeys - Sort order of the response, ascending or descending. + @param opts ...Option - 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 (c *APIClient) GetTransformationsWithHTTPInfo(ctx context.Context, r ApiGetTransformationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5384,17 +5482,20 @@ func (c *APIClient) NewApiRunTaskRequest(taskID string) ApiRunTaskRequest { /* RunTask calls the API and returns the raw response from it. -Runs a task. You can check the status of task runs with the observability endpoints. + Runs a task. You can check the status of task runs with the observability endpoints. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiRunTaskRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param taskID string - Unique identifier of a task. - @return RunResponse + Request can be constructed by NewApiRunTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param opts ...Option - 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 (c *APIClient) RunTaskWithHTTPInfo(ctx context.Context, r ApiRunTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5534,17 +5635,20 @@ func (c *APIClient) NewApiSearchAuthenticationsRequest(authenticationSearch *Aut /* SearchAuthentications calls the API and returns the raw response from it. -Searches for authentication resources. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Searches for authentication resources. -Request can be constructed by NewApiSearchAuthenticationsRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param authenticationSearch AuthenticationSearch - @return []Authentication + Request can be constructed by NewApiSearchAuthenticationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param authenticationSearch AuthenticationSearch + @param opts ...Option - 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 (c *APIClient) SearchAuthenticationsWithHTTPInfo(ctx context.Context, r ApiSearchAuthenticationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5686,17 +5790,20 @@ func (c *APIClient) NewApiSearchDestinationsRequest(destinationSearch *Destinati /* SearchDestinations calls the API and returns the raw response from it. -Searches for destinations. + Searches for destinations. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiSearchDestinationsRequest with parameters below. - - @param destinationSearch DestinationSearch - @return []Destination + Request can be constructed by NewApiSearchDestinationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param destinationSearch DestinationSearch + @param opts ...Option - 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 (c *APIClient) SearchDestinationsWithHTTPInfo(ctx context.Context, r ApiSearchDestinationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5838,17 +5945,20 @@ func (c *APIClient) NewApiSearchSourcesRequest(sourceSearch *SourceSearch) ApiSe /* SearchSources calls the API and returns the raw response from it. -Searches for sources. + Searches for sources. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiSearchSourcesRequest with parameters below. - - @param sourceSearch SourceSearch - @return []Source + Request can be constructed by NewApiSearchSourcesRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceSearch SourceSearch + @param opts ...Option - 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 (c *APIClient) SearchSourcesWithHTTPInfo(ctx context.Context, r ApiSearchSourcesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5990,17 +6100,20 @@ func (c *APIClient) NewApiSearchTasksRequest(taskSearch *TaskSearch) ApiSearchTa /* SearchTasks calls the API and returns the raw response from it. -Searches for tasks. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Searches for tasks. -Request can be constructed by NewApiSearchTasksRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param taskSearch TaskSearch - @return []Task + Request can be constructed by NewApiSearchTasksRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskSearch TaskSearch + @param opts ...Option - 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 (c *APIClient) SearchTasksWithHTTPInfo(ctx context.Context, r ApiSearchTasksRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6142,17 +6255,20 @@ func (c *APIClient) NewApiSearchTransformationsRequest(transformationSearch *Tra /* SearchTransformations calls the API and returns the raw response from it. -Searches for transformations. + Searches for transformations. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings - -Request can be constructed by NewApiSearchTransformationsRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param transformationSearch TransformationSearch - @return []Transformation + Request can be constructed by NewApiSearchTransformationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationSearch TransformationSearch + @param opts ...Option - 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 (c *APIClient) SearchTransformationsWithHTTPInfo(ctx context.Context, r ApiSearchTransformationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6289,18 +6405,22 @@ func (c *APIClient) NewApiTriggerDockerSourceDiscoverRequest(sourceID string) Ap /* TriggerDockerSourceDiscover calls the API and returns the raw response from it. -Triggers a stream-listing request for a source. -Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`. + Triggers a stream-listing request for a source. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings +Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`. -Request can be constructed by NewApiTriggerDockerSourceDiscoverRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceID string - Unique identifier of a source. - @return SourceWatchResponse + Request can be constructed by NewApiTriggerDockerSourceDiscoverRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceID string - Unique identifier of a source. + @param opts ...Option - 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 (c *APIClient) TriggerDockerSourceDiscoverWithHTTPInfo(ctx context.Context, r ApiTriggerDockerSourceDiscoverRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6442,17 +6562,20 @@ func (c *APIClient) NewApiTryTransformationsRequest(transformationTry *Transform /* TryTransformations calls the API and returns the raw response from it. -Searches for transformations. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Searches for transformations. -Request can be constructed by NewApiTryTransformationsRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param transformationTry TransformationTry - @return TransformationTryResponse + Request can be constructed by NewApiTryTransformationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationTry TransformationTry + @param opts ...Option - 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 (c *APIClient) TryTransformationsWithHTTPInfo(ctx context.Context, r ApiTryTransformationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6605,18 +6728,21 @@ func (c *APIClient) NewApiUpdateAuthenticationRequest(authenticationID string, a /* UpdateAuthentication calls the API and returns the raw response from it. -Updates an authentication resource. - -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Updates an authentication resource. -Request can be constructed by NewApiUpdateAuthenticationRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param authenticationID string - Unique identifier of an authentication resource. - @param authenticationUpdate AuthenticationUpdate - @return AuthenticationUpdateResponse + Request can be constructed by NewApiUpdateAuthenticationRequest with parameters below. + @param ctx context.Context - Context of the request + @param authenticationID string - Unique identifier of an authentication resource. + @param authenticationUpdate AuthenticationUpdate + @param opts ...Option - 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 (c *APIClient) UpdateAuthenticationWithHTTPInfo(ctx context.Context, r ApiUpdateAuthenticationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6775,18 +6901,21 @@ func (c *APIClient) NewApiUpdateDestinationRequest(destinationID string, destina /* UpdateDestination calls the API and returns the raw response from it. -Updates the destination by its ID. + Updates the destination by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiUpdateDestinationRequest with parameters below. - - @param destinationID string - Unique identifier of a destination. - @param destinationUpdate DestinationUpdate - @return DestinationUpdateResponse + Request can be constructed by NewApiUpdateDestinationRequest with parameters below. + @param ctx context.Context - Context of the request + @param destinationID string - Unique identifier of a destination. + @param destinationUpdate DestinationUpdate + @param opts ...Option - 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 (c *APIClient) UpdateDestinationWithHTTPInfo(ctx context.Context, r ApiUpdateDestinationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6945,18 +7074,21 @@ func (c *APIClient) NewApiUpdateSourceRequest(sourceID string, sourceUpdate *Sou /* UpdateSource calls the API and returns the raw response from it. -Updates a source by its ID. + Updates a source by its ID. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings -Request can be constructed by NewApiUpdateSourceRequest with parameters below. - - @param sourceID string - Unique identifier of a source. - @param sourceUpdate SourceUpdate - @return SourceUpdateResponse + Request can be constructed by NewApiUpdateSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceID string - Unique identifier of a source. + @param sourceUpdate SourceUpdate + @param opts ...Option - 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 (c *APIClient) UpdateSourceWithHTTPInfo(ctx context.Context, r ApiUpdateSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7115,13 +7247,17 @@ func (c *APIClient) NewApiUpdateTaskRequest(taskID string, taskUpdate *TaskUpdat /* UpdateTask calls the API and returns the raw response from it. -Updates a task by its ID. + Updates a task by its ID. -Request can be constructed by NewApiUpdateTaskRequest with parameters below. - @param taskID string - Unique identifier of a task. - @param taskUpdate TaskUpdate - @return TaskUpdateResponse + Request can be constructed by NewApiUpdateTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID string - Unique identifier of a task. + @param taskUpdate TaskUpdate + @param opts ...Option - 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 (c *APIClient) UpdateTaskWithHTTPInfo(ctx context.Context, r ApiUpdateTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7270,13 +7406,17 @@ func (c *APIClient) NewApiUpdateTransformationRequest(transformationID string, t /* UpdateTransformation calls the API and returns the raw response from it. -Updates a transformation by its ID. + Updates a transformation by its ID. -Request can be constructed by NewApiUpdateTransformationRequest with parameters below. - @param transformationID string - Unique identifier of a transformation. - @param transformationCreate TransformationCreate - @return TransformationUpdateResponse + Request can be constructed by NewApiUpdateTransformationRequest with parameters below. + @param ctx context.Context - Context of the request + @param transformationID string - Unique identifier of a transformation. + @param transformationCreate TransformationCreate + @param opts ...Option - 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 (c *APIClient) UpdateTransformationWithHTTPInfo(ctx context.Context, r ApiUpdateTransformationRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7413,17 +7553,21 @@ func (r ApiValidateSourceRequest) WithSourceCreate(sourceCreate *SourceCreate) A /* ValidateSource calls the API and returns the raw response from it. -Validates a source payload to ensure it can be created and that the data source can be reached by Algolia. + Validates a source payload to ensure it can be created and that the data source can be reached by Algolia. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings -Request can be constructed by NewApiValidateSourceRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceCreate SourceCreate - - @return SourceWatchResponse + Request can be constructed by NewApiValidateSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceCreate SourceCreate - + @param opts ...Option - 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 (c *APIClient) ValidateSourceWithHTTPInfo(ctx context.Context, r ApiValidateSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7576,18 +7720,22 @@ func (c *APIClient) NewApiValidateSourceBeforeUpdateRequest(sourceID string, sou /* ValidateSourceBeforeUpdate calls the API and returns the raw response from it. -Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia. + Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia. -Required API Key ACLs: - - addObject - - deleteIndex - - editSettings -Request can be constructed by NewApiValidateSourceBeforeUpdateRequest with parameters below. + Required API Key ACLs: + - addObject + - deleteIndex + - editSettings - @param sourceID string - Unique identifier of a source. - @param sourceUpdate SourceUpdate - @return SourceWatchResponse + Request can be constructed by NewApiValidateSourceBeforeUpdateRequest with parameters below. + @param ctx context.Context - Context of the request + @param sourceID string - Unique identifier of a source. + @param sourceUpdate SourceUpdate + @param opts ...Option - 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 (c *APIClient) ValidateSourceBeforeUpdateWithHTTPInfo(ctx context.Context, r ApiValidateSourceBeforeUpdateRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/insights/api_insights.go b/clients/algoliasearch-client-go/algolia/insights/api_insights.go index 812b44c30c..31ba1e91b8 100644 --- a/clients/algoliasearch-client-go/algolia/insights/api_insights.go +++ b/clients/algoliasearch-client-go/algolia/insights/api_insights.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -738,12 +754,17 @@ func (c *APIClient) NewApiDeleteUserTokenRequest(userToken string) ApiDeleteUser /* DeleteUserToken calls the API and returns the raw response from it. -Deletes all events related to the specified user token from events metrics and analytics. -To delete a personalization user profile, see [Delete a user profile](/specs/personalization#tag/profiles/operation/deleteUserProfile). + Deletes all events related to the specified user token from events metrics and analytics. -Request can be constructed by NewApiDeleteUserTokenRequest with parameters below. +To delete a personalization user profile, see [Delete a user profile](/specs/personalization#tag/profiles/operation/deleteUserProfile). - @param userToken string - User token for which to delete all associated events. + Request can be constructed by NewApiDeleteUserTokenRequest with parameters below. + @param ctx context.Context - Context of the request + @param userToken string - User token for which to delete all associated events. + @param opts ...Option - 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 (c *APIClient) DeleteUserTokenWithHTTPInfo(ctx context.Context, r ApiDeleteUserTokenRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -872,15 +893,18 @@ func (c *APIClient) NewApiPushEventsRequest(insightsEvents *InsightsEvents) ApiP /* PushEvents calls the API and returns the raw response from it. -Sends a list of events to the Insights API. + Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB. -Request can be constructed by NewApiPushEventsRequest with parameters below. - - @param insightsEvents InsightsEvents - @return EventsResponse + Request can be constructed by NewApiPushEventsRequest with parameters below. + @param ctx context.Context - Context of the request + @param insightsEvents InsightsEvents + @param opts ...Option - 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 (c *APIClient) PushEventsWithHTTPInfo(ctx context.Context, r ApiPushEventsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/monitoring/api_monitoring.go b/clients/algoliasearch-client-go/algolia/monitoring/api_monitoring.go index 1117d2c87e..bc674ef654 100644 --- a/clients/algoliasearch-client-go/algolia/monitoring/api_monitoring.go +++ b/clients/algoliasearch-client-go/algolia/monitoring/api_monitoring.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -738,12 +754,16 @@ func (c *APIClient) NewApiGetClusterIncidentsRequest(clusters string) ApiGetClus /* GetClusterIncidents calls the API and returns the raw response from it. -Retrieves known incidents for the selected clusters. + Retrieves known incidents for the selected clusters. -Request can be constructed by NewApiGetClusterIncidentsRequest with parameters below. - @param clusters string - Subset of clusters, separated by comma. - @return IncidentsResponse + Request can be constructed by NewApiGetClusterIncidentsRequest with parameters below. + @param ctx context.Context - Context of the request + @param clusters string - Subset of clusters, separated by comma. + @param opts ...Option - 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 (c *APIClient) GetClusterIncidentsWithHTTPInfo(ctx context.Context, r ApiGetClusterIncidentsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -868,12 +888,16 @@ func (c *APIClient) NewApiGetClusterStatusRequest(clusters string) ApiGetCluster /* GetClusterStatus calls the API and returns the raw response from it. -Retrieves the status of selected clusters. + Retrieves the status of selected clusters. -Request can be constructed by NewApiGetClusterStatusRequest with parameters below. - @param clusters string - Subset of clusters, separated by comma. - @return StatusResponse + Request can be constructed by NewApiGetClusterStatusRequest with parameters below. + @param ctx context.Context - Context of the request + @param clusters string - Subset of clusters, separated by comma. + @param opts ...Option - 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 (c *APIClient) GetClusterStatusWithHTTPInfo(ctx context.Context, r ApiGetClusterStatusRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -967,11 +991,15 @@ func (c *APIClient) GetClusterStatusWithContext(ctx context.Context, r ApiGetClu /* GetIncidents calls the API and returns the raw response from it. -Retrieves known incidents for all clusters. + Retrieves known incidents for all clusters. -Request can be constructed by NewApiGetIncidentsRequest with parameters below. - @return IncidentsResponse + Request can be constructed by NewApiGetIncidentsRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetIncidentsWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1090,12 +1118,16 @@ func (c *APIClient) NewApiGetIndexingTimeRequest(clusters string) ApiGetIndexing /* GetIndexingTime calls the API and returns the raw response from it. -Retrieves average times for indexing operations for selected clusters. + Retrieves average times for indexing operations for selected clusters. -Request can be constructed by NewApiGetIndexingTimeRequest with parameters below. - @param clusters string - Subset of clusters, separated by comma. - @return IndexingTimeResponse + Request can be constructed by NewApiGetIndexingTimeRequest with parameters below. + @param ctx context.Context - Context of the request + @param clusters string - Subset of clusters, separated by comma. + @param opts ...Option - 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 (c *APIClient) GetIndexingTimeWithHTTPInfo(ctx context.Context, r ApiGetIndexingTimeRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1220,12 +1252,16 @@ func (c *APIClient) NewApiGetLatencyRequest(clusters string) ApiGetLatencyReques /* GetLatency calls the API and returns the raw response from it. -Retrieves the average latency for search requests for selected clusters. + Retrieves the average latency for search requests for selected clusters. -Request can be constructed by NewApiGetLatencyRequest with parameters below. - @param clusters string - Subset of clusters, separated by comma. - @return LatencyResponse + Request can be constructed by NewApiGetLatencyRequest with parameters below. + @param ctx context.Context - Context of the request + @param clusters string - Subset of clusters, separated by comma. + @param opts ...Option - 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 (c *APIClient) GetLatencyWithHTTPInfo(ctx context.Context, r ApiGetLatencyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1361,16 +1397,19 @@ func (c *APIClient) NewApiGetMetricsRequest(metric Metric, period Period) ApiGet /* GetMetrics calls the API and returns the raw response from it. -Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. + Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key). -Request can be constructed by NewApiGetMetricsRequest with parameters below. - - @param metric Metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. - @param period Period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. - @return InfrastructureResponse + Request can be constructed by NewApiGetMetricsRequest with parameters below. + @param ctx context.Context - Context of the request + @param metric Metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. + @param period Period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. + @param opts ...Option - 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 (c *APIClient) GetMetricsWithHTTPInfo(ctx context.Context, r ApiGetMetricsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1501,12 +1540,16 @@ func (c *APIClient) NewApiGetReachabilityRequest(clusters string) ApiGetReachabi /* GetReachability calls the API and returns the raw response from it. -Test whether clusters are reachable or not. + Test whether clusters are reachable or not. -Request can be constructed by NewApiGetReachabilityRequest with parameters below. - @param clusters string - Subset of clusters, separated by comma. - @return map[string]map[string]bool + Request can be constructed by NewApiGetReachabilityRequest with parameters below. + @param ctx context.Context - Context of the request + @param clusters string - Subset of clusters, separated by comma. + @param opts ...Option - 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 (c *APIClient) GetReachabilityWithHTTPInfo(ctx context.Context, r ApiGetReachabilityRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1600,7 +1643,7 @@ func (c *APIClient) GetReachabilityWithContext(ctx context.Context, r ApiGetReac /* GetServers calls the API and returns the raw response from it. -Retrieves the servers that belong to clusters. + Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: @@ -1610,9 +1653,12 @@ Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters. -Request can be constructed by NewApiGetServersRequest with parameters below. - - @return InventoryResponse + Request can be constructed by NewApiGetServersRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetServersWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1716,11 +1762,15 @@ func (c *APIClient) GetServersWithContext(ctx context.Context, opts ...Option) ( /* GetStatus calls the API and returns the raw response from it. -Retrieves the status of all Algolia clusters and instances. + Retrieves the status of all Algolia clusters and instances. -Request can be constructed by NewApiGetStatusRequest with parameters below. - @return StatusResponse + Request can be constructed by NewApiGetStatusRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetStatusWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/personalization/api_personalization.go b/clients/algoliasearch-client-go/algolia/personalization/api_personalization.go index 8fae0f5281..2f3f503718 100644 --- a/clients/algoliasearch-client-go/algolia/personalization/api_personalization.go +++ b/clients/algoliasearch-client-go/algolia/personalization/api_personalization.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -738,17 +754,20 @@ func (c *APIClient) NewApiDeleteUserProfileRequest(userToken string) ApiDeleteUs /* DeleteUserProfile calls the API and returns the raw response from it. -Deletes a user profile. + Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. -Required API Key ACLs: - - recommendation + Required API Key ACLs: + - recommendation -Request can be constructed by NewApiDeleteUserProfileRequest with parameters below. - - @param userToken string - Unique identifier representing a user for which to fetch the personalization profile. - @return DeleteUserProfileResponse + Request can be constructed by NewApiDeleteUserProfileRequest with parameters below. + @param ctx context.Context - Context of the request + @param userToken string - Unique identifier representing a user for which to fetch the personalization profile. + @param opts ...Option - 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 (c *APIClient) DeleteUserProfileWithHTTPInfo(ctx context.Context, r ApiDeleteUserProfileRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -852,14 +871,17 @@ func (c *APIClient) DeleteUserProfileWithContext(ctx context.Context, r ApiDelet /* GetPersonalizationStrategy calls the API and returns the raw response from it. -Retrieves the current personalization strategy. - -Required API Key ACLs: - - recommendation + Retrieves the current personalization strategy. -Request can be constructed by NewApiGetPersonalizationStrategyRequest with parameters below. + Required API Key ACLs: + - recommendation - @return PersonalizationStrategyParams + Request can be constructed by NewApiGetPersonalizationStrategyRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetPersonalizationStrategyWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -984,15 +1006,18 @@ func (c *APIClient) NewApiGetUserTokenProfileRequest(userToken string) ApiGetUse /* GetUserTokenProfile calls the API and returns the raw response from it. -Retrieves a user profile and their affinities for different facets. - -Required API Key ACLs: - - recommendation + Retrieves a user profile and their affinities for different facets. -Request can be constructed by NewApiGetUserTokenProfileRequest with parameters below. + Required API Key ACLs: + - recommendation - @param userToken string - Unique identifier representing a user for which to fetch the personalization profile. - @return GetUserTokenResponse + Request can be constructed by NewApiGetUserTokenProfileRequest with parameters below. + @param ctx context.Context - Context of the request + @param userToken string - Unique identifier representing a user for which to fetch the personalization profile. + @param opts ...Option - 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 (c *APIClient) GetUserTokenProfileWithHTTPInfo(ctx context.Context, r ApiGetUserTokenProfileRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1128,15 +1153,18 @@ func (c *APIClient) NewApiSetPersonalizationStrategyRequest(personalizationStrat /* SetPersonalizationStrategy calls the API and returns the raw response from it. -Creates a new personalization strategy. - -Required API Key ACLs: - - recommendation + Creates a new personalization strategy. -Request can be constructed by NewApiSetPersonalizationStrategyRequest with parameters below. + Required API Key ACLs: + - recommendation - @param personalizationStrategyParams PersonalizationStrategyParams - @return SetPersonalizationStrategyResponse + Request can be constructed by NewApiSetPersonalizationStrategyRequest with parameters below. + @param ctx context.Context - Context of the request + @param personalizationStrategyParams PersonalizationStrategyParams + @param opts ...Option - 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 (c *APIClient) SetPersonalizationStrategyWithHTTPInfo(ctx context.Context, r ApiSetPersonalizationStrategyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/query-suggestions/api_query_suggestions.go b/clients/algoliasearch-client-go/algolia/query-suggestions/api_query_suggestions.go index 10d450082b..e7272dadbd 100644 --- a/clients/algoliasearch-client-go/algolia/query-suggestions/api_query_suggestions.go +++ b/clients/algoliasearch-client-go/algolia/query-suggestions/api_query_suggestions.go @@ -73,17 +73,20 @@ func (c *APIClient) NewApiCreateConfigRequest(querySuggestionsConfigurationWithI /* CreateConfig calls the API and returns the raw response from it. -Creates a new Query Suggestions configuration. + 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. + Required API Key ACLs: + - editSettings - @param querySuggestionsConfigurationWithIndex QuerySuggestionsConfigurationWithIndex - @return BaseResponse + Request can be constructed by NewApiCreateConfigRequest with parameters below. + @param ctx context.Context - Context of the request + @param querySuggestionsConfigurationWithIndex QuerySuggestionsConfigurationWithIndex + @param opts ...Option - 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 (c *APIClient) CreateConfigWithHTTPInfo(ctx context.Context, r ApiCreateConfigRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -236,13 +239,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -391,13 +398,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -562,14 +573,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -742,14 +757,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -890,18 +909,21 @@ func (c *APIClient) NewApiDeleteConfigRequest(indexName string) ApiDeleteConfigR /* DeleteConfig calls the API and returns the raw response from it. -Deletes a Query Suggestions configuration. + 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](/specs/search#tag/Indices/operation/deleteIndex) operation. -Required API Key ACLs: - - editSettings + Required API Key ACLs: + - editSettings -Request can be constructed by NewApiDeleteConfigRequest with parameters below. - - @param indexName string - Query Suggestions index name. - @return BaseResponse + Request can be constructed by NewApiDeleteConfigRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Query Suggestions index name. + @param opts ...Option - 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 (c *APIClient) DeleteConfigWithHTTPInfo(ctx context.Context, r ApiDeleteConfigRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1007,14 +1029,17 @@ func (c *APIClient) DeleteConfigWithContext(ctx context.Context, r ApiDeleteConf /* GetAllConfigs calls the API and returns the raw response from it. -Retrieves all Query Suggestions configurations of your Algolia application. + Retrieves all Query Suggestions configurations of your Algolia application. -Required API Key ACLs: - - settings - -Request can be constructed by NewApiGetAllConfigsRequest with parameters below. + Required API Key ACLs: + - settings - @return []QuerySuggestionsConfigurationResponse + Request can be constructed by NewApiGetAllConfigsRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetAllConfigsWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1139,15 +1164,18 @@ func (c *APIClient) NewApiGetConfigRequest(indexName string) ApiGetConfigRequest /* 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 + Retrieves a single Query Suggestions configuration by its index name. -Request can be constructed by NewApiGetConfigRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Query Suggestions index name. - @return QuerySuggestionsConfigurationResponse + Request can be constructed by NewApiGetConfigRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Query Suggestions index name. + @param opts ...Option - 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 (c *APIClient) GetConfigWithHTTPInfo(ctx context.Context, r ApiGetConfigRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1278,15 +1306,18 @@ func (c *APIClient) NewApiGetConfigStatusRequest(indexName string) ApiGetConfigS /* GetConfigStatus calls the API and returns the raw response from it. -Reports the status of a Query Suggestions index. + Reports the status of a Query Suggestions index. -Required API Key ACLs: - - settings - -Request can be constructed by NewApiGetConfigStatusRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Query Suggestions index name. - @return GetConfigStatus200Response + Request can be constructed by NewApiGetConfigStatusRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Query Suggestions index name. + @param opts ...Option - 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 (c *APIClient) GetConfigStatusWithHTTPInfo(ctx context.Context, r ApiGetConfigStatusRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1417,15 +1448,18 @@ func (c *APIClient) NewApiGetLogFileRequest(indexName string) ApiGetLogFileReque /* GetLogFile calls the API and returns the raw response from it. -Retrieves the logs for a single Query Suggestions index. + Retrieves the logs for a single Query Suggestions index. -Required API Key ACLs: - - settings + Required API Key ACLs: + - settings -Request can be constructed by NewApiGetLogFileRequest with parameters below. - - @param indexName string - Query Suggestions index name. - @return GetLogFile200Response + Request can be constructed by NewApiGetLogFileRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Query Suggestions index name. + @param opts ...Option - 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 (c *APIClient) GetLogFileWithHTTPInfo(ctx context.Context, r ApiGetLogFileRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1572,16 +1606,19 @@ func (c *APIClient) NewApiUpdateConfigRequest(indexName string, querySuggestions /* UpdateConfig calls the API and returns the raw response from it. -Updates a QuerySuggestions configuration. - -Required API Key ACLs: - - editSettings + Updates a QuerySuggestions configuration. -Request can be constructed by NewApiUpdateConfigRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Query Suggestions index name. - @param querySuggestionsConfiguration QuerySuggestionsConfiguration - @return BaseResponse + Request can be constructed by NewApiUpdateConfigRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Query Suggestions index name. + @param querySuggestionsConfiguration QuerySuggestionsConfiguration + @param opts ...Option - 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 (c *APIClient) UpdateConfigWithHTTPInfo(ctx context.Context, r ApiUpdateConfigRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/recommend/api_recommend.go b/clients/algoliasearch-client-go/algolia/recommend/api_recommend.go index ca46c7712b..95ff78d785 100644 --- a/clients/algoliasearch-client-go/algolia/recommend/api_recommend.go +++ b/clients/algoliasearch-client-go/algolia/recommend/api_recommend.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -760,17 +776,20 @@ func (c *APIClient) NewApiDeleteRecommendRuleRequest(indexName string, model Rec /* DeleteRecommendRule calls the API and returns the raw response from it. -Deletes a Recommend rule from a recommendation scenario. - -Required API Key ACLs: - - editSettings + Deletes a Recommend rule from a recommendation scenario. -Request can be constructed by NewApiDeleteRecommendRuleRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). - @param objectID string - Unique record identifier. - @return DeletedAtResponse + Request can be constructed by NewApiDeleteRecommendRuleRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). + @param objectID string - Unique record identifier. + @param opts ...Option - 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 (c *APIClient) DeleteRecommendRuleWithHTTPInfo(ctx context.Context, r ApiDeleteRecommendRuleRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -933,17 +952,20 @@ func (c *APIClient) NewApiGetRecommendRuleRequest(indexName string, model Recomm /* GetRecommendRule calls the API and returns the raw response from it. -Retrieves a Recommend rule that you previously created in the Algolia dashboard. - -Required API Key ACLs: - - settings + Retrieves a Recommend rule that you previously created in the Algolia dashboard. -Request can be constructed by NewApiGetRecommendRuleRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Name of the index on which to perform the operation. - @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). - @param objectID string - Unique record identifier. - @return RecommendRule + Request can be constructed by NewApiGetRecommendRuleRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). + @param objectID string - Unique record identifier. + @param opts ...Option - 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 (c *APIClient) GetRecommendRuleWithHTTPInfo(ctx context.Context, r ApiGetRecommendRuleRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1106,21 +1128,24 @@ func (c *APIClient) NewApiGetRecommendStatusRequest(indexName string, model Reco /* GetRecommendStatus calls the API and returns the raw response from it. -Checks the status of a given task. + Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiGetRecommendStatusRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). - @param taskID int64 - Unique task identifier. - @return GetRecommendTaskResponse + Required API Key ACLs: + - editSettings + + Request can be constructed by NewApiGetRecommendStatusRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). + @param taskID int64 - Unique task identifier. + @param opts ...Option - 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 (c *APIClient) GetRecommendStatusWithHTTPInfo(ctx context.Context, r ApiGetRecommendStatusRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1270,15 +1295,19 @@ func (c *APIClient) NewApiGetRecommendationsRequest(getRecommendationsParams *Ge /* GetRecommendations calls the API and returns the raw response from it. -Retrieves recommendations from selected AI models. + Retrieves recommendations from selected AI models. -Required API Key ACLs: - - search -Request can be constructed by NewApiGetRecommendationsRequest with parameters below. + Required API Key ACLs: + - search - @param getRecommendationsParams GetRecommendationsParams - @return GetRecommendationsResponse + Request can be constructed by NewApiGetRecommendationsRequest with parameters below. + @param ctx context.Context - Context of the request + @param getRecommendationsParams GetRecommendationsParams + @param opts ...Option - 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 (c *APIClient) GetRecommendationsWithHTTPInfo(ctx context.Context, r ApiGetRecommendationsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1438,19 +1467,22 @@ func (r ApiSearchRecommendRulesRequest) WithSearchRecommendRulesParams(searchRec /* SearchRecommendRules calls the API and returns the raw response from it. -Searches for Recommend rules. + Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario. -Required API Key ACLs: - - settings - -Request can be constructed by NewApiSearchRecommendRulesRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). - @param searchRecommendRulesParams SearchRecommendRulesParams - @return SearchRecommendRulesResponse + Required API Key ACLs: + - settings + + Request can be constructed by NewApiSearchRecommendRulesRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param model RecommendModels - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). + @param searchRecommendRulesParams SearchRecommendRulesParams + @param opts ...Option - 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 (c *APIClient) SearchRecommendRulesWithHTTPInfo(ctx context.Context, r ApiSearchRecommendRulesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/search/api_search.go b/clients/algoliasearch-client-go/algolia/search/api_search.go index ec66c32ca9..dc389fa307 100644 --- a/clients/algoliasearch-client-go/algolia/search/api_search.go +++ b/clients/algoliasearch-client-go/algolia/search/api_search.go @@ -84,15 +84,18 @@ func (c *APIClient) NewApiAddApiKeyRequest(apiKey *ApiKey) ApiAddApiKeyRequest { /* AddApiKey calls the API and returns the raw response from it. -Creates a new API key with specific permissions and restrictions. - -Required API Key ACLs: - - admin + Creates a new API key with specific permissions and restrictions. -Request can be constructed by NewApiAddApiKeyRequest with parameters below. + Required API Key ACLs: + - admin - @param apiKey ApiKey - @return AddApiKeyResponse + Request can be constructed by NewApiAddApiKeyRequest with parameters below. + @param ctx context.Context - Context of the request + @param apiKey ApiKey + @param opts ...Option - 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 (c *APIClient) AddApiKeyWithHTTPInfo(ctx context.Context, r ApiAddApiKeyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -252,21 +255,25 @@ func (c *APIClient) NewApiAddOrUpdateObjectRequest(indexName string, objectID st /* AddOrUpdateObject calls the API and returns the raw response from it. -If a record with the specified object ID exists, the existing record is replaced. + If a record with the specified object ID exists, the existing record is replaced. + Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). -Required API Key ACLs: - - addObject - -Request can be constructed by NewApiAddOrUpdateObjectRequest with parameters below. + Required API Key ACLs: + - addObject - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique record identifier. - @param body map[string]any - The record, a schemaless object with attributes that are useful in the context of search and discovery. - @return UpdatedAtWithObjectIdResponse + Request can be constructed by NewApiAddOrUpdateObjectRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique record identifier. + @param body map[string]any - The record, a schemaless object with attributes that are useful in the context of search and discovery. + @param opts ...Option - 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 (c *APIClient) AddOrUpdateObjectWithHTTPInfo(ctx context.Context, r ApiAddOrUpdateObjectRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -424,15 +431,18 @@ func (c *APIClient) NewApiAppendSourceRequest(source *Source) ApiAppendSourceReq /* AppendSource calls the API and returns the raw response from it. -Adds a source to the list of allowed sources. - -Required API Key ACLs: - - admin + Adds a source to the list of allowed sources. -Request can be constructed by NewApiAppendSourceRequest with parameters below. + Required API Key ACLs: + - admin - @param source Source - Source to add. - @return CreatedAtResponse + Request can be constructed by NewApiAppendSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param source Source - Source to add. + @param opts ...Option - 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 (c *APIClient) AppendSourceWithHTTPInfo(ctx context.Context, r ApiAppendSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -581,18 +591,21 @@ func (c *APIClient) NewApiAssignUserIdRequest(xAlgoliaUserID string, assignUserI /* AssignUserId calls the API and returns the raw response from it. -Assigns or moves a user ID to a cluster. + Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. -Required API Key ACLs: - - admin + Required API Key ACLs: + - admin -Request can be constructed by NewApiAssignUserIdRequest with parameters below. - - @param xAlgoliaUserID string - Unique identifier of the user who makes the search request. - @param assignUserIdParams AssignUserIdParams - @return CreatedAtResponse + Request can be constructed by NewApiAssignUserIdRequest with parameters below. + @param ctx context.Context - Context of the request + @param xAlgoliaUserID string - Unique identifier of the user who makes the search request. + @param assignUserIdParams AssignUserIdParams + @param opts ...Option - 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 (c *APIClient) AssignUserIdWithHTTPInfo(ctx context.Context, r ApiAssignUserIdRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -752,18 +765,21 @@ func (c *APIClient) NewApiBatchRequest(indexName string, batchWriteParams *Batch /* Batch calls the API and returns the raw response from it. -Adds, updates, or deletes records in one index with a single API request. + Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. -Request can be constructed by NewApiBatchRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param batchWriteParams BatchWriteParams - @return BatchResponse + Request can be constructed by NewApiBatchRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param batchWriteParams BatchWriteParams + @param opts ...Option - 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 (c *APIClient) BatchWithHTTPInfo(ctx context.Context, r ApiBatchRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -922,18 +938,21 @@ func (c *APIClient) NewApiBatchAssignUserIdsRequest(xAlgoliaUserID string, batch /* BatchAssignUserIds calls the API and returns the raw response from it. -Assigns multiple user IDs to a cluster. + Assigns multiple user IDs to a cluster. **You can't move users with this operation**. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiBatchAssignUserIdsRequest with parameters below. + Required API Key ACLs: + - admin - @param xAlgoliaUserID string - Unique identifier of the user who makes the search request. - @param batchAssignUserIdsParams BatchAssignUserIdsParams - @return CreatedAtResponse + Request can be constructed by NewApiBatchAssignUserIdsRequest with parameters below. + @param ctx context.Context - Context of the request + @param xAlgoliaUserID string - Unique identifier of the user who makes the search request. + @param batchAssignUserIdsParams BatchAssignUserIdsParams + @param opts ...Option - 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 (c *APIClient) BatchAssignUserIdsWithHTTPInfo(ctx context.Context, r ApiBatchAssignUserIdsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1093,16 +1112,19 @@ func (c *APIClient) NewApiBatchDictionaryEntriesRequest(dictionaryName Dictionar /* BatchDictionaryEntries calls the API and returns the raw response from it. -Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. + Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiBatchDictionaryEntriesRequest with parameters below. + Required API Key ACLs: + - editSettings - @param dictionaryName DictionaryType - Dictionary type in which to search. - @param batchDictionaryEntriesParams BatchDictionaryEntriesParams - @return UpdatedAtResponse + Request can be constructed by NewApiBatchDictionaryEntriesRequest with parameters below. + @param ctx context.Context - Context of the request + @param dictionaryName DictionaryType - Dictionary type in which to search. + @param batchDictionaryEntriesParams BatchDictionaryEntriesParams + @param opts ...Option - 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 (c *APIClient) BatchDictionaryEntriesWithHTTPInfo(ctx context.Context, r ApiBatchDictionaryEntriesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1254,7 +1276,7 @@ func (r ApiBrowseRequest) WithBrowseParams(browseParams *BrowseParams) ApiBrowse /* Browse calls the API and returns the raw response from it. -Retrieves records from an index, up to 1,000 per request. + Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. @@ -1265,14 +1287,17 @@ This can be useful if you want to export your indices. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. -Required API Key ACLs: - - browse - -Request can be constructed by NewApiBrowseRequest with parameters below. + Required API Key ACLs: + - browse - @param indexName string - Name of the index on which to perform the operation. - @param browseParams BrowseParams - @return BrowseResponse + Request can be constructed by NewApiBrowseRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param browseParams BrowseParams + @param opts ...Option - 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 (c *APIClient) BrowseWithHTTPInfo(ctx context.Context, r ApiBrowseRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1429,15 +1454,18 @@ func (c *APIClient) NewApiClearObjectsRequest(indexName string) ApiClearObjectsR /* ClearObjects calls the API and returns the raw response from it. -Deletes only the records from an index while keeping settings, synonyms, and rules. - -Required API Key ACLs: - - deleteIndex + Deletes only the records from an index while keeping settings, synonyms, and rules. -Request can be constructed by NewApiClearObjectsRequest with parameters below. + Required API Key ACLs: + - deleteIndex - @param indexName string - Name of the index on which to perform the operation. - @return UpdatedAtResponse + Request can be constructed by NewApiClearObjectsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param opts ...Option - 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 (c *APIClient) ClearObjectsWithHTTPInfo(ctx context.Context, r ApiClearObjectsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1584,16 +1612,19 @@ func (r ApiClearRulesRequest) WithForwardToReplicas(forwardToReplicas bool) ApiC /* ClearRules calls the API and returns the raw response from it. -Deletes all rules from the index. - -Required API Key ACLs: - - editSettings + Deletes all rules from the index. -Request can be constructed by NewApiClearRulesRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return UpdatedAtResponse + Request can be constructed by NewApiClearRulesRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) ClearRulesWithHTTPInfo(ctx context.Context, r ApiClearRulesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1746,16 +1777,19 @@ func (r ApiClearSynonymsRequest) WithForwardToReplicas(forwardToReplicas bool) A /* ClearSynonyms calls the API and returns the raw response from it. -Deletes all synonyms from the index. + Deletes all synonyms from the index. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiClearSynonymsRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return UpdatedAtResponse + Request can be constructed by NewApiClearSynonymsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) ClearSynonymsWithHTTPInfo(ctx context.Context, r ApiClearSynonymsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -1908,13 +1942,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2063,13 +2101,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2234,14 +2276,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2414,14 +2460,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2562,15 +2612,18 @@ func (c *APIClient) NewApiDeleteApiKeyRequest(key string) ApiDeleteApiKeyRequest /* DeleteApiKey calls the API and returns the raw response from it. -Deletes the API key. + Deletes the API key. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiDeleteApiKeyRequest with parameters below. + Required API Key ACLs: + - admin - @param key string - API key. - @return DeleteApiKeyResponse + Request can be constructed by NewApiDeleteApiKeyRequest with parameters below. + @param ctx context.Context - Context of the request + @param key string - API key. + @param opts ...Option - 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 (c *APIClient) DeleteApiKeyWithHTTPInfo(ctx context.Context, r ApiDeleteApiKeyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2717,19 +2770,22 @@ func (c *APIClient) NewApiDeleteByRequest(indexName string, deleteByParams *Dele /* DeleteBy calls the API and returns the raw response from it. -This operation doesn't accept empty queries or filters. + This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch). -Required API Key ACLs: - - deleteIndex + Required API Key ACLs: + - deleteIndex -Request can be constructed by NewApiDeleteByRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param deleteByParams DeleteByParams - @return DeletedAtResponse + Request can be constructed by NewApiDeleteByRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param deleteByParams DeleteByParams + @param opts ...Option - 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 (c *APIClient) DeleteByWithHTTPInfo(ctx context.Context, r ApiDeleteByRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -2874,21 +2930,28 @@ func (c *APIClient) NewApiDeleteIndexRequest(indexName string) ApiDeleteIndexReq /* DeleteIndex calls the API and returns the raw response from it. -Deletes an index and all its settings. + Deletes an index and all its settings. - - Deleting an index doesn't delete its analytics data. - - If you try to delete a non-existing index, the operation is ignored without warning. - - If the index you want to delete has replica indices, the replicas become independent indices. - - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. - For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). + - Deleting an index doesn't delete its analytics data. -Required API Key ACLs: - - deleteIndex + - If you try to delete a non-existing index, the operation is ignored without warning. -Request can be constructed by NewApiDeleteIndexRequest with parameters below. + - If the index you want to delete has replica indices, the replicas become independent indices. - @param indexName string - Name of the index on which to perform the operation. - @return DeletedAtResponse + - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. + For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). + + Required API Key ACLs: + + - deleteIndex + + Request can be constructed by NewApiDeleteIndexRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param opts ...Option - 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 (c *APIClient) DeleteIndexWithHTTPInfo(ctx context.Context, r ApiDeleteIndexRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3042,19 +3105,22 @@ func (c *APIClient) NewApiDeleteObjectRequest(indexName string, objectID string) /* DeleteObject calls the API and returns the raw response from it. -Deletes a record by its object ID. + Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy). -Required API Key ACLs: - - deleteObject + Required API Key ACLs: + - deleteObject -Request can be constructed by NewApiDeleteObjectRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique record identifier. - @return DeletedAtResponse + Request can be constructed by NewApiDeleteObjectRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique record identifier. + @param opts ...Option - 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 (c *APIClient) DeleteObjectWithHTTPInfo(ctx context.Context, r ApiDeleteObjectRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3224,19 +3290,23 @@ func (r ApiDeleteRuleRequest) WithForwardToReplicas(forwardToReplicas bool) ApiD /* DeleteRule calls the API and returns the raw response from it. -Deletes a rule by its ID. + Deletes a rule by its ID. + To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules). -Required API Key ACLs: - - editSettings + Required API Key ACLs: + - editSettings -Request can be constructed by NewApiDeleteRuleRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a rule object. - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return UpdatedAtResponse + Request can be constructed by NewApiDeleteRuleRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a rule object. + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) DeleteRuleWithHTTPInfo(ctx context.Context, r ApiDeleteRuleRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3383,15 +3453,18 @@ func (c *APIClient) NewApiDeleteSourceRequest(source string) ApiDeleteSourceRequ /* DeleteSource calls the API and returns the raw response from it. -Deletes a source from the list of allowed sources. - -Required API Key ACLs: - - admin + Deletes a source from the list of allowed sources. -Request can be constructed by NewApiDeleteSourceRequest with parameters below. + Required API Key ACLs: + - admin - @param source string - IP address range of the source. - @return DeleteSourceResponse + Request can be constructed by NewApiDeleteSourceRequest with parameters below. + @param ctx context.Context - Context of the request + @param source string - IP address range of the source. + @param opts ...Option - 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 (c *APIClient) DeleteSourceWithHTTPInfo(ctx context.Context, r ApiDeleteSourceRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3549,18 +3622,22 @@ func (r ApiDeleteSynonymRequest) WithForwardToReplicas(forwardToReplicas bool) A /* DeleteSynonym calls the API and returns the raw response from it. -Deletes a synonym by its ID. -To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + Deletes a synonym by its ID. -Required API Key ACLs: - - editSettings +To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). -Request can be constructed by NewApiDeleteSynonymRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a synonym object. - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return DeletedAtResponse + Request can be constructed by NewApiDeleteSynonymRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a synonym object. + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) DeleteSynonymWithHTTPInfo(ctx context.Context, r ApiDeleteSynonymRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3705,15 +3782,18 @@ func (c *APIClient) NewApiGetApiKeyRequest(key string) ApiGetApiKeyRequest { /* GetApiKey calls the API and returns the raw response from it. -Gets the permissions and restrictions of an API key. + Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. -Request can be constructed by NewApiGetApiKeyRequest with parameters below. - - @param key string - API key. - @return GetApiKeyResponse + Request can be constructed by NewApiGetApiKeyRequest with parameters below. + @param ctx context.Context - Context of the request + @param key string - API key. + @param opts ...Option - 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 (c *APIClient) GetApiKeyWithHTTPInfo(ctx context.Context, r ApiGetApiKeyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3844,15 +3924,19 @@ func (c *APIClient) NewApiGetAppTaskRequest(taskID int64) ApiGetAppTaskRequest { /* GetAppTask calls the API and returns the raw response from it. -Checks the status of a given application task. + Checks the status of a given application task. -Required API Key ACLs: - - editSettings -Request can be constructed by NewApiGetAppTaskRequest with parameters below. + Required API Key ACLs: + - editSettings - @param taskID int64 - Unique task identifier. - @return GetTaskResponse + Request can be constructed by NewApiGetAppTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param taskID int64 - Unique task identifier. + @param opts ...Option - 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 (c *APIClient) GetAppTaskWithHTTPInfo(ctx context.Context, r ApiGetAppTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -3949,14 +4033,18 @@ func (c *APIClient) GetAppTaskWithContext(ctx context.Context, r ApiGetAppTaskRe /* GetDictionaryLanguages calls the API and returns the raw response from it. -Lists supported languages with their supported dictionary types and number of custom entries. + Lists supported languages with their supported dictionary types and number of custom entries. -Required API Key ACLs: - - settings -Request can be constructed by NewApiGetDictionaryLanguagesRequest with parameters below. + Required API Key ACLs: + - settings - @return map[string]Languages + Request can be constructed by NewApiGetDictionaryLanguagesRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetDictionaryLanguagesWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4050,14 +4138,17 @@ func (c *APIClient) GetDictionaryLanguagesWithContext(ctx context.Context, opts /* GetDictionarySettings calls the API and returns the raw response from it. -Retrieves the languages for which standard dictionary entries are turned off. - -Required API Key ACLs: - - settings + Retrieves the languages for which standard dictionary entries are turned off. -Request can be constructed by NewApiGetDictionarySettingsRequest with parameters below. + Required API Key ACLs: + - settings - @return GetDictionarySettingsResponse + Request can be constructed by NewApiGetDictionarySettingsRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetDictionarySettingsWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4234,22 +4325,25 @@ func (r ApiGetLogsRequest) WithType(type_ LogType) ApiGetLogsRequest { /* GetLogs calls the API and returns the raw response from it. -The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). + The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. -Required API Key ACLs: - - logs - -Request can be constructed by NewApiGetLogsRequest with parameters below. + Required API Key ACLs: + - logs - @param offset int32 - First log entry to retrieve. The most recent entries are listed first. - @param length int32 - Maximum number of entries to retrieve. - @param indexName string - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. - @param type_ LogType - Type of log entries to retrieve. By default, all log entries are retrieved. - @return GetLogsResponse + Request can be constructed by NewApiGetLogsRequest with parameters below. + @param ctx context.Context - Context of the request + @param offset int32 - First log entry to retrieve. The most recent entries are listed first. + @param length int32 - Maximum number of entries to retrieve. + @param indexName string - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. + @param type_ LogType - Type of log entries to retrieve. By default, all log entries are retrieved. + @param opts ...Option - 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 (c *APIClient) GetLogsWithHTTPInfo(ctx context.Context, r ApiGetLogsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4430,19 +4524,22 @@ func (r ApiGetObjectRequest) WithAttributesToRetrieve(attributesToRetrieve []str /* GetObject calls the API and returns the raw response from it. -Retrieves one record by its object ID. + Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). -Required API Key ACLs: - - search - -Request can be constructed by NewApiGetObjectRequest with parameters below. + Required API Key ACLs: + - search - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique record identifier. - @param attributesToRetrieve []string - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. - @return map[string]string + Request can be constructed by NewApiGetObjectRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique record identifier. + @param attributesToRetrieve []string - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. + @param opts ...Option - 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 (c *APIClient) GetObjectWithHTTPInfo(ctx context.Context, r ApiGetObjectRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4594,17 +4691,20 @@ func (c *APIClient) NewApiGetObjectsRequest(getObjectsParams *GetObjectsParams) /* GetObjects calls the API and returns the raw response from it. -Retrieves one or more records, potentially from different indices. + Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. -Required API Key ACLs: - - search - -Request can be constructed by NewApiGetObjectsRequest with parameters below. + Required API Key ACLs: + - search - @param getObjectsParams GetObjectsParams - Request object. - @return GetObjectsResponse + Request can be constructed by NewApiGetObjectsRequest with parameters below. + @param ctx context.Context - Context of the request + @param getObjectsParams GetObjectsParams - Request object. + @param opts ...Option - 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 (c *APIClient) GetObjectsWithHTTPInfo(ctx context.Context, r ApiGetObjectsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4752,17 +4852,21 @@ func (c *APIClient) NewApiGetRuleRequest(indexName string, objectID string) ApiG /* GetRule calls the API and returns the raw response from it. -Retrieves a rule by its ID. -To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). + Retrieves a rule by its ID. -Required API Key ACLs: - - settings +To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). -Request can be constructed by NewApiGetRuleRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a rule object. - @return Rule + Request can be constructed by NewApiGetRuleRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a rule object. + @param opts ...Option - 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 (c *APIClient) GetRuleWithHTTPInfo(ctx context.Context, r ApiGetRuleRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -4901,15 +5005,18 @@ func (c *APIClient) NewApiGetSettingsRequest(indexName string) ApiGetSettingsReq /* GetSettings calls the API and returns the raw response from it. -Retrieves an object with non-null index settings. - -Required API Key ACLs: - - search + Retrieves an object with non-null index settings. -Request can be constructed by NewApiGetSettingsRequest with parameters below. + Required API Key ACLs: + - search - @param indexName string - Name of the index on which to perform the operation. - @return IndexSettings + Request can be constructed by NewApiGetSettingsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param opts ...Option - 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 (c *APIClient) GetSettingsWithHTTPInfo(ctx context.Context, r ApiGetSettingsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5009,14 +5116,17 @@ func (c *APIClient) GetSettingsWithContext(ctx context.Context, r ApiGetSettings /* GetSources calls the API and returns the raw response from it. -Retrieves all allowed IP addresses with access to your application. - -Required API Key ACLs: - - admin + Retrieves all allowed IP addresses with access to your application. -Request can be constructed by NewApiGetSourcesRequest with parameters below. + Required API Key ACLs: + - admin - @return []Source + Request can be constructed by NewApiGetSourcesRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetSourcesWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5152,18 +5262,22 @@ func (c *APIClient) NewApiGetSynonymRequest(indexName string, objectID string) A /* GetSynonym calls the API and returns the raw response from it. -Retrieves a syonym by its ID. + Retrieves a syonym by its ID. + To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). -Required API Key ACLs: - - settings - -Request can be constructed by NewApiGetSynonymRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a synonym object. - @return SynonymHit + Request can be constructed by NewApiGetSynonymRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a synonym object. + @param opts ...Option - 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 (c *APIClient) GetSynonymWithHTTPInfo(ctx context.Context, r ApiGetSynonymRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5315,7 +5429,7 @@ func (c *APIClient) NewApiGetTaskRequest(indexName string, taskID int64) ApiGetT /* GetTask calls the API and returns the raw response from it. -Checks the status of a given task. + Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, @@ -5323,14 +5437,17 @@ a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status. -Required API Key ACLs: - - addObject - -Request can be constructed by NewApiGetTaskRequest with parameters below. + Required API Key ACLs: + - addObject - @param indexName string - Name of the index on which to perform the operation. - @param taskID int64 - Unique task identifier. - @return GetTaskResponse + Request can be constructed by NewApiGetTaskRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param taskID int64 - Unique task identifier. + @param opts ...Option - 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 (c *APIClient) GetTaskWithHTTPInfo(ctx context.Context, r ApiGetTaskRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5445,17 +5562,20 @@ func (c *APIClient) GetTaskWithContext(ctx context.Context, r ApiGetTaskRequest, /* GetTopUserIds calls the API and returns the raw response from it. -Get the IDs of the 10 users with the highest number of records per cluster. + Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiGetTopUserIdsRequest with parameters below. + Required API Key ACLs: + - admin - @return GetTopUserIdsResponse + Request can be constructed by NewApiGetTopUserIdsRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) GetTopUserIdsWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5586,18 +5706,21 @@ func (c *APIClient) NewApiGetUserIdRequest(userID string) ApiGetUserIdRequest { /* GetUserId calls the API and returns the raw response from it. -Returns the user ID data stored in the mapping. + Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiGetUserIdRequest with parameters below. + Required API Key ACLs: + - admin - @param userID string - Unique identifier of the user who makes the search request. - @return UserId + Request can be constructed by NewApiGetUserIdRequest with parameters below. + @param ctx context.Context - Context of the request + @param userID string - Unique identifier of the user who makes the search request. + @param opts ...Option - 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 (c *APIClient) GetUserIdWithHTTPInfo(ctx context.Context, r ApiGetUserIdRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5738,15 +5861,19 @@ func (r ApiHasPendingMappingsRequest) WithGetClusters(getClusters bool) ApiHasPe /* HasPendingMappings calls the API and returns the raw response from it. -To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process. + To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process. -Required API Key ACLs: - - admin -Request can be constructed by NewApiHasPendingMappingsRequest with parameters below. + Required API Key ACLs: + - admin - @param getClusters bool - Whether to include the cluster's pending mapping state in the response. - @return HasPendingMappingsResponse + Request can be constructed by NewApiHasPendingMappingsRequest with parameters below. + @param ctx context.Context - Context of the request + @param getClusters bool - Whether to include the cluster's pending mapping state in the response. + @param opts ...Option - 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 (c *APIClient) HasPendingMappingsWithHTTPInfo(ctx context.Context, r ApiHasPendingMappingsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5846,14 +5973,17 @@ func (c *APIClient) HasPendingMappingsWithContext(ctx context.Context, r ApiHasP /* ListApiKeys calls the API and returns the raw response from it. -Lists all API keys associated with your Algolia application, including their permissions and restrictions. - -Required API Key ACLs: - - admin + Lists all API keys associated with your Algolia application, including their permissions and restrictions. -Request can be constructed by NewApiListApiKeysRequest with parameters below. + Required API Key ACLs: + - admin - @return ListApiKeysResponse + Request can be constructed by NewApiListApiKeysRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) ListApiKeysWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -5947,14 +6077,17 @@ func (c *APIClient) ListApiKeysWithContext(ctx context.Context, opts ...Option) /* ListClusters calls the API and returns the raw response from it. -Lists the available clusters in a multi-cluster setup. - -Required API Key ACLs: - - admin + Lists the available clusters in a multi-cluster setup. -Request can be constructed by NewApiListClustersRequest with parameters below. + Required API Key ACLs: + - admin - @return ListClustersResponse + Request can be constructed by NewApiListClustersRequest with parameters below. + @param ctx context.Context - Context of the request + @param opts ...Option - 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 (c *APIClient) ListClustersWithHTTPInfo(ctx context.Context, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6099,18 +6232,21 @@ func (r ApiListIndicesRequest) WithHitsPerPage(hitsPerPage int32) ApiListIndices /* ListIndices calls the API and returns the raw response from it. -Lists all indices in the current Algolia application. + Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request. -Required API Key ACLs: - - listIndexes - -Request can be constructed by NewApiListIndicesRequest with parameters below. + Required API Key ACLs: + - listIndexes - @param page int32 - Requested page of the API response. If `null`, the API response is not paginated. - @param hitsPerPage int32 - Number of hits per page. - @return ListIndicesResponse + Request can be constructed by NewApiListIndicesRequest with parameters below. + @param ctx context.Context - Context of the request + @param page int32 - Requested page of the API response. If `null`, the API response is not paginated. + @param hitsPerPage int32 - Number of hits per page. + @param opts ...Option - 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 (c *APIClient) ListIndicesWithHTTPInfo(ctx context.Context, r ApiListIndicesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6270,19 +6406,22 @@ func (r ApiListUserIdsRequest) WithHitsPerPage(hitsPerPage int32) ApiListUserIds /* ListUserIds calls the API and returns the raw response from it. -Lists the userIDs assigned to a multi-cluster application. + Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiListUserIdsRequest with parameters below. + Required API Key ACLs: + - admin - @param page int32 - Requested page of the API response. If `null`, the API response is not paginated. - @param hitsPerPage int32 - Number of hits per page. - @return ListUserIdsResponse + Request can be constructed by NewApiListUserIdsRequest with parameters below. + @param ctx context.Context - Context of the request + @param page int32 - Requested page of the API response. If `null`, the API response is not paginated. + @param hitsPerPage int32 - Number of hits per page. + @param opts ...Option - 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 (c *APIClient) ListUserIdsWithHTTPInfo(ctx context.Context, r ApiListUserIdsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6429,15 +6568,18 @@ func (c *APIClient) NewApiMultipleBatchRequest(batchParams *BatchParams) ApiMult /* MultipleBatch calls the API and returns the raw response from it. -Adds, updates, or deletes records in multiple indices with a single API request. + Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. -Request can be constructed by NewApiMultipleBatchRequest with parameters below. - - @param batchParams BatchParams - @return MultipleBatchResponse + Request can be constructed by NewApiMultipleBatchRequest with parameters below. + @param ctx context.Context - Context of the request + @param batchParams BatchParams + @param opts ...Option - 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 (c *APIClient) MultipleBatchWithHTTPInfo(ctx context.Context, r ApiMultipleBatchRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6586,7 +6728,7 @@ func (c *APIClient) NewApiOperationIndexRequest(indexName string, operationIndex /* OperationIndex calls the API and returns the raw response from it. -Copies or moves (renames) an index within the same Algolia application. + Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. @@ -6603,19 +6745,26 @@ Copies or moves (renames) an index within the same Algolia application. **Move** - Moving a source index that doesn't exist is ignored without returning an error. + - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. + - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. + - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/). -Required API Key ACLs: - - addObject + Required API Key ACLs: -Request can be constructed by NewApiOperationIndexRequest with parameters below. + - addObject - @param indexName string - Name of the index on which to perform the operation. - @param operationIndexParams OperationIndexParams - @return UpdatedAtResponse + Request can be constructed by NewApiOperationIndexRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param operationIndexParams OperationIndexParams + @param opts ...Option - 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 (c *APIClient) OperationIndexWithHTTPInfo(ctx context.Context, r ApiOperationIndexRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -6837,24 +6986,30 @@ func (r ApiPartialUpdateObjectRequest) WithCreateIfNotExists(createIfNotExists b /* PartialUpdateObject calls the API and returns the raw response from it. -Adds new attributes to a record, or update existing ones. + Adds new attributes to a record, or update existing ones. - - If a record with the specified object ID doesn't exist, - a new record is added to the index **if** `createIfNotExists` is true. - - If the index doesn't exist yet, this method creates a new index. - - You can use any first-level attribute but not nested attributes. - If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. + - If a record with the specified object ID doesn't exist, + a new record is added to the index **if** `createIfNotExists` is true. -Required API Key ACLs: - - addObject + - If the index doesn't exist yet, this method creates a new index. -Request can be constructed by NewApiPartialUpdateObjectRequest with parameters below. + - You can use any first-level attribute but not nested attributes. + If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique record identifier. - @param attributesToUpdate map[string]AttributeToUpdate - Attributes with their values. - @param createIfNotExists bool - Whether to create a new record if it doesn't exist. - @return UpdatedAtWithObjectIdResponse + Required API Key ACLs: + + - addObject + + Request can be constructed by NewApiPartialUpdateObjectRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique record identifier. + @param attributesToUpdate map[string]AttributeToUpdate - Attributes with their values. + @param createIfNotExists bool - Whether to create a new record if it doesn't exist. + @param opts ...Option - 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 (c *APIClient) PartialUpdateObjectWithHTTPInfo(ctx context.Context, r ApiPartialUpdateObjectRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7020,15 +7175,18 @@ func (c *APIClient) NewApiRemoveUserIdRequest(userID string) ApiRemoveUserIdRequ /* RemoveUserId calls the API and returns the raw response from it. -Deletes a user ID and its associated data from the clusters. + Deletes a user ID and its associated data from the clusters. -Required API Key ACLs: - - admin + Required API Key ACLs: + - admin -Request can be constructed by NewApiRemoveUserIdRequest with parameters below. - - @param userID string - Unique identifier of the user who makes the search request. - @return RemoveUserIdResponse + Request can be constructed by NewApiRemoveUserIdRequest with parameters below. + @param ctx context.Context - Context of the request + @param userID string - Unique identifier of the user who makes the search request. + @param opts ...Option - 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 (c *APIClient) RemoveUserIdWithHTTPInfo(ctx context.Context, r ApiRemoveUserIdRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7164,15 +7322,18 @@ func (c *APIClient) NewApiReplaceSourcesRequest(source []Source) ApiReplaceSourc /* ReplaceSources calls the API and returns the raw response from it. -Replaces the list of allowed sources. + Replaces the list of allowed sources. -Required API Key ACLs: - - admin + Required API Key ACLs: + - admin -Request can be constructed by NewApiReplaceSourcesRequest with parameters below. - - @param source []Source - Allowed sources. - @return ReplaceSourceResponse + Request can be constructed by NewApiReplaceSourcesRequest with parameters below. + @param ctx context.Context - Context of the request + @param source []Source - Allowed sources. + @param opts ...Option - 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 (c *APIClient) ReplaceSourcesWithHTTPInfo(ctx context.Context, r ApiReplaceSourcesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7305,20 +7466,23 @@ func (c *APIClient) NewApiRestoreApiKeyRequest(key string) ApiRestoreApiKeyReque /* RestoreApiKey calls the API and returns the raw response from it. -Restores a deleted API key. + Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiRestoreApiKeyRequest with parameters below. + Required API Key ACLs: + - admin - @param key string - API key. - @return AddApiKeyResponse + Request can be constructed by NewApiRestoreApiKeyRequest with parameters below. + @param ctx context.Context - Context of the request + @param key string - API key. + @param opts ...Option - 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 (c *APIClient) RestoreApiKeyWithHTTPInfo(ctx context.Context, r ApiRestoreApiKeyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7475,7 +7639,7 @@ func (c *APIClient) NewApiSaveObjectRequest(indexName string, body map[string]an /* SaveObject calls the API and returns the raw response from it. -Adds a record to an index or replace it. + Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. @@ -7485,14 +7649,17 @@ Adds a record to an index or replace it. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). -Required API Key ACLs: - - addObject - -Request can be constructed by NewApiSaveObjectRequest with parameters below. + Required API Key ACLs: + - addObject - @param indexName string - Name of the index on which to perform the operation. - @param body map[string]any - The record, a schemaless object with attributes that are useful in the context of search and discovery. - @return SaveObjectResponse + Request can be constructed by NewApiSaveObjectRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param body map[string]any - The record, a schemaless object with attributes that are useful in the context of search and discovery. + @param opts ...Option - 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 (c *APIClient) SaveObjectWithHTTPInfo(ctx context.Context, r ApiSaveObjectRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7690,21 +7857,25 @@ func (r ApiSaveRuleRequest) WithForwardToReplicas(forwardToReplicas bool) ApiSav /* SaveRule calls the API and returns the raw response from it. -If a rule with the specified object ID doesn't exist, it's created. + If a rule with the specified object ID doesn't exist, it's created. + Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiSaveRuleRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a rule object. - @param rule Rule - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return UpdatedRuleResponse + Request can be constructed by NewApiSaveRuleRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a rule object. + @param rule Rule + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) SaveRuleWithHTTPInfo(ctx context.Context, r ApiSaveRuleRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -7909,21 +8080,24 @@ func (r ApiSaveRulesRequest) WithClearExistingRules(clearExistingRules bool) Api /* SaveRules calls the API and returns the raw response from it. -Create or update multiple rules. + Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiSaveRulesRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param rules []Rule - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @param clearExistingRules bool - Whether existing rules should be deleted before adding this batch. - @return UpdatedAtResponse + Request can be constructed by NewApiSaveRulesRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param rules []Rule + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param clearExistingRules bool - Whether existing rules should be deleted before adding this batch. + @param opts ...Option - 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 (c *APIClient) SaveRulesWithHTTPInfo(ctx context.Context, r ApiSaveRulesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -8122,20 +8296,24 @@ func (r ApiSaveSynonymRequest) WithForwardToReplicas(forwardToReplicas bool) Api /* SaveSynonym calls the API and returns the raw response from it. -If a synonym with the specified object ID doesn't exist, Algolia adds a new one. + If a synonym with the specified object ID doesn't exist, Algolia adds a new one. + Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiSaveSynonymRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param objectID string - Unique identifier of a synonym object. - @param synonymHit SynonymHit - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return SaveSynonymResponse + Request can be constructed by NewApiSaveSynonymRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param objectID string - Unique identifier of a synonym object. + @param synonymHit SynonymHit + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) SaveSynonymWithHTTPInfo(ctx context.Context, r ApiSaveSynonymRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -8338,19 +8516,23 @@ func (r ApiSaveSynonymsRequest) WithReplaceExistingSynonyms(replaceExistingSynon /* SaveSynonyms calls the API and returns the raw response from it. -If a synonym with the `objectID` doesn't exist, Algolia adds a new one. -Otherwise, existing synonyms are replaced. + If a synonym with the `objectID` doesn't exist, Algolia adds a new one. -Required API Key ACLs: - - editSettings +Otherwise, existing synonyms are replaced. -Request can be constructed by NewApiSaveSynonymsRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param synonymHit []SynonymHit - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @param replaceExistingSynonyms bool - Whether to replace all synonyms in the index with the ones sent with this request. - @return UpdatedAtResponse + Request can be constructed by NewApiSaveSynonymsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param synonymHit []SynonymHit + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param replaceExistingSynonyms bool - Whether to replace all synonyms in the index with the ones sent with this request. + @param opts ...Option - 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 (c *APIClient) SaveSynonymsWithHTTPInfo(ctx context.Context, r ApiSaveSynonymsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -8507,20 +8689,23 @@ func (c *APIClient) NewApiSearchRequest(searchMethodParams *SearchMethodParams) /* Search calls the API and returns the raw response from it. -Sends multiple search request to one or more indices. + Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters. -Required API Key ACLs: - - search - -Request can be constructed by NewApiSearchRequest with parameters below. + Required API Key ACLs: + - search - @param searchMethodParams SearchMethodParams - Muli-search request body. Results are returned in the same order as the requests. - @return SearchResponses + Request can be constructed by NewApiSearchRequest with parameters below. + @param ctx context.Context - Context of the request + @param searchMethodParams SearchMethodParams - Muli-search request body. Results are returned in the same order as the requests. + @param opts ...Option - 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 (c *APIClient) SearchWithHTTPInfo(ctx context.Context, r ApiSearchRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -8679,16 +8864,19 @@ func (c *APIClient) NewApiSearchDictionaryEntriesRequest(dictionaryName Dictiona /* SearchDictionaryEntries calls the API and returns the raw response from it. -Searches for standard and custom dictionary entries. + Searches for standard and custom dictionary entries. -Required API Key ACLs: - - settings - -Request can be constructed by NewApiSearchDictionaryEntriesRequest with parameters below. + Required API Key ACLs: + - settings - @param dictionaryName DictionaryType - Dictionary type in which to search. - @param searchDictionaryEntriesParams SearchDictionaryEntriesParams - @return SearchDictionaryEntriesResponse + Request can be constructed by NewApiSearchDictionaryEntriesRequest with parameters below. + @param ctx context.Context - Context of the request + @param dictionaryName DictionaryType - Dictionary type in which to search. + @param searchDictionaryEntriesParams SearchDictionaryEntriesParams + @param opts ...Option - 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 (c *APIClient) SearchDictionaryEntriesWithHTTPInfo(ctx context.Context, r ApiSearchDictionaryEntriesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -8851,21 +9039,26 @@ func (r ApiSearchForFacetValuesRequest) WithSearchForFacetValuesRequest(searchFo /* SearchForFacetValues calls the API and returns the raw response from it. -Searches for values of a specified facet attribute. + Searches for values of a specified facet attribute. - - By default, facet values are sorted by decreasing count. - You can adjust this with the `sortFacetValueBy` parameter. - - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**. + - By default, facet values are sorted by decreasing count. + You can adjust this with the `sortFacetValueBy` parameter. -Required API Key ACLs: - - search + - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**. -Request can be constructed by NewApiSearchForFacetValuesRequest with parameters below. + Required API Key ACLs: - @param indexName string - Name of the index on which to perform the operation. - @param facetName string - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. - @param searchForFacetValuesRequest SearchForFacetValuesRequest - @return SearchForFacetValuesResponse + - search + + Request can be constructed by NewApiSearchForFacetValuesRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param facetName string - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. + @param searchForFacetValuesRequest SearchForFacetValuesRequest + @param opts ...Option - 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 (c *APIClient) SearchForFacetValuesWithHTTPInfo(ctx context.Context, r ApiSearchForFacetValuesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9034,16 +9227,19 @@ func (r ApiSearchRulesRequest) WithSearchRulesParams(searchRulesParams *SearchRu /* SearchRules calls the API and returns the raw response from it. -Searches for rules in your index. - -Required API Key ACLs: - - settings + Searches for rules in your index. -Request can be constructed by NewApiSearchRulesRequest with parameters below. + Required API Key ACLs: + - settings - @param indexName string - Name of the index on which to perform the operation. - @param searchRulesParams SearchRulesParams - @return SearchRulesResponse + Request can be constructed by NewApiSearchRulesRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param searchRulesParams SearchRulesParams + @param opts ...Option - 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 (c *APIClient) SearchRulesWithHTTPInfo(ctx context.Context, r ApiSearchRulesRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9198,19 +9394,22 @@ func (r ApiSearchSingleIndexRequest) WithSearchParams(searchParams *SearchParams /* SearchSingleIndex calls the API and returns the raw response from it. -Searches a single index and return matching search results (_hits_). + Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. -Required API Key ACLs: - - search + Required API Key ACLs: + - search -Request can be constructed by NewApiSearchSingleIndexRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param searchParams SearchParams - @return SearchResponse + Request can be constructed by NewApiSearchSingleIndexRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param searchParams SearchParams + @param opts ...Option - 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 (c *APIClient) SearchSingleIndexWithHTTPInfo(ctx context.Context, r ApiSearchSingleIndexRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9371,16 +9570,19 @@ func (r ApiSearchSynonymsRequest) WithSearchSynonymsParams(searchSynonymsParams /* SearchSynonyms calls the API and returns the raw response from it. -Searches for synonyms in your index. + Searches for synonyms in your index. -Required API Key ACLs: - - settings + Required API Key ACLs: + - settings -Request can be constructed by NewApiSearchSynonymsRequest with parameters below. - - @param indexName string - Name of the index on which to perform the operation. - @param searchSynonymsParams SearchSynonymsParams - Body of the `searchSynonyms` operation. - @return SearchSynonymsResponse + Request can be constructed by NewApiSearchSynonymsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param searchSynonymsParams SearchSynonymsParams - Body of the `searchSynonyms` operation. + @param opts ...Option - 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 (c *APIClient) SearchSynonymsWithHTTPInfo(ctx context.Context, r ApiSearchSynonymsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9524,18 +9726,22 @@ func (c *APIClient) NewApiSearchUserIdsRequest(searchUserIdsParams *SearchUserId /* SearchUserIds calls the API and returns the raw response from it. -Since it can take a few seconds to get the data from the different clusters, + Since it can take a few seconds to get the data from the different clusters, + the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). -Required API Key ACLs: - - admin - -Request can be constructed by NewApiSearchUserIdsRequest with parameters below. + Required API Key ACLs: + - admin - @param searchUserIdsParams SearchUserIdsParams - @return SearchUserIdsResponse + Request can be constructed by NewApiSearchUserIdsRequest with parameters below. + @param ctx context.Context - Context of the request + @param searchUserIdsParams SearchUserIdsParams + @param opts ...Option - 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 (c *APIClient) SearchUserIdsWithHTTPInfo(ctx context.Context, r ApiSearchUserIdsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9679,15 +9885,18 @@ func (c *APIClient) NewApiSetDictionarySettingsRequest(dictionarySettingsParams /* SetDictionarySettings calls the API and returns the raw response from it. -Turns standard stop word dictionary entries on or off for a given language. + Turns standard stop word dictionary entries on or off for a given language. -Required API Key ACLs: - - editSettings + Required API Key ACLs: + - editSettings -Request can be constructed by NewApiSetDictionarySettingsRequest with parameters below. - - @param dictionarySettingsParams DictionarySettingsParams - @return UpdatedAtResponse + Request can be constructed by NewApiSetDictionarySettingsRequest with parameters below. + @param ctx context.Context - Context of the request + @param dictionarySettingsParams DictionarySettingsParams + @param opts ...Option - 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 (c *APIClient) SetDictionarySettingsWithHTTPInfo(ctx context.Context, r ApiSetDictionarySettingsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -9852,22 +10061,25 @@ func (r ApiSetSettingsRequest) WithForwardToReplicas(forwardToReplicas bool) Api /* SetSettings calls the API and returns the raw response from it. -Update the specified index settings. + Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index. -Required API Key ACLs: - - editSettings - -Request can be constructed by NewApiSetSettingsRequest with parameters below. + Required API Key ACLs: + - editSettings - @param indexName string - Name of the index on which to perform the operation. - @param indexSettings IndexSettings - @param forwardToReplicas bool - Whether changes are applied to replica indices. - @return UpdatedAtResponse + Request can be constructed by NewApiSetSettingsRequest with parameters below. + @param ctx context.Context - Context of the request + @param indexName string - Name of the index on which to perform the operation. + @param indexSettings IndexSettings + @param forwardToReplicas bool - Whether changes are applied to replica indices. + @param opts ...Option - 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 (c *APIClient) SetSettingsWithHTTPInfo(ctx context.Context, r ApiSetSettingsRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -10038,18 +10250,21 @@ func (c *APIClient) NewApiUpdateApiKeyRequest(key string, apiKey *ApiKey) ApiUpd /* UpdateApiKey calls the API and returns the raw response from it. -Replaces the permissions of an existing API key. + Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value. -Required API Key ACLs: - - admin - -Request can be constructed by NewApiUpdateApiKeyRequest with parameters below. - - @param key string - API key. - @param apiKey ApiKey - @return UpdateApiKeyResponse + Required API Key ACLs: + - admin + + Request can be constructed by NewApiUpdateApiKeyRequest with parameters below. + @param ctx context.Context - Context of the request + @param key string - API key. + @param apiKey ApiKey + @param opts ...Option - 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 (c *APIClient) UpdateApiKeyWithHTTPInfo(ctx context.Context, r ApiUpdateApiKeyRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/clients/algoliasearch-client-go/algolia/usage/api_usage.go b/clients/algoliasearch-client-go/algolia/usage/api_usage.go index de579672bf..351dd2a0ae 100644 --- a/clients/algoliasearch-client-go/algolia/usage/api_usage.go +++ b/clients/algoliasearch-client-go/algolia/usage/api_usage.go @@ -84,13 +84,17 @@ func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCus /* CustomDelete calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomDeleteRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomDeleteWithHTTPInfo(ctx context.Context, r ApiCustomDeleteRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -239,13 +243,17 @@ func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustom /* CustomGet calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomGetRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomGetWithHTTPInfo(ctx context.Context, r ApiCustomGetRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -410,14 +418,18 @@ func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest /* CustomPost calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPostRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPostWithHTTPInfo(ctx context.Context, r ApiCustomPostRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -590,14 +602,18 @@ func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest { /* CustomPut calls the API and returns the raw response from it. -This method allow you to send requests to the Algolia REST API. + 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 + Request can be constructed by NewApiCustomPutRequest with parameters below. + @param ctx context.Context - Context of the request + @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 ...Option - 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 (c *APIClient) CustomPutWithHTTPInfo(ctx context.Context, r ApiCustomPutRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -787,16 +803,21 @@ func (r ApiGetIndexUsageRequest) WithGranularity(granularity Granularity) ApiGet /* GetIndexUsage calls the API and returns the raw response from it. -Retrieves the selected usage statistics for one index. + Retrieves the selected usage statistics for one index. -Request can be constructed by NewApiGetIndexUsageRequest with parameters below. - @param statistic Statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries. - @param indexName string - Name of the index on which to perform the operation. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param granularity Granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. - @return GetUsage200Response + + Request can be constructed by NewApiGetIndexUsageRequest with parameters below. + @param ctx context.Context - Context of the request + @param statistic Statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries. + @param indexName string - Name of the index on which to perform the operation. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param granularity Granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + @param opts ...Option - 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 (c *APIClient) GetIndexUsageWithHTTPInfo(ctx context.Context, r ApiGetIndexUsageRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any @@ -981,15 +1002,20 @@ func (r ApiGetUsageRequest) WithGranularity(granularity Granularity) ApiGetUsage /* GetUsage calls the API and returns the raw response from it. -Retrieves usage statistics evaluated over a specified period. + Retrieves usage statistics evaluated over a specified period. -Request can be constructed by NewApiGetUsageRequest with parameters below. - @param statistic Statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries. - @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. - @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. - @param granularity Granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. - @return GetUsage200Response + + Request can be constructed by NewApiGetUsageRequest with parameters below. + @param ctx context.Context - Context of the request + @param statistic Statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries. + @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. + @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. + @param granularity Granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + @param opts ...Option - 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 (c *APIClient) GetUsageWithHTTPInfo(ctx context.Context, r ApiGetUsageRequest, opts ...Option) (*http.Response, []byte, error) { var postBody any diff --git a/tests/output/go/tests/requests/insights_test.go b/tests/output/go/tests/requests/insights_test.go index 0b3522d68c..4a017d970f 100644 --- a/tests/output/go/tests/requests/insights_test.go +++ b/tests/output/go/tests/requests/insights_test.go @@ -453,9 +453,9 @@ func TestInsights_PushEvents(t *testing.T) { insights.NewEmptyInsightsEvents().SetEvents( []insights.EventsItems{*insights.ConvertedObjectIDsAfterSearchAsEventsItems( - insights.NewEmptyConvertedObjectIDsAfterSearch().SetEventType(insights.ConversionEvent("conversion")).SetEventName("Product Purchased").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719014400000).SetObjectIDs( + insights.NewEmptyConvertedObjectIDsAfterSearch().SetEventType(insights.ConversionEvent("conversion")).SetEventName("Product Purchased").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719273600000).SetObjectIDs( []string{"9780545139700", "9780439784542"}).SetQueryID("43b15df305339e827f0ac0bdc5ebcaa7")), *insights.ViewedObjectIDsAsEventsItems( - insights.NewEmptyViewedObjectIDs().SetEventType(insights.ViewEvent("view")).SetEventName("Product Detail Page Viewed").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719014400000).SetObjectIDs( + insights.NewEmptyViewedObjectIDs().SetEventType(insights.ViewEvent("view")).SetEventName("Product Detail Page Viewed").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719273600000).SetObjectIDs( []string{"9780545139700", "9780439784542"}))}), )) require.NoError(t, err) @@ -464,15 +464,15 @@ func TestInsights_PushEvents(t *testing.T) { require.Equal(t, "POST", echo.Method) ja := jsonassert.New(t) - ja.Assertf(*echo.Body, `{"events":[{"eventType":"conversion","eventName":"Product Purchased","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1719014400000,"objectIDs":["9780545139700","9780439784542"],"queryID":"43b15df305339e827f0ac0bdc5ebcaa7"},{"eventType":"view","eventName":"Product Detail Page Viewed","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1719014400000,"objectIDs":["9780545139700","9780439784542"]}]}`) + ja.Assertf(*echo.Body, `{"events":[{"eventType":"conversion","eventName":"Product Purchased","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1719273600000,"objectIDs":["9780545139700","9780439784542"],"queryID":"43b15df305339e827f0ac0bdc5ebcaa7"},{"eventType":"view","eventName":"Product Detail Page Viewed","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1719273600000,"objectIDs":["9780545139700","9780439784542"]}]}`) clientE2E := createE2EInsightsClient(t) res, err := clientE2E.PushEvents(client.NewApiPushEventsRequest( insights.NewEmptyInsightsEvents().SetEvents( []insights.EventsItems{*insights.ConvertedObjectIDsAfterSearchAsEventsItems( - insights.NewEmptyConvertedObjectIDsAfterSearch().SetEventType(insights.ConversionEvent("conversion")).SetEventName("Product Purchased").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719014400000).SetObjectIDs( + insights.NewEmptyConvertedObjectIDsAfterSearch().SetEventType(insights.ConversionEvent("conversion")).SetEventName("Product Purchased").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719273600000).SetObjectIDs( []string{"9780545139700", "9780439784542"}).SetQueryID("43b15df305339e827f0ac0bdc5ebcaa7")), *insights.ViewedObjectIDsAsEventsItems( - insights.NewEmptyViewedObjectIDs().SetEventType(insights.ViewEvent("view")).SetEventName("Product Detail Page Viewed").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719014400000).SetObjectIDs( + insights.NewEmptyViewedObjectIDs().SetEventType(insights.ViewEvent("view")).SetEventName("Product Detail Page Viewed").SetIndex("products").SetUserToken("user-123456").SetAuthenticatedUserToken("user-123456").SetTimestamp(1719273600000).SetObjectIDs( []string{"9780545139700", "9780439784542"}))}), )) require.NoError(t, err)