README

openapi

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

Summary

Table of Contents

• openapi

  • SDK Installation

  • IDE Support

  • SDK Example Usage

  • Authentication

  • Available Resources and Operations

  • Pagination

  • File uploads

  • Retries

  • Error Handling

  • Server Selection

  • Custom HTTP Client

  • Resource Management

  • Debugging

• Development

  • Maturity

  • Contributions

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

AdditionalResponders

• remove - Remove Additional Responders

Analytics

• get_org_analytics - Get Org level analytics

• get_team - Get Team level analytics

AuditLogs

• list - List all Audit Logs

• export - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.

• list_export_history - List all Audit Logs export history

• get_export_history_by_id - Get details of Audit Logs export history by ID

• get_by_id - Get audit log by ID

CommunicationCards

• get_all - Get All Communication Card

ComponentGroups

• create - Create Component Group

Components

• list - List Components

• create - Create Component

• get_by_id - Get Component By ID

• update_by_id - Update Component By ID

DedupKeys

• list_by_service - Get All Dedup Key Overlay by Service

• delete - Delete Dedup Key Overlay

EscalationPolicies

• 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

Exports

• get_details - Get Export Details

ExportSchedule

• refresh_ical_link - Refresh Schedule ICal Link

Extensions.Msteams

• create_or_update_config - Create Or Update MSTeams Configuration

Extensions.MsTeams

• get_config - Get MSTeams Config

Extensions.Webhooks

• get_all - Get All Webhooks

GlobalEventRules

• 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

GlobalEventRules.Rulesets

• create - Create Ruleset

• delete - Delete GER Ruleset

• get - Get Ruleset

• update - Update Ruleset

GlobalEventRules.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

GlobalOncallReminderRules

• 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.ServiceNow

• create_incident - Create an Incident in ServiceNow

Incidents.Actions.Webhook

• trigger - Trigger a Webhook Manually

Incidents.AdditionalResponders

• list - Get Additional Responders

• add - Add Additional Responders

Incidents.AutoPauseTransientAlerts

• mark_as_not_transient - Mark as Not Transient

• mark_as_transient - Mark as Transient

Incidents.CommunicationCard

• create_slack_channel - Create Slack Channel in Communication Card

• archive_slack_channel - Archive Slack Channel

Incidents.CommunicationCards

• create - Create Communication Card

• delete - Delete Communication Card

• update - Update Communication Card

Incidents.Events

• get - Get Incident Events

Incidents.Export

• export_async - Incident Export Async

Incidents.IncidentActions

• 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.SnoozeNotifications

• unsnooze - Unsnooze Incident Notifications

Incidents.Tags

• update - Update Tag

• append - Append Tag

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.DedupKey

• 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

Rules

• delete_by_id - Delete Rule by ID

Rulesets

• reorder - Reorder Ruleset

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.Export

• delete_ical_link - Delete 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.DeduplicationRules

• get - Get Deduplication Rules

• create_or_update - Create or Update Deduplication Rules

Services.Dependencies

• create_or_update - Create or Update Dependencies

Services.Extensions

• update - Update Slack Extension

Services.Maintenance

• create_or_update - Create or Update Maintenance Mode

Services.MaintenanceMode

• get - Get 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.CustomContentTemplates

• 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.CustomContentTemplates

• render - Render Custom Content Overlay

• delete - Delete Notification Template Overlay

• get - Get Custom Content Template Overlay

Services.Overlays.DedupKey

• update - Update Dedup Key Overlay

Services.RoutingRules

• get - Get Routing Rules

• create_or_update - Create or Update Routing Rules

Services.SuppressionRules

• get - Get Suppression Rules

• create_or_update - Create or Update Suppression Rules

Services.TaggingRules

• 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

Slos.FalsePositive

• mark - Mark SLO False Positive

SnoozeNotifications

• snooze - Snooze Incident Notifications

Squads

• list - Get All Squads

• get_by_id - Get Squad By ID

• update_v4 - Update Squad

• remove_member - Remove Squad Member

• delete - Delete Squad

Squads.Members

• update - Update Squad Member

SquadsV4

• create - Create Squad

• update_name - Update Squad Name

Statuspages.Maintenances

• get_by_id - Get Maintenance By ID

StatusPages

• 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

StatusPages.ComponentGroups

• list - List Component Groups

• remove_by_id - Delete Component Group By ID

• get_by_id - Get Component Group By ID

StatusPages.Components

• delete_by_id - Delete Component By ID

StatusPages.Issues

• list - List Issues

• create - Create Issue

• get_by_id - Get Issue By ID

StatusPages.Maintenances

• list - List Maintenances

• create - Create Maintenance

Subscribers

• list - List Subscribers

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.ApiToken

• remove - Remove Token

Users.ApiTokens

• 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

Workflows.Logs

• get - Get Workflow Logs

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:

from datetime import date
from squadcast_sdk import SquadcastSDK


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

    res = ss_client.audit_logs.list(page_size=832442, page_number=555332, start_date=date.fromisoformat("2023-03-04"), end_date=date.fromisoformat("2024-08-07"))

    while res is not None:
        # Handle items

        res = res.next()

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 32 of 230 methods.*

• ResponseBodyError1: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 230 methods.*

• ResponseBodyError2: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 230 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.com",
    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