Python Client SDK Generated by Speakeasy.

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for gaurav654 from gravatar.com gaurav654

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Speakeasy
  • Requires: Python >=3.10
Report project as malware

Project description

squadcast_sdk

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

Built by Speakeasy License: MIT

Summary

Squadcast: ## Overview The Squadcast API provides developers the capability to extend and utilize Squadcast in conjunction with other services. Our API has resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Note: Customers using the V2 version of the Squadcast API would need to migrate to Squadcast API V3, as the former would be deprecated shortly.

Service Regions

Squadcast allows customers to choose the geographic region of the Squadcast data centers that host their account. When signing up, you can choose the service region. Currently, the available options are the United States (US) and Europe (EU).

Service Region API Endpoints
US Authentication: https://auth.squadcast.com · Other APIs: https://api.squadcast.com
EU Authentication: https://auth.eu.squadcast.com · Other APIs: https://api.eu.squadcast.com

Authentication

In order to access the API programmatically, HTTP bearer authentication needs to be used. HTTP bearer authentication must be constructed using an access_token, passed as the Authorization header for each request, for example Authorization: Bearer eyJleHAiOjE2MzU1OTE1OTIsImp0aSI6Im.

Steps to procure the access_token:

  1. Generate a refresh_token (API Token) from the Squadcast web app. More details on how to get the refresh_token can be found in the Squadcast support documentation.
  2. Call the authentication API with the refresh_token to obtain an access_token.
  3. Use the access_token as a Bearer token in the Authorization header for all subsequent API requests.

Example — Generating an Access Token

curl --location --request GET 'https://auth.squadcast.com/oauth/access-token' \
--header 'X-Refresh-Token: 0d2a1a9a454dxxxxxxxxxxxx'

The API response will look similar to:

{
  "data": {
    "access_token": "eyJhbGciOiJIUxxxxx.xxxxxxxxxxxxxxx.xxxxxxxxxxxxxxx",
    "expires_at": 1587412870,
    "issued_at": 1587240070,
    "refresh_token": "0d2a1a9a454dxxxxxxxxxxxx",
    "type": "bearer"
  }
}

Access Control

There are three different types of user roles in Squadcast: account_owner, stakeholder, and user. Refresh tokens upon creation are mapped with one of the mentioned user roles, and access to different resources is dependent on the permissions granted to these roles. For more information, please refer to the Squadcast support documentation.

Authorization

The access token authorizes users the ability to access different APIs, based on the user roles described above. Pass the access token as a Bearer token in the Authorization header of every request.

Table of Contents

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.10"
# dependencies = [
#     "squadcast_sdk",
# ]
# ///

from squadcast 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.

SDK Example Usage

Example

# Synchronous Example
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 import SquadcastSDK

async def main():

    async with SquadcastSDK(
        refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
    ) as squadcast_sdk:

        res = await squadcast_sdk.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
refresh_token_auth http Custom HTTP

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

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

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

    # Handle response
    print(res)

Available Resources and Operations

Available methods

AdditionalResponders

  • remove - Remove Additional Responders

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

DedupKeys

EscalationPolicies

Exports

ExportSchedule

Extensions.Msteams

Extensions.MsTeams

Extensions.Webhooks

GlobalEventRules

GlobalEventRules.Rulesets

GlobalEventRules.Rulesets.Rules

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

Incidents.Actions

Incidents.Actions.Jira
Incidents.Actions.ServiceNow
Incidents.Actions.Webhook
  • trigger - Trigger a Webhook Manually

Incidents.AdditionalResponders

  • list - Get Additional Responders
  • add - Add Additional Responders

Incidents.AutoPauseTransientAlerts

Incidents.CommunicationCard

Incidents.CommunicationCards

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

Incidents.Events

  • get - Get Incident Events

Incidents.Export

Incidents.IncidentActions

Incidents.Notes

Incidents.Postmortems

Incidents.SnoozeNotifications

  • unsnooze - Unsnooze Incident Notifications

Incidents.Tags

Issues

Maintenances

Overlays.DedupKey

Overrides

Postmortems

Rotations

Rules

Rulesets

Runbooks

Schedules

Schedules.Export

Schedules.Overrides

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

Services

Services.DeduplicationRules

Services.Dependencies

Services.Extensions

  • update - Update Slack Extension

Services.Maintenance

Services.MaintenanceMode

  • get - Get Maintenance Mode

Services.Overlay

Services.Overlay.CustomContentTemplates

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

Services.Overlays

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

Services.SuppressionRules

Services.TaggingRules

Slos

Slos.FalsePositive

  • mark - Mark SLO False Positive

SnoozeNotifications

  • snooze - Snooze Incident Notifications

Squads

Squads.Members

  • update - Update Squad Member

SquadsV4

Statuspages.Maintenances

StatusPages

StatusPages.ComponentGroups

StatusPages.Components

StatusPages.Issues

StatusPages.Maintenances

  • list - List Maintenances
  • create - Create Maintenance

Subscribers

  • list - List Subscribers

Teams

Teams.Members

  • list - Get All Team Members
  • add - Add Team Member

Teams.Roles

Users

Users.ApiToken

Users.ApiTokens

Webforms

Webhooks

Workflows

Workflows.Actions

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 import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 import SquadcastSDK
from squadcast.utils import BackoffStrategy, RetryConfig


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 import SquadcastSDK
from squadcast.utils import BackoffStrategy, RetryConfig


with SquadcastSDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 import SquadcastSDK, errors


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:
    res = None
    try:

        res = squadcast_sdk.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:

Less common errors (8)

Network errors:

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

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:

# Server Description
0 https://api.eu.squadcast.com production EU env
1 https://api.squadcast.com production US env

Example

from squadcast import SquadcastSDK


with SquadcastSDK(
    server_idx=0,
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

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

    # Handle response
    print(res)

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:

from squadcast import SquadcastSDK


with SquadcastSDK(
    server_url="https://api.squadcast.com",
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.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 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 import SquadcastSDK
from squadcast.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 import SquadcastSDK
def main():

    with SquadcastSDK(
        refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
    ) as squadcast_sdk:
        # Rest of application here...


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

    async with SquadcastSDK(
        refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
    ) as squadcast_sdk:
        # 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 import SquadcastSDK
import logging

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

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

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for gaurav654 from gravatar.com gaurav654

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Speakeasy
  • Requires: Python >=3.10

Release history Release notifications | RSS feed

1.0.2

This version

1.0.1

0.5.0

0.4.0

0.3.5

0.3.3

0.3.0

0.2.0

0.1.3

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-1.0.1.tar.gz (303.7 kB view details)

Uploaded Source

Built Distribution

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

squadcast_sdk-1.0.1-py3-none-any.whl (727.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: squadcast_sdk-1.0.1.tar.gz
  • Upload date:
  • Size: 303.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for squadcast_sdk-1.0.1.tar.gz
Algorithm Hash digest
SHA256 29ef0ed6d5b4b0381fef189147fb1f5819ee01feb8e879206fe1bacbe5f6658b
MD5 38d5c3be1dd3e0ff0af9bf16f35ba13a
BLAKE2b-256 a995d7f0750373eeb9be2906a402df69b221c9bc54697627c2a2a9d360c4d59f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: squadcast_sdk-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 727.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for squadcast_sdk-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 af779565d4c3db9cf58143352a86ca266081ee80bb75fa83c1154ddd284a7ba8
MD5 fa00b2e253056e91b586654a1d390f92
BLAKE2b-256 d8e74d65516620fcf16415de48afc4655b539f440d51c27372e6e16f9e0df8d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page