Schedules

Overview

Available Operations

• 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

list

List Schedules

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.list(team_id="<id>")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
team_id	str	✔️	N/A
schedule_i_ds	List[int]	➖	N/A
participants	List[str]	➖	N/A
schedule_name	Optional[str]	➖	N/A
my_on_call	Optional[bool]	➖	N/A
you_and_your_squads	Optional[bool]	➖	N/A
search	Optional[str]	➖	N/A
hide_paused	Optional[bool]	➖	N/A
owner_id	Optional[str]	➖	N/A
escalation_policies	List[str]	➖	N/A
without_escalation_policy	Optional[bool]	➖	N/A
page_size	Optional[int]	➖	N/A
cursor	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesListSchedulesResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

create

Create Schedule

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.create(name="<value>", description="fumigate pfft kooky whoa but lighthearted popularity", team_id="<id>", owner_id="<id>", owner_type="user", time_zone="Pacific/Easter", tags=[
        {
            "key": "<key>",
            "value": "<value>",
            "color": "pink",
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
name	str	✔️	N/A
description	str	✔️	N/A
team_id	str	✔️	N/A
owner_id	str	✔️	N/A
owner_type	models.V4CreateScheduleRequestOwnerType	✔️	N/A
time_zone	str	✔️	N/A
tags	List[models.V4Tag]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesCreateScheduleResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete

Delete Schedule

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.delete(schedule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

Get Schedule by ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.get_by_id(schedule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesGetScheduleByIDResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update

Update Schedule

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.update(schedule_id="<id>", name="<value>", description="smoothly festival unruly alert now far provided absentmindedly", owner_id="<id>", owner_type="squad", tags=[])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
name	str	✔️	N/A
description	str	✔️	N/A
owner_id	str	✔️	N/A
owner_type	models.V4UpdateScheduleRequestOwnerType	✔️	N/A
tags	List[models.V4Tag]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesUpdateScheduleResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

pause_resume

Pause/Resume Schedule

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.pause_resume(schedule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
action	Optional[models.Action]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesPauseresumeScheduleResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

change_timezone

Change Timezone

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.change_timezone(schedule_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
time_zone	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesChangeTimezoneResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

clone

Clone Schedule

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.clone(schedule_id="<id>", request_body={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
request_body	models.SchedulesCloneScheduleRequestBody	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SchedulesCloneScheduleResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_ical_link

Get Schedule ICal Link

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.get_ical_link(schedule_id="<id>", my_on_call=False)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
my_on_call	bool	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ExportGetScheduleIcalLinkResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

create_ical_link

Create Schedule ICal Link

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.create_ical_link(schedule_id="<id>", my_on_call=True, request_body={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
my_on_call	bool	✔️	N/A
request_body	models.ExportCreateScheduleIcalLinkRequestBody	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ExportCreateScheduleIcalLinkResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*