Skip to content

Commit

Permalink
chore: generated code for commit d2b0f7d6. [skip ci]
Browse files Browse the repository at this point in the history
algolia/api-clients-automation@d2b0f7d

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
algolia-bot and millotp committed Jul 12, 2024
1 parent f956b88 commit c4e8d4d
Show file tree
Hide file tree
Showing 8 changed files with 281 additions and 82 deletions.
18 changes: 0 additions & 18 deletions algoliasearch/recommend/models/base_search_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,6 @@ class BaseSearchResponse(BaseModel):
facets_stats: Optional[Dict[str, FacetsStats]] = Field(
default=None, description="Statistics for numerical facets."
)
hits_per_page: Annotated[int, Field(le=1000, strict=True, ge=1)] = Field(
description="Number of hits per page.", alias="hitsPerPage"
)
index: Optional[StrictStr] = Field(
default=None, description="Index name used for the query."
)
Expand All @@ -87,18 +84,11 @@ class BaseSearchResponse(BaseModel):
message: Optional[StrictStr] = Field(
default=None, description="Warnings about the query."
)
nb_hits: StrictInt = Field(description="Number of results (hits).", alias="nbHits")
nb_pages: StrictInt = Field(
description="Number of pages of results.", alias="nbPages"
)
nb_sorted_hits: Optional[StrictInt] = Field(
default=None,
description="Number of hits selected and sorted by the relevant sort algorithm.",
alias="nbSortedHits",
)
page: Annotated[int, Field(strict=True, ge=0)] = Field(
description="Page of search results to retrieve."
)
parsed_query: Optional[StrictStr] = Field(
default=None,
description="Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.",
Expand Down Expand Up @@ -154,14 +144,10 @@ class BaseSearchResponse(BaseModel):
"exhaustiveTypo",
"facets",
"facets_stats",
"hitsPerPage",
"index",
"indexUsed",
"message",
"nbHits",
"nbPages",
"nbSortedHits",
"page",
"parsedQuery",
"processingTimeMS",
"processingTimingsMS",
Expand Down Expand Up @@ -267,14 +253,10 @@ def from_dict(cls, obj: Dict) -> Self:
if obj.get("facets_stats") is not None
else None
),
"hitsPerPage": obj.get("hitsPerPage"),
"index": obj.get("index"),
"indexUsed": obj.get("indexUsed"),
"message": obj.get("message"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"nbSortedHits": obj.get("nbSortedHits"),
"page": obj.get("page"),
"parsedQuery": obj.get("parsedQuery"),
"processingTimeMS": obj.get("processingTimeMS"),
"processingTimingsMS": obj.get("processingTimingsMS"),
Expand Down
28 changes: 14 additions & 14 deletions algoliasearch/recommend/models/recommendations_results.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ class RecommendationsResults(BaseModel):
facets_stats: Optional[Dict[str, FacetsStats]] = Field(
default=None, description="Statistics for numerical facets."
)
hits_per_page: Annotated[int, Field(le=1000, strict=True, ge=1)] = Field(
description="Number of hits per page.", alias="hitsPerPage"
)
index: Optional[StrictStr] = Field(
default=None, description="Index name used for the query."
)
Expand All @@ -88,18 +85,11 @@ class RecommendationsResults(BaseModel):
message: Optional[StrictStr] = Field(
default=None, description="Warnings about the query."
)
nb_hits: StrictInt = Field(description="Number of results (hits).", alias="nbHits")
nb_pages: StrictInt = Field(
description="Number of pages of results.", alias="nbPages"
)
nb_sorted_hits: Optional[StrictInt] = Field(
default=None,
description="Number of hits selected and sorted by the relevant sort algorithm.",
alias="nbSortedHits",
)
page: Annotated[int, Field(strict=True, ge=0)] = Field(
description="Page of search results to retrieve."
)
parsed_query: Optional[StrictStr] = Field(
default=None,
description="Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.",
Expand Down Expand Up @@ -143,6 +133,16 @@ class RecommendationsResults(BaseModel):
description="Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).",
alias="queryID",
)
page: Annotated[int, Field(strict=True, ge=0)] = Field(
description="Page of search results to retrieve."
)
nb_hits: StrictInt = Field(description="Number of results (hits).", alias="nbHits")
nb_pages: StrictInt = Field(
description="Number of pages of results.", alias="nbPages"
)
hits_per_page: Annotated[int, Field(le=1000, strict=True, ge=1)] = Field(
description="Number of hits per page.", alias="hitsPerPage"
)
hits: List[RecommendationsHit]

@field_validator("around_lat_lng")
Expand Down Expand Up @@ -236,14 +236,10 @@ def from_dict(cls, obj: Dict) -> Self:
if obj.get("facets_stats") is not None
else None
),
"hitsPerPage": obj.get("hitsPerPage"),
"index": obj.get("index"),
"indexUsed": obj.get("indexUsed"),
"message": obj.get("message"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"nbSortedHits": obj.get("nbSortedHits"),
"page": obj.get("page"),
"parsedQuery": obj.get("parsedQuery"),
"processingTimeMS": obj.get("processingTimeMS"),
"processingTimingsMS": obj.get("processingTimingsMS"),
Expand All @@ -262,6 +258,10 @@ def from_dict(cls, obj: Dict) -> Self:
"serverUsed": obj.get("serverUsed"),
"userData": obj.get("userData"),
"queryID": obj.get("queryID"),
"page": obj.get("page"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"hitsPerPage": obj.get("hitsPerPage"),
"hits": (
[RecommendationsHit.from_dict(_item) for _item in obj.get("hits")]
if obj.get("hits") is not None
Expand Down
77 changes: 77 additions & 0 deletions algoliasearch/recommend/models/search_pagination.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# coding: utf-8

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

from __future__ import annotations

from json import loads
from typing import Annotated, Any, Dict, Self

from pydantic import BaseModel, ConfigDict, Field, StrictInt


class SearchPagination(BaseModel):
"""
SearchPagination
"""

page: Annotated[int, Field(strict=True, ge=0)] = Field(
description="Page of search results to retrieve."
)
nb_hits: StrictInt = Field(description="Number of results (hits).", alias="nbHits")
nb_pages: StrictInt = Field(
description="Number of pages of results.", alias="nbPages"
)
hits_per_page: Annotated[int, Field(le=1000, strict=True, ge=1)] = Field(
description="Number of hits per page.", alias="hitsPerPage"
)

model_config = ConfigDict(
use_enum_values=True, populate_by_name=True, validate_assignment=True
)

def to_json(self) -> str:
return self.model_dump_json(by_alias=True, exclude_unset=True)

@classmethod
def from_json(cls, json_str: str) -> Self:
"""Create an instance of SearchPagination from a JSON string"""
return cls.from_dict(loads(json_str))

def to_dict(self) -> Dict[str, Any]:
"""Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic's
`self.model_dump(by_alias=True)`:
* `None` is only added to the output dict for nullable fields that
were set at model initialization. Other fields with value `None`
are ignored.
"""
_dict = self.model_dump(
by_alias=True,
exclude={},
exclude_none=True,
)
return _dict

@classmethod
def from_dict(cls, obj: Dict) -> Self:
"""Create an instance of SearchPagination from a dict"""
if obj is None:
return None

if not isinstance(obj, dict):
return cls.model_validate(obj)

_obj = cls.model_validate(
{
"page": obj.get("page"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"hitsPerPage": obj.get("hitsPerPage"),
}
)
return _obj
18 changes: 0 additions & 18 deletions algoliasearch/search/models/base_search_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,6 @@ class BaseSearchResponse(BaseModel):
facets_stats: Optional[Dict[str, FacetsStats]] = Field(
default=None, description="Statistics for numerical facets."
)
hits_per_page: Annotated[int, Field(le=1000, strict=True, ge=1)] = Field(
description="Number of hits per page.", alias="hitsPerPage"
)
index: Optional[StrictStr] = Field(
default=None, description="Index name used for the query."
)
Expand All @@ -87,18 +84,11 @@ class BaseSearchResponse(BaseModel):
message: Optional[StrictStr] = Field(
default=None, description="Warnings about the query."
)
nb_hits: StrictInt = Field(description="Number of results (hits).", alias="nbHits")
nb_pages: StrictInt = Field(
description="Number of pages of results.", alias="nbPages"
)
nb_sorted_hits: Optional[StrictInt] = Field(
default=None,
description="Number of hits selected and sorted by the relevant sort algorithm.",
alias="nbSortedHits",
)
page: Annotated[int, Field(strict=True, ge=0)] = Field(
description="Page of search results to retrieve."
)
parsed_query: Optional[StrictStr] = Field(
default=None,
description="Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.",
Expand Down Expand Up @@ -154,14 +144,10 @@ class BaseSearchResponse(BaseModel):
"exhaustiveTypo",
"facets",
"facets_stats",
"hitsPerPage",
"index",
"indexUsed",
"message",
"nbHits",
"nbPages",
"nbSortedHits",
"page",
"parsedQuery",
"processingTimeMS",
"processingTimingsMS",
Expand Down Expand Up @@ -267,14 +253,10 @@ def from_dict(cls, obj: Dict) -> Self:
if obj.get("facets_stats") is not None
else None
),
"hitsPerPage": obj.get("hitsPerPage"),
"index": obj.get("index"),
"indexUsed": obj.get("indexUsed"),
"message": obj.get("message"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"nbSortedHits": obj.get("nbSortedHits"),
"page": obj.get("page"),
"parsedQuery": obj.get("parsedQuery"),
"processingTimeMS": obj.get("processingTimeMS"),
"processingTimingsMS": obj.get("processingTimingsMS"),
Expand Down
79 changes: 79 additions & 0 deletions algoliasearch/search/models/browse_pagination.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# coding: utf-8

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

from __future__ import annotations

from json import loads
from typing import Annotated, Any, Dict, Optional, Self

from pydantic import BaseModel, ConfigDict, Field, StrictInt


class BrowsePagination(BaseModel):
"""
BrowsePagination
"""

page: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(
default=0, description="Page of search results to retrieve."
)
nb_hits: Optional[StrictInt] = Field(
default=None, description="Number of results (hits).", alias="nbHits"
)
nb_pages: Optional[StrictInt] = Field(
default=None, description="Number of pages of results.", alias="nbPages"
)
hits_per_page: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = Field(
default=20, description="Number of hits per page.", alias="hitsPerPage"
)

model_config = ConfigDict(
use_enum_values=True, populate_by_name=True, validate_assignment=True
)

def to_json(self) -> str:
return self.model_dump_json(by_alias=True, exclude_unset=True)

@classmethod
def from_json(cls, json_str: str) -> Self:
"""Create an instance of BrowsePagination from a JSON string"""
return cls.from_dict(loads(json_str))

def to_dict(self) -> Dict[str, Any]:
"""Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic's
`self.model_dump(by_alias=True)`:
* `None` is only added to the output dict for nullable fields that
were set at model initialization. Other fields with value `None`
are ignored.
"""
_dict = self.model_dump(
by_alias=True,
exclude={},
exclude_none=True,
)
return _dict

@classmethod
def from_dict(cls, obj: Dict) -> Self:
"""Create an instance of BrowsePagination from a dict"""
if obj is None:
return None

if not isinstance(obj, dict):
return cls.model_validate(obj)

_obj = cls.model_validate(
{
"page": obj.get("page"),
"nbHits": obj.get("nbHits"),
"nbPages": obj.get("nbPages"),
"hitsPerPage": obj.get("hitsPerPage"),
}
)
return _obj
Loading

0 comments on commit c4e8d4d

Please sign in to comment.