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 import SquadcastSDK
with SquadcastSDK(
refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:
res = squadcast_sdk.rotations.list_by_schedule(schedule_id="<id>")
# Handle response
print(res)
Parameters
schedule_id
str
✔️
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsGetScheduleRotationsResponse
Errors
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
Parameters
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
color
Optional[str]
➖
N/A
custom_period_frequency
Optional[int]
➖
N/A
custom_period_unit
Optional[str]
➖
N/A
end_date
Optional[str]
➖
N/A
ends_after_iterations
Optional[int]
➖
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsCreateRotationResponse
Errors
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
Parameters
schedule_id
str
✔️
N/A
rotation_id
str
✔️
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
Errors
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
Parameters
schedule_id
str
✔️
N/A
rotation_id
str
✔️
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsGetScheduleRotationByIDResponse
Errors
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
Parameters
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
end_date
Optional[str]
➖
N/A
ends_after_iterations
Optional[int]
➖
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsUpdateRotationResponse
Errors
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
Parameters
schedule_id
str
✔️
N/A
rotation_id
str
✔️
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsGetRotationParticipantsResponse
Errors
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
Parameters
schedule_id
str
✔️
N/A
rotation_id
str
✔️
N/A
retries
➖
Configuration to override the default retry behavior of the client.
Response
models.RotationsUpdateRotationParticipantsResponse
Errors
errors.CommonV4Error
400, 401, 402, 403, 404, 409, 422
application/json
errors.CommonV4Error
500, 502, 503, 504
application/json
errors.SDKDefaultError
4XX, 5XX
*/*
Last updated