Python Client SDK Generated by Speakeasy.

Project description

openapi

Developer-friendly & type-safe Python SDK specifically catered to leverage openapi API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add squadcast_sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install squadcast_sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add squadcast_sdk

Shell and script usage with `uv`

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from squadcast_sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "squadcast_sdk",
# ]
# ///

from squadcast_sdk import SquadcastSDK

sdk = SquadcastSDK(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>")

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from squadcast_sdk import SquadcastSDK

async def main():

    async with SquadcastSDK(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as ss_client:

        res = await ss_client.analytics.get_org_analytics_async(from_="<value>", to="<value>")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`bearer_auth`	http	HTTP Bearer

To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

analytics

get_org_analytics - Get Org level analytics
get_team - Get Team level analytics

components

list - List Components
create - Create Component
get_by_id - Get Component By ID
update_by_id - Update Component By ID

dedup_keys

list_by_service - Get All Dedup Key Overlay by Service
delete - Delete Dedup Key Overlay

escalation_policies

get_by_team - Get Escalation Policy By team
create - Create Escalation Policies
remove - Remove Escalation Policy
get_by_id - Get Escalation Policy By ID
update - Update Escalation Policy

export_schedule

refresh_ical_link - Refresh Schedule ICal Link

extensions

extensions.msteams

create_or_update_config - Create Or Update MSTeams Configuration

global_event_rules

list - List Global Event Rules
create_rule - Create Global Event Rule
delete_by_id - Delete Global Event Rule by ID
get_by_id - Get Global Event Rule by ID
update_by_id - Update Global Event Rule by ID

global_event_rules.rulesets

create - Create Ruleset
delete - Delete GER Ruleset
get - Get Ruleset
update - Update Ruleset

global_event_rules.rulesets.rules

list - List Ruleset Rules
create - Create Rule
get_by_id - Get Rule by ID
update_by_id - Update Rule by ID
reorder - Reorder Ruleset By Index

global_oncall_reminder_rules

delete - Delete Global Oncall Reminder Rules
get - Get Global Oncall Reminder Rules
create - Create Global Oncall Reminder Rules
update - Update Global Oncall Reminder Rules

incidents

bulk_acknowledge - Bulk Acknowledge Incidents
export_incidents - Incident Export
bulk_update_priority - Bulk Incidents Priority Update
bulk_resolve - Bulk Resolve Incidents
get_by_id - Get Incident by ID
acknowledge - Acknowledge Incident
mark_slo_false_positive - Mark Incident SLO False Positive
update_priority - Incident Priority Update
reassign - Reassign Incident
resolve - Resolve Incident
get_status_by_request_ids - Get Incidents Status By RequestIDs

incidents.actions

rebuild_circleci_project - Rebuild a Project In CircleCI

incidents.actions.jira

create_ticket - Create a Ticket on Jira Cloud

incidents.actions.service_now

create_incident - Create an Incident in ServiceNow

incidents.additional_responders

list - Get Additional Responders
add - Add Additional Responders

incidents.auto_pause_transient_alerts

mark_as_not_transient - Mark as Not Transient
mark_as_transient - Mark as Transient

incidents.communication_card

create_slack_channel - Create Slack Channel in Communication Card
archive_slack_channel - Archive Slack Channel

incidents.communication_cards

create - Create Communication Card
delete - Delete Communication Card
update - Update Communication Card

incidents.incident_actions

create_jira_ticket - Create a Ticket on Jira Server

incidents.notes

create - Create Notes
list - Get All Notes
delete - Delete Note
update - Update Note

incidents.postmortems

remove - Delete Postmortem By Incident
get_by_incident - Get Postmortem By Incident
update_by_incident - Update Postmortem By Incident

incidents.snooze_notifications

unsnooze - Unsnooze Incident Notifications

issues

delete_by_id - Delete Issue By ID
update - Update Issue
list - List Status Page Issue States

maintenances

delete - Delete Maintenance By ID
update_by_id - Update Maintenance By ID

overlays

overlays.dedup_key

get_for_alert_source - Get Dedup Key Overlay for Alert Source

overrides

remove - Delete Schedule Override
get_by_id - Get Override by ID

postmortems

get_all - Get All Postmortems
create - Create Postmortem

rotations

list_by_schedule - List Schedule Rotations
create - Create Rotation
delete - Delete Rotation
get_by_id - Get Schedule Rotation by ID
update - Update Rotation
get_participants - Get Rotation Participants
update_participants - Update Rotation Participants

runbooks

attach - Attach Runbooks
get_all_by_team - Get All Runbooks By Team
create - Create Runbook
delete - Remove Runbook
get_by_id - Get Runbook By ID
update - Update Runbook

schedules

list - List Schedules
create - Create Schedule
delete - Delete Schedule
get_by_id - Get Schedule by ID
update - Update Schedule
pause_resume - Pause/Resume Schedule
change_timezone - Change Timezone
clone - Clone Schedule
get_ical_link - Get Schedule ICal Link
create_ical_link - Create Schedule ICal Link

schedules.overrides

list - List Overrides
create - Create Schedule Override
update - Update Schedule Override

services

get_all - Get All Services
create - Create Service
get_by_name - Get Services By Name
get_by_id - Get Service By ID
update - Update Service
delete - Delete Service
update_apta_config - Auto Pause Transient Alerts (APTA)
create_or_update_iag_config - Intelligent Alert Grouping (IAG)
update_notification_delay_config - Delayed Notification Config

services.deduplication_rules

get - Get Deduplication Rules
create_or_update - Create or Update Deduplication Rules

services.dependencies

create_or_update - Create or Update Dependencies

services.maintenance

create_or_update - Create or Update Maintenance Mode

services.overlay

get_optin_for_key_based_deduplication - Get Opt-in for Key Based Deduplication for a service
optin_for_key_based_deduplication - Opt-in for Key Based Deduplication for a service

services.overlay.custom_content_templates

get_all - Get All Custom Content Template Overlay by Service
create_or_update - Create or Update Notification Template Overlay

services.overlays

render_dedup_key - Render Dedup Key template

services.overlays.custom_content_templates

render - Render Custom Content Overlay
delete - Delete Notification Template Overlay
get - Get Custom Content Template Overlay

services.routing_rules

get - Get Routing Rules
create_or_update - Create or Update Routing Rules

services.suppression_rules

get - Get Suppression Rules
create_or_update - Create or Update Suppression Rules

services.tagging_rules

get - Get Tagging Rules
create_or_update - Create or Update Tagging Rules

slos

list_all - Get All SLOs
create - Create SLO
update - Update SLO
remove - Remove SLO
get - Get SLO By ID
mark_affected - Mark SLO Affected

squads

get_by_team - Get Squad By team
delete - Delete Squad
get - Get Squad By ID
update - Update Squad
list - Get All Squads
get_by_id - Get Squad By ID
update_v4 - Update Squad
remove_member - Remove Squad Member

squads_v4

create - Create Squad
update_name - Update Squad Name

status_pages

list - List Status Pages
create - Create Status Page
delete_by_id - Delete Status Page By ID
get_by_id - Get Status Page By ID
update - Update Status Page By ID
list_statuses - List Status Page Statuses

status_pages.component_groups

list - List Component Groups
remove_by_id - Delete Component Group By ID
get_by_id - Get Component Group By ID

status_pages.issues

list - List Issues
create - Create Issue
get_by_id - Get Issue By ID

status_pages.maintenances

list - List Maintenances
create - Create Maintenance

teams

get_all - Get All Teams
create - Create Team
get - Get Team By ID
update - Update Team
remove - Remove Team
add_bulk_member - Add Bulk Team Member
remove_member - Remove Team Member
update_member - Update Team Member
remove_role - Remove Team Role

teams.members

list - Get All Team Members
add - Add Team Member

teams.roles

get_all - Get All Team Roles
create - Create Team Role
update - Update Team Role

users

get_all - Get All Users
add - Add User
update_org_level_permissions - Update Org Level Permissions
delete - Delete User
get_roles - Get User Roles
remove_from_org - Remove User From Org
get_by_id - Get User By ID
update_by_id - Update User by userID

users.api_tokens

list - Get All Tokens
create - Create Token

webforms

list - Get All Webforms
create - Create Webform
update - Update Webform
remove - Remove Webform
get_by_id - Get Webform By ID

webhooks

create - Create Webhook
delete - Delete Webhook
get_by_id - Get Webhook By ID
update - Update Webhook

workflows

list - List Workflows
create - Create Workflow
bulk_enable_disable - Bulk Enable/Disable Workflows
delete - Delete Workflow
get_by_id - Get Workflow By ID
update - Update Workflow
update_actions_order - Update Actions Order
delete_action - Delete Workflow Action
update_action - Update Workflow Action
enable_disable - Enable/Disable Workflow

workflows.actions

create - Create Action
get_by_id - Get Workflow Action By ID

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.escalation_policies.update(escalation_policy_id="<id>", v3_escalation_policies_update_escalation_policy_request=open("example.file", "rb"))

    # Handle response
    print(res)

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:

from squadcast_sdk import SquadcastSDK
from squadcast_sdk.utils import BackoffStrategy, RetryConfig


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

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:

from squadcast_sdk import SquadcastSDK
from squadcast_sdk.utils import BackoffStrategy, RetryConfig


with SquadcastSDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>")

    # Handle response
    print(res)

Error Handling

SquadcastSDKError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`err.message`	`str`	Error message
`err.status_code`	`int`	HTTP response status code eg `404`
`err.headers`	`httpx.Headers`	HTTP response headers
`err.body`	`str`	HTTP body. Can be empty string if no body is returned.
`err.raw_response`	`httpx.Response`	Raw HTTP response
`err.data`		Optional. Some errors may contain structured data. See Error Classes.

Example

from squadcast_sdk import SquadcastSDK, errors


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:
    res = None
    try:

        res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>")

        # Handle response
        print(res)


    except errors.SquadcastSDKError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.BadRequestError):
            print(e.data.meta)  # models.CommonV3ErrorMeta

Error Classes

Primary errors:

SquadcastSDKError: The base class for HTTP error responses.
- PaymentRequiredError: Client error. Status code 402. *
- ForbiddenError: Access is forbidden. Status code 403. *
- NotFoundError: The server cannot find the requested resource. Status code 404. *
- ConflictError: The request conflicts with the current state of the server. Status code 409. *
- UnprocessableEntityError: Client error. Status code 422. *
- InternalServerError: Server error. Status code 500. *
- BadGatewayError: Server error. Status code 502. *
- ServiceUnavailableError: Service unavailable. Status code 503. *
- GatewayTimeoutError: Server error. Status code 504. *
- UnauthorizedError: Access is unauthorized. Status code 401. *
- BadRequestError: The server could not understand the request due to invalid syntax. Status code 400. *

Less common errors (8)

Network errors:

httpx.RequestError: Base class for request errors.
- httpx.ConnectError: HTTP client was unable to make a request to a server.
- httpx.TimeoutException: HTTP request timed out.

Inherit from SquadcastSDKError:

CommonV4Error: The server could not understand the request due to invalid syntax. Applicable to 31 of 229 methods.*
ResponseBodyError1: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 229 methods.*
ResponseBodyError2: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 229 methods.*
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

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

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    server_url="https://api.squadcast.tech",
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.analytics.get_org_analytics(from_="<value>", to="<value>")

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx 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 your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

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

from squadcast_sdk import SquadcastSDK
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = SquadcastSDK(client=http_client)

or you could wrap the client with your own custom logic:

from squadcast_sdk import SquadcastSDK
from squadcast_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = SquadcastSDK(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The SquadcastSDK class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from squadcast_sdk import SquadcastSDK
def main():

    with SquadcastSDK(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as ss_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with SquadcastSDK(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as ss_client:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from squadcast_sdk import SquadcastSDK
import logging

logging.basicConfig(level=logging.DEBUG)
s = SquadcastSDK(debug_logger=logging.getLogger("squadcast_sdk"))

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

Project details

Release history Release notifications | RSS feed

1.0.2

Mar 23, 2026

1.0.1

Mar 20, 2026

0.5.0

Mar 14, 2026

0.4.0

Feb 2, 2026

0.3.5

Nov 17, 2025

0.3.3

Nov 12, 2025

0.3.0

Nov 5, 2025

0.2.0

Sep 27, 2025

This version

0.1.3

Sep 19, 2025

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

squadcast_sdk-0.1.3.tar.gz (282.6 kB view details)

Uploaded Sep 19, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

squadcast_sdk-0.1.3-py3-none-any.whl (677.3 kB view details)

Uploaded Sep 19, 2025 Python 3

File details

Details for the file squadcast_sdk-0.1.3.tar.gz.

File metadata

Download URL: squadcast_sdk-0.1.3.tar.gz
Upload date: Sep 19, 2025
Size: 282.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.8.18

File hashes

Hashes for squadcast_sdk-0.1.3.tar.gz
Algorithm	Hash digest
SHA256	`07a5ff8d3c821df111e62e32acc8dfaec91cf31c586ee13b87e8d9fcbf68bf9f`
MD5	`67738862d5c9992adf0551ac74a97034`
BLAKE2b-256	`8e834a3fae19793aaf21471d50cdfb7ecc3b358e8c633b3c408d859803931ca3`

See more details on using hashes here.

File details

Details for the file squadcast_sdk-0.1.3-py3-none-any.whl.

File metadata

Download URL: squadcast_sdk-0.1.3-py3-none-any.whl
Upload date: Sep 19, 2025
Size: 677.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.8.18

File hashes

Hashes for squadcast_sdk-0.1.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`edec10e349abaea951eb71a41e8c8cfb3b033308a76d2cfaa92e1410ac26aee5`
MD5	`4d3f1672ea5546e49a71937b9049c5cc`
BLAKE2b-256	`e3a35d1fdc417b4bfe085fe9ed52747e3cecb805390fdf280377ac4843936d7a`

See more details on using hashes here.

squadcast_sdk 0.1.3

Navigation

Verified details

Owner

Maintainers

Unverified details

Project links

Meta

Project description

openapi

Summary

Table of Contents

SDK Installation

uv

PIP

Poetry

Shell and script usage with uv

IDE Support

PyCharm

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

File uploads

Retries

Error Handling

Example

Error Classes

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Resource Management

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

Project details

Verified details

Owner

Maintainers

Unverified details

Project links

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

Shell and script usage with `uv`