Skip to content

Commit

Permalink
SDK regeneration (#245)
Browse files Browse the repository at this point in the history
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
  • Loading branch information
fern-api[bot] authored Dec 19, 2024
1 parent 18d16a2 commit c95c3e9
Show file tree
Hide file tree
Showing 17 changed files with 1,097 additions and 107 deletions.
210 changes: 105 additions & 105 deletions poetry.lock

Large diffs are not rendered by default.

190 changes: 190 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2356,6 +2356,196 @@ client.resolution.resolution_post(
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.resolution.<a href="src/sayari/resolution/client.py">resolution_persisted</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

<Warning>This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> The persisted resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the resolution endpoint, except it also stores matched entities into user's project.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from sayari import Sayari
from sayari.resolution import ResolutionBody

client = Sayari(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.resolution.resolution_persisted(
project_id="6GaxYn",
limit=1,
request=ResolutionBody(
name=["victoria beckham limited"],
profile="suppliers",
),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**project_id:** `str` — Unique identifier of the project

</dd>
</dl>

<dl>
<dd>

**request:** `ResolutionBody`

</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — A limit on the number of objects to be returned with a range between 1 and 10 inclusive. Defaults to 10.

</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Number of results to skip before returning response. Defaults to 0.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.resolution.<a href="src/sayari/resolution/client.py">resolution_upload</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

<Warning>This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.</Warning> This endpoint allows you to upload entities in bulk.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from sayari import Sayari
from sayari.resolution import ResolutionBody, ResolutionUploadBody

client = Sayari(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.resolution.resolution_upload(
project_id="V03eYM",
request=ResolutionUploadBody(
filename="vbeck.json",
data=[
ResolutionBody(
name=["victoria beckham limited"],
tags=["spice girls"],
)
],
),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**project_id:** `str` — Unique identifier of the project

</dd>
</dl>

<dl>
<dd>

**request:** `ResolutionUploadBody`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down
10 changes: 10 additions & 0 deletions src/sayari/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,14 @@
MatchStrength,
ProfileEnum,
ResolutionBody,
ResolutionPersistedResponse,
ResolutionPersistedResponseFields,
ResolutionPersistedResult,
ResolutionResponse,
ResolutionResponseFields,
ResolutionResult,
ResolutionUploadBody,
ResolutionUploadResponse,
)
from .resource import DeleteResourceResponse, EntityResponseData, ResourceType, SaveEntityRequest, SaveEntityResponse
from .search import Coordinates, EntitySearchResponse, FilterList, RecordSearchResponse, SearchResults, SourceId
Expand Down Expand Up @@ -459,9 +464,14 @@
"RelationshipInfo",
"Relationships",
"ResolutionBody",
"ResolutionPersistedResponse",
"ResolutionPersistedResponseFields",
"ResolutionPersistedResult",
"ResolutionResponse",
"ResolutionResponseFields",
"ResolutionResult",
"ResolutionUploadBody",
"ResolutionUploadResponse",
"ResourceNotificationData",
"ResourceNotificationsResponse",
"ResourceType",
Expand Down
5 changes: 5 additions & 0 deletions src/sayari/project/types/project_entities_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ class ProjectEntitiesFilter(UniversalBaseModel):
Filter by entity [company status](/sayari-library/ontology/enumerated-types#company-status).
"""

risk_category: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
"""
Filter by risk factor `category`, e.g. `sanctions`. At least one risk factor from each provided category must be present.
"""

bounds: typing.Optional[str] = pydantic.Field(default=None)
"""
Filter by a geographical bounding box. The value is a pipe-delimited set of four values representing the top, left, bottom, and right sides of the bounding box, in that order. The pipes should be URL-encoded as `%7C`. The top coordinate must greater than the bottom coordinate, and the left coordinate must be less than the right coordinate. A sample is `55.680357237879136|-71.53607290158526|41.10876347746233|-40.963927098414736`
Expand Down
10 changes: 10 additions & 0 deletions src/sayari/resolution/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@
MatchStrength,
ProfileEnum,
ResolutionBody,
ResolutionPersistedResponse,
ResolutionPersistedResponseFields,
ResolutionPersistedResult,
ResolutionResponse,
ResolutionResponseFields,
ResolutionResult,
ResolutionUploadBody,
ResolutionUploadResponse,
)

__all__ = [
Expand All @@ -17,7 +22,12 @@
"MatchStrength",
"ProfileEnum",
"ResolutionBody",
"ResolutionPersistedResponse",
"ResolutionPersistedResponseFields",
"ResolutionPersistedResult",
"ResolutionResponse",
"ResolutionResponseFields",
"ResolutionResult",
"ResolutionUploadBody",
"ResolutionUploadResponse",
]
Loading

0 comments on commit c95c3e9

Please sign in to comment.