Rotations

Overview

Available Operations

• 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

list_by_schedule

List Schedule Rotations

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.list_by_schedule(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.RotationsGetScheduleRotationsResponse

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 Rotation

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.create(schedule_id="<id>", name="<value>", start_date="<value>", period="<value>", change_participants_frequency=62013, change_participants_unit="<value>", participant_groups=[])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
name	str	✔️	N/A
start_date	str	✔️	N/A
period	str	✔️	N/A
change_participants_frequency	int	✔️	N/A
change_participants_unit	str	✔️	N/A
participant_groups	List[models.V4ParticipantGroup]	✔️	N/A
color	Optional[str]	➖	N/A
custom_period_frequency	Optional[int]	➖	N/A
custom_period_unit	Optional[str]	➖	N/A
shift_time_slots	List[models.V4ShiftTimeSlot]	➖	N/A
end_date	Optional[str]	➖	N/A
ends_after_iterations	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RotationsCreateRotationResponse

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 Rotation

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.delete(schedule_id="<id>", rotation_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
rotation_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 Rotation by ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.get_by_id(schedule_id="<id>", rotation_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.RotationsGetScheduleRotationByIDResponse

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 Rotation

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.update(schedule_id="<id>", rotation_id="<id>", name="<value>", start_date="<value>", period="<value>", change_participants_frequency=183098, change_participants_unit="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
schedule_id	str	✔️	N/A
rotation_id	str	✔️	N/A
name	str	✔️	N/A
start_date	str	✔️	N/A
period	str	✔️	N/A
change_participants_frequency	int	✔️	N/A
change_participants_unit	str	✔️	N/A
color	Optional[str]	➖	N/A
custom_period_frequency	Optional[int]	➖	N/A
custom_period_unit	Optional[str]	➖	N/A
shift_time_slots	List[models.V4ShiftTimeSlot]	➖	N/A
end_date	Optional[str]	➖	N/A
ends_after_iterations	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RotationsUpdateRotationResponse

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_participants

Get Rotation Participants

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.get_participants(schedule_id="<id>", rotation_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.RotationsGetRotationParticipantsResponse

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_participants

Update Rotation Participants

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.rotations.update_participants(schedule_id="<id>", rotation_id="<id>", participant_groups=[])

    # Handle response
    print(res)

Parameters

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

Response

models.RotationsUpdateRotationParticipantsResponse

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