Incidents.CommunicationCards

Overview

Available Operations

• create - Create Communication Card

• delete - Delete Communication Card

• update - Update Communication Card

create

Create Communication Card

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.incidents.communication_cards.create(incident_id="<id>", type_="<value>", url="https://oily-injunction.info", title="<value>")

    # Handle response
    print(res)

Parameters

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

Response

models.CommunicationCardsCreateCommunicationCardResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete

Delete communication card by providing communicationCardId for incidentId mentioned in params

Requires access_token as a Bearer {{token}} in the Authorization header with service-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.incidents.communication_cards.delete(incident_id="<id>", communication_card_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.CommunicationCardsDeleteCommunicationCardResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update

Update Communication Card

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.incidents.communication_cards.update(incident_id="<id>", communication_card_id="<id>", title="<value>", type_="<value>", url="https://major-cantaloupe.com/")

    # Handle response
    print(res)

Parameters

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

Response

models.CommunicationCardsUpdateCommunicationCardResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*