Skip to content

README.md

Latest commit

 

History

History
108 lines (73 loc) · 8.22 KB

README.md

File metadata and controls

108 lines (73 loc) · 8.22 KB
Raw

Apis

(connector.apis)

Overview

Available Operations

list

List APIs

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.connector.apis.list(limit=20, filter_={
        "status": apideck_unify.APIStatus.BETA,
    })

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description Example
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
cursor OptionalNullable[str] ➖ Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limit Optional[int] ➖ Number of results to return. Minimum 1, Maximum 200, Default 20
filter_ Optional[models.ApisFilter] ➖ Apply filters {
"status": "beta"
}
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ConnectorApisAllResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.APIError 4XX, 5XX */*

get

Get API

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.connector.apis.get(id="<id>")

    assert res.get_api_response is not None

    # Handle response
    print(res.get_api_response)

Parameters

Parameter Type Required Description Example
id str ✔️ ID of the record you are acting upon.
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ConnectorApisOneResponse

Errors

Error Type Status Code Content Type
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.APIError 4XX, 5XX */*