formance-sdk-flows

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

pip install formance-sdk-flows

SDK Example Usage

Example

import formancesdkflows
from formancesdkflows.models import components

s = formancesdkflows.FormanceSDKFlows(
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info()

if res is not None:
    # handle response
    pass

Available Resources and Operations

FormanceSDKFlows SDK

• info

instances

• list
• get
• abort
• send
• get_history
• get_stage_history

triggers

• list
• create
• get
• delete
• list_occurences
• test

workflows

• list
• create
• get
• delete
• run

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

import formancesdkflows
from formancesdkflows.models import components

s = formancesdkflows.FormanceSDKFlows(
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.instances.list(workflow_id='<value>', running=False)

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

import formancesdkflows
from formancesdkflows.models import components
from formancesdkflows.utils import BackoffStrategy, RetryConfig

s = formancesdkflows.FormanceSDKFlows(
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info(,
    RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

import formancesdkflows
from formancesdkflows.models import components
from formancesdkflows.utils import BackoffStrategy, RetryConfig

s = formancesdkflows.FormanceSDKFlows(
    retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False),
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info()

if res is not None:
    # handle response
    pass

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Example

import formancesdkflows
from formancesdkflows.models import components, errors

s = formancesdkflows.FormanceSDKFlows(
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)

res = None
try:
    res = s.instances.list(workflow_id='<value>', running=False)

except errors.FlowError as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

Example

import formancesdkflows
from formancesdkflows.models import components

s = formancesdkflows.FormanceSDKFlows(
    server_idx=0,
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info()

if res is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import formancesdkflows
from formancesdkflows.models import components

s = formancesdkflows.FormanceSDKFlows(
    server_url="http://localhost",
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info()

if res is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import formancesdkflows
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = formancesdkflows.FormanceSDKFlows(client=http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import formancesdkflows
from formancesdkflows.models import components

s = formancesdkflows.FormanceSDKFlows(
    security=components.Security(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ),
)


res = s.info()

if res is not None:
    # handle response
    pass

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy