Skip to content

feat(docs): updating documented docs for mintlify #5

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

Merged
stainless-app merged 1 commit into from
Mar 5, 2025
+371 −13
Merged

feat(docs): updating documented docs for mintlify #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
256 changes: 252 additions & 4 deletions src/openint/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading