Skip to content

Commit 9ed9fbb

Browse files
fern-api[bot]fern-api[bot]
authored
SDK regeneration (#51)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 81c8252 commit 9ed9fbb

38 files changed

+1034
-1642
lines changed

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "credal"
33

44
[tool.poetry]
55
name = "credal"
6-
version = "0.1.3"
6+
version = "0.1.4"
77
description = ""
88
readme = "README.md"
99
authors = []

‎reference.md‎

Lines changed: 10 additions & 287 deletions
Original file line numberDiff line numberDiff line change
@@ -930,15 +930,15 @@ client.document_catalog.upload_document_contents(
930930
<dl>
931931
<dd>
932932

933-
**custom_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Optional JSON representing any custom metadata for this document
933+
**custom_metadata:** `typing.Optional[typing.Dict[str, CustomMetadataValue]]` — Optional JSON representing any custom metadata for this document
934934

935935
</dd>
936936
</dl>
937937

938938
<dl>
939939
<dd>
940940

941-
**collection_id:** `typing.Optional[str]` — If specified, document will also be added to a particular document collection
941+
**collection_id:** `typing.Optional[str]` — If specified, the document will also be added to the provided document collection. The document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To await this process and have this endpoint return only when that embedding process is complete, use the `awaitVectorStoreSync` parameter.
942942

943943
</dd>
944944
</dl>
@@ -962,6 +962,14 @@ client.document_catalog.upload_document_contents(
962962
<dl>
963963
<dd>
964964

965+
**await_vector_store_sync:** `typing.Optional[bool]` — If specified, the API will wait for the vector store to be updated before returning. This is useful if you want to ensure that the document is immediately searchable after this call returns.
966+
967+
</dd>
968+
</dl>
969+
970+
<dl>
971+
<dd>
972+
965973
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
966974

967975
</dd>
@@ -1788,291 +1796,6 @@ client.document_collections.update_mongo_collection_sync(
17881796
</dl>
17891797

17901798

1791-
</dd>
1792-
</dl>
1793-
</details>
1794-
1795-
## PermissionsService
1796-
<details><summary><code>client.permissions_service.<a href="src/credal/permissions_service/client.py">check_resource_authorization_for_user</a>(...)</code></summary>
1797-
<dl>
1798-
<dd>
1799-
1800-
#### 📝 Description
1801-
1802-
<dl>
1803-
<dd>
1804-
1805-
<dl>
1806-
<dd>
1807-
1808-
Admin endpoint to check whether the specified user is authorized to read the specified resource.
1809-
</dd>
1810-
</dl>
1811-
</dd>
1812-
</dl>
1813-
1814-
#### 🔌 Usage
1815-
1816-
<dl>
1817-
<dd>
1818-
1819-
<dl>
1820-
<dd>
1821-
1822-
```python
1823-
from credal import CredalApi
1824-
from credal.common import ResourceIdentifier_ExternalResourceId
1825-
1826-
client = CredalApi(
1827-
api_key="YOUR_API_KEY",
1828-
)
1829-
client.permissions_service.check_resource_authorization_for_user(
1830-
resource_identifier=ResourceIdentifier_ExternalResourceId(
1831-
external_resource_id="170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
1832-
resource_type="GOOGLE_DRIVE_ITEM",
1833-
),
1834-
user_email="[email protected]",
1835-
)
1836-
1837-
```
1838-
</dd>
1839-
</dl>
1840-
</dd>
1841-
</dl>
1842-
1843-
#### ⚙️ Parameters
1844-
1845-
<dl>
1846-
<dd>
1847-
1848-
<dl>
1849-
<dd>
1850-
1851-
**resource_identifier:** `ResourceIdentifier` — The resource identifier for which you want to check authorization.
1852-
1853-
</dd>
1854-
</dl>
1855-
1856-
<dl>
1857-
<dd>
1858-
1859-
**user_email:** `str` — The user email to check authorization for.
1860-
1861-
</dd>
1862-
</dl>
1863-
1864-
<dl>
1865-
<dd>
1866-
1867-
**disable_cache:** `typing.Optional[bool]` — If specified, Credal will bypass the permissions cache and check current permissions for this resource
1868-
1869-
</dd>
1870-
</dl>
1871-
1872-
<dl>
1873-
<dd>
1874-
1875-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1876-
1877-
</dd>
1878-
</dl>
1879-
</dd>
1880-
</dl>
1881-
1882-
1883-
</dd>
1884-
</dl>
1885-
</details>
1886-
1887-
<details><summary><code>client.permissions_service.<a href="src/credal/permissions_service/client.py">check_bulk_resources_authorization_for_user</a>(...)</code></summary>
1888-
<dl>
1889-
<dd>
1890-
1891-
#### 📝 Description
1892-
1893-
<dl>
1894-
<dd>
1895-
1896-
<dl>
1897-
<dd>
1898-
1899-
Admin endpoint to check whether the specified user is authorized to read the specified set of resources.
1900-
</dd>
1901-
</dl>
1902-
</dd>
1903-
</dl>
1904-
1905-
#### 🔌 Usage
1906-
1907-
<dl>
1908-
<dd>
1909-
1910-
<dl>
1911-
<dd>
1912-
1913-
```python
1914-
from credal import CredalApi
1915-
from credal.common import (
1916-
ResourceIdentifier_ExternalResourceId,
1917-
ResourceIdentifier_Url,
1918-
)
1919-
1920-
client = CredalApi(
1921-
api_key="YOUR_API_KEY",
1922-
)
1923-
client.permissions_service.check_bulk_resources_authorization_for_user(
1924-
resource_identifiers=[
1925-
ResourceIdentifier_Url(
1926-
url="https://docs.google.com/document/d/170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr/edit",
1927-
),
1928-
ResourceIdentifier_ExternalResourceId(
1929-
external_resource_id="sfsdfvr54UvyslPVWkQFOA0dfsdfsdflgNycFmdZJQr",
1930-
resource_type="ZENDESK_TICKET",
1931-
),
1932-
],
1933-
user_email="[email protected]",
1934-
)
1935-
1936-
```
1937-
</dd>
1938-
</dl>
1939-
</dd>
1940-
</dl>
1941-
1942-
#### ⚙️ Parameters
1943-
1944-
<dl>
1945-
<dd>
1946-
1947-
<dl>
1948-
<dd>
1949-
1950-
**resource_identifiers:** `typing.Sequence[ResourceIdentifier]` — The set of resource identifier for which you want to check authorization. Currently limited to 20 resources.
1951-
1952-
</dd>
1953-
</dl>
1954-
1955-
<dl>
1956-
<dd>
1957-
1958-
**user_email:** `str` — The user email to check authorization for.
1959-
1960-
</dd>
1961-
</dl>
1962-
1963-
<dl>
1964-
<dd>
1965-
1966-
**disable_cache:** `typing.Optional[bool]` — If specified, Credal will bypass the permissions cache and check current permissions for all resources specified.
1967-
1968-
</dd>
1969-
</dl>
1970-
1971-
<dl>
1972-
<dd>
1973-
1974-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1975-
1976-
</dd>
1977-
</dl>
1978-
</dd>
1979-
</dl>
1980-
1981-
1982-
</dd>
1983-
</dl>
1984-
</details>
1985-
1986-
<details><summary><code>client.permissions_service.<a href="src/credal/permissions_service/client.py">list_cached_authorized_resources_for_user</a>(...)</code></summary>
1987-
<dl>
1988-
<dd>
1989-
1990-
#### 📝 Description
1991-
1992-
<dl>
1993-
<dd>
1994-
1995-
<dl>
1996-
<dd>
1997-
1998-
Admin endpoint to list all resources that the specified user is authorized to read. Note this endpoint returns cached results and may not be up-to-date. You can use the checkResourceAuthorizationForUser endpoint with disableCache set to true to get the most up-to-date results.
1999-
</dd>
2000-
</dl>
2001-
</dd>
2002-
</dl>
2003-
2004-
#### 🔌 Usage
2005-
2006-
<dl>
2007-
<dd>
2008-
2009-
<dl>
2010-
<dd>
2011-
2012-
```python
2013-
from credal import CredalApi
2014-
2015-
client = CredalApi(
2016-
api_key="YOUR_API_KEY",
2017-
)
2018-
client.permissions_service.list_cached_authorized_resources_for_user(
2019-
user_email="[email protected]",
2020-
)
2021-
2022-
```
2023-
</dd>
2024-
</dl>
2025-
</dd>
2026-
</dl>
2027-
2028-
#### ⚙️ Parameters
2029-
2030-
<dl>
2031-
<dd>
2032-
2033-
<dl>
2034-
<dd>
2035-
2036-
**user_email:** `str` — The user email to list authorized resources for.
2037-
2038-
</dd>
2039-
</dl>
2040-
2041-
<dl>
2042-
<dd>
2043-
2044-
**resource_type:** `typing.Optional[ResourceType]` — The type of resource you want to list. If not specified, all resource types will be listed.
2045-
2046-
</dd>
2047-
</dl>
2048-
2049-
<dl>
2050-
<dd>
2051-
2052-
**limit:** `typing.Optional[int]` — The maximum number of resources to return. Defaults to 100.
2053-
2054-
</dd>
2055-
</dl>
2056-
2057-
<dl>
2058-
<dd>
2059-
2060-
**offset:** `typing.Optional[int]` — The offset to use for pagination. If not specified, the first page of results will be returned.
2061-
2062-
</dd>
2063-
</dl>
2064-
2065-
<dl>
2066-
<dd>
2067-
2068-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2069-
2070-
</dd>
2071-
</dl>
2072-
</dd>
2073-
</dl>
2074-
2075-
20761799
</dd>
20771800
</dl>
20781801
</details>

0 commit comments

Comments
 (0)