Skip to content

SDK regeneration #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 2 commits into
base: main
Choose a base branch
from
Open

SDK regeneration #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3afbb65
[fern-generated] Update SDK
fern-api[bot] Oct 1, 2026
3ad06d4
[fern-replay] advance lockfile
fern-api[bot] Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .fern/replay.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions .fernignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ Makefile
README.md
src/sayari/client.py
tests/custom/test_sdk.py
.fern/replay.lock
.fern/replay.yml
.gitattributes
1 change: 1 addition & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.fern/replay.lock linguist-generated=true
111 changes: 58 additions & 53 deletions poetry.lock
View file
Open in desktop

Large diffs are not rendered by default.

222 changes: 209 additions & 13 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,7 +1059,7 @@ client.info.get_history()
<dl>
<dd>

Get metadta about the api, both its versions, which releases are present, and the identity of the authenticated user.
Get metadata about the api, both its versions, which releases are present, and the identity of the authenticated user.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -3396,7 +3396,10 @@ The resolution endpoints allow users to search for matching entities against a p

```python
from sayari import Sayari
from sayari.project_entity import CreateResolvedProjectEntityRequest
from sayari.project_entity import (
CreateResolvedProjectEntityRequest,
ResolutionAttrSchema,
)

client = Sayari(
client_id="YOUR_CLIENT_ID",
Expand All @@ -3405,11 +3408,15 @@ client = Sayari(
client.project_entity.create_project_entity(
project_id="0n4473",
request=CreateResolvedProjectEntityRequest(
name=["Marvel Garment"],
country=["KHM"],
address=[
"Beung Thom 3 Village, Sangkat Beung Thom, Posenchey, Phnom Penh"
],
limit=25,
profile="suppliers",
attributes=ResolutionAttrSchema(
name=["Marvel Garment"],
country=["KHM"],
address=[
"Beung Thom 3 Village, Sangkat Beung Thom, Posenchey, Phnom Penh"
],
),
),
)

Expand Down Expand Up @@ -4069,7 +4076,7 @@ Checks if a project entity with the given attributes already exists.

```python
from sayari import Sayari
from sayari.project_entity import ResolutionAttributes
from sayari.project_entity import ResolutionAttributes, ResolutionAttrSchema

client = Sayari(
client_id="YOUR_CLIENT_ID",
Expand All @@ -4078,8 +4085,10 @@ client = Sayari(
client.project_entity.project_entity_exists(
project_id="YVB88Y",
request=ResolutionAttributes(
name=["Example Company"],
country=["USA"],
attributes=ResolutionAttrSchema(
name=["Example Company"],
country=["USA"],
),
),
)

Expand Down Expand Up @@ -4153,7 +4162,7 @@ Stores a project entity given entity IDs and a list of attributes.

```python
from sayari import Sayari
from sayari.project_entity import ResolutionAttributes, SaveProjectEntityBody
from sayari.project_entity import ResolutionAttrSchema, SaveProjectEntityBody

client = Sayari(
client_id="YOUR_CLIENT_ID",
Expand All @@ -4163,7 +4172,7 @@ client.project_entity.save_project_entity(
project_id="YVB88Y",
request=SaveProjectEntityBody(
entity_ids=["entity_id_1", "entity_id_2"],
attributes=ResolutionAttributes(
attributes=ResolutionAttrSchema(
name=["Example Company"],
country=["USA"],
),
Expand Down Expand Up @@ -5711,7 +5720,7 @@ client.resolution.resolution(
<dl>
<dd>

**enable_llm_clean:** `typing.Optional[bool]` — Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to true if not supplied. Set to false to disable LLM cleaning.
**enable_llm_clean:** `typing.Optional[bool]` — Whether to enable LLM-based data cleaning to remove noise and standardize entity attributes. Defaults to false if not supplied. Set to true to enable LLM cleaning.

</dd>
</dl>
Expand Down Expand Up @@ -6186,6 +6195,193 @@ client.resource.delete_resource(
</dl>


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

## ScreenByName
<details><summary><code>client.screen_by_name.<a href="src/sayari/screen_by_name/client.py">screen_by_name</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Screen a name against watchlist records to identify potential matches. Requires the `screened_risk` role.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from sayari import Sayari

client = Sayari(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.screen_by_name.screen_by_name(
name="AEROCARIBBEAN AIRLINES",
type="company",
)

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**name:** `str` — Name to screen against watchlist records.

</dd>
</dl>

<dl>
<dd>

**type:** `typing.Optional[str]` — Comma-separated list of watchlist record types to filter by.

</dd>
</dl>

<dl>
<dd>

**release_name:** `typing.Optional[str]` — Watchlist release name to filter by.

</dd>
</dl>

<dl>
<dd>

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

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


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

## Screen
<details><summary><code>client.screen.<a href="src/sayari/screen/client.py">screen</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Screen a project entity against watchlist records to identify potential matches. Requires the `screened_risk` role.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from sayari import Sayari

client = Sayari(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.screen.screen(
project_id="YVB88Y",
project_entity_id="YVodz6",
type="company",
)

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**project_id:** `str` — Project identifier.

</dd>
</dl>

<dl>
<dd>

**project_entity_id:** `str` — Project entity identifier.

</dd>
</dl>

<dl>
<dd>

**type:** `typing.Optional[str]` — Comma-separated list of watchlist record types to filter by.

</dd>
</dl>

<dl>
<dd>

**release_name:** `typing.Optional[str]` — Watchlist release name to filter by.

</dd>
</dl>

<dl>
<dd>

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

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


</dd>
</dl>
</details>
Expand Down
Loading
Loading