Schedules.Overrides

Overview

Available Operations

• list - List Overrides

• create - Create Schedule Override

• update - Update Schedule Override

list

List Overrides

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.overrides.list(schedule_id="<id>", start_time="<value>", end_time="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
start_time	str	✔️	N/A
end_time	str	✔️	N/A
participant_id	Optional[str]	➖	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.OverridesListOverridesResponse

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 Override

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.overrides.create(schedule_id="<id>", start_time="<value>", end_time="<value>", reason="<value>", overridden_participant={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    }, override_with={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    })

    # Handle response
    print(res)

Parameters

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

Response

models.OverridesCreateScheduleOverrideResponse

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 Override

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.schedules.overrides.update(schedule_id="<id>", override_id="<id>", start_time="<value>", end_time="<value>", reason="<value>", overridden_participant={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    }, override_with={
        "group": [],
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
override_id	str	✔️	N/A
start_time	str	✔️	N/A
end_time	str	✔️	N/A
reason	str	✔️	N/A
overridden_participant	models.V4OverrideParticipantGroup	✔️	N/A
override_with	models.V4OverrideParticipantGroup	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.OverridesUpdateScheduleOverrideResponse

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	*/*