From 62f0870b76390dc5314537edcf9672621015aee5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 00:28:30 +0000 Subject: [PATCH] feat(docs): updating documented docs for mintlify --- .stats.yml | 2 +- src/openint/_client.py | 256 +++++++++++++++++- .../types/client_get_connection_params.py | 57 +++- .../client_list_connection_configs_params.py | 57 +++- tests/api_resources/test_client.py | 12 +- 5 files changed, 371 insertions(+), 13 deletions(-) diff --git a/.stats.yml b/.stats.yml index b70c8fe..5a441b8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 5 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openint%2Fopenint-9401d823cca81901da726bddeb09c51d38461d700828a76e7b41abb25bc2e0eb.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openint%2Fopenint-1774a01e29ee20fa16ce371374b9a675da3d1a0a5d3cb911a4acf067d3c7351e.yml diff --git a/src/openint/_client.py b/src/openint/_client.py index 37f25dc..a466d61 100644 --- a/src/openint/_client.py +++ b/src/openint/_client.py @@ -217,6 +217,8 @@ def check_connection( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> CheckConnectionResponse: """ + Verify that a connection is healthy + Args: extra_headers: Send extra headers @@ -240,7 +242,62 @@ def get_connection( self, *, connector_config_id: str | NotGiven = NOT_GIVEN, - connector_name: str | NotGiven = NOT_GIVEN, + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + | NotGiven = NOT_GIVEN, customer_id: str | NotGiven = NOT_GIVEN, expand: List[Literal["connector"]] | NotGiven = NOT_GIVEN, include_secrets: Literal["none", "basic", "all"] | NotGiven = NOT_GIVEN, @@ -254,7 +311,11 @@ def get_connection( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> GetConnectionResponse: """ + List all connections with optional filtering + Args: + connector_name: The name of the connector + include_secrets: Controls secret inclusion: none (default), basic (auth only), or all secrets extra_headers: Send extra headers @@ -291,7 +352,62 @@ def get_connection( def list_connection_configs( self, *, - connector_name: str | NotGiven = NOT_GIVEN, + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + | NotGiven = NOT_GIVEN, expand: List[Literal["connector"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, offset: int | NotGiven = NOT_GIVEN, @@ -303,7 +419,11 @@ def list_connection_configs( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListConnectionConfigsResponse: """ + List all connector configurations with optional filtering + Args: + connector_name: The name of the connector + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -347,6 +467,8 @@ def list_connections( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListConnectionsResponse: """ + Get details of a specific connection + Args: include_secrets: Controls secret inclusion: none (default), basic (auth only), or all secrets @@ -400,6 +522,8 @@ def list_events( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListEventsResponse: """ + List all events for an organization + Args: extra_headers: Send extra headers @@ -620,6 +744,8 @@ async def check_connection( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> CheckConnectionResponse: """ + Verify that a connection is healthy + Args: extra_headers: Send extra headers @@ -643,7 +769,62 @@ async def get_connection( self, *, connector_config_id: str | NotGiven = NOT_GIVEN, - connector_name: str | NotGiven = NOT_GIVEN, + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + | NotGiven = NOT_GIVEN, customer_id: str | NotGiven = NOT_GIVEN, expand: List[Literal["connector"]] | NotGiven = NOT_GIVEN, include_secrets: Literal["none", "basic", "all"] | NotGiven = NOT_GIVEN, @@ -657,7 +838,11 @@ async def get_connection( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> GetConnectionResponse: """ + List all connections with optional filtering + Args: + connector_name: The name of the connector + include_secrets: Controls secret inclusion: none (default), basic (auth only), or all secrets extra_headers: Send extra headers @@ -694,7 +879,62 @@ async def get_connection( async def list_connection_configs( self, *, - connector_name: str | NotGiven = NOT_GIVEN, + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + | NotGiven = NOT_GIVEN, expand: List[Literal["connector"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, offset: int | NotGiven = NOT_GIVEN, @@ -706,7 +946,11 @@ async def list_connection_configs( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListConnectionConfigsResponse: """ + List all connector configurations with optional filtering + Args: + connector_name: The name of the connector + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -750,6 +994,8 @@ async def list_connections( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListConnectionsResponse: """ + Get details of a specific connection + Args: include_secrets: Controls secret inclusion: none (default), basic (auth only), or all secrets @@ -803,6 +1049,8 @@ async def list_events( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ListEventsResponse: """ + List all events for an organization + Args: extra_headers: Send extra headers diff --git a/src/openint/types/client_get_connection_params.py b/src/openint/types/client_get_connection_params.py index 18299a6..70f9c11 100644 --- a/src/openint/types/client_get_connection_params.py +++ b/src/openint/types/client_get_connection_params.py @@ -11,7 +11,62 @@ class ClientGetConnectionParams(TypedDict, total=False): connector_config_id: str - connector_name: str + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + """The name of the connector""" customer_id: str diff --git a/src/openint/types/client_list_connection_configs_params.py b/src/openint/types/client_list_connection_configs_params.py index 92f5ee6..c384d3e 100644 --- a/src/openint/types/client_list_connection_configs_params.py +++ b/src/openint/types/client_list_connection_configs_params.py @@ -9,7 +9,62 @@ class ClientListConnectionConfigsParams(TypedDict, total=False): - connector_name: str + connector_name: Literal[ + "aircall", + "airtable", + "apollo", + "beancount", + "brex", + "coda", + "confluence", + "debug", + "discord", + "finch", + "firebase", + "foreceipt", + "fs", + "github", + "gong", + "google", + "greenhouse", + "heron", + "hubspot", + "intercom", + "jira", + "kustomer", + "lever", + "linear", + "lunchmoney", + "merge", + "microsoft", + "mongodb", + "moota", + "onebrick", + "outreach", + "pipedrive", + "plaid", + "postgres", + "qbo", + "ramp", + "revert", + "salesforce", + "salesloft", + "saltedge", + "slack", + "splitwise", + "spreadsheet", + "stripe", + "teller", + "toggl", + "twenty", + "webhook", + "wise", + "xero", + "yodlee", + "zohodesk", + "googledrive", + ] + """The name of the connector""" expand: List[Literal["connector"]] diff --git a/tests/api_resources/test_client.py b/tests/api_resources/test_client.py index 53452b2..0f4a187 100644 --- a/tests/api_resources/test_client.py +++ b/tests/api_resources/test_client.py @@ -76,8 +76,8 @@ def test_method_get_connection(self, client: Openint) -> None: def test_method_get_connection_with_all_params(self, client: Openint) -> None: client_ = client.get_connection( connector_config_id="connector_config_id", - connector_name="connector_name", - customer_id="customer_id", + connector_name="aircall", + customer_id="x", expand=["connector"], include_secrets="none", limit=1, @@ -117,7 +117,7 @@ def test_method_list_connection_configs(self, client: Openint) -> None: @parametrize def test_method_list_connection_configs_with_all_params(self, client: Openint) -> None: client_ = client.list_connection_configs( - connector_name="connector_name", + connector_name="aircall", expand=["connector"], limit=1, offset=0, @@ -293,8 +293,8 @@ async def test_method_get_connection(self, async_client: AsyncOpenint) -> None: async def test_method_get_connection_with_all_params(self, async_client: AsyncOpenint) -> None: client = await async_client.get_connection( connector_config_id="connector_config_id", - connector_name="connector_name", - customer_id="customer_id", + connector_name="aircall", + customer_id="x", expand=["connector"], include_secrets="none", limit=1, @@ -334,7 +334,7 @@ async def test_method_list_connection_configs(self, async_client: AsyncOpenint) @parametrize async def test_method_list_connection_configs_with_all_params(self, async_client: AsyncOpenint) -> None: client = await async_client.list_connection_configs( - connector_name="connector_name", + connector_name="aircall", expand=["connector"], limit=1, offset=0,