Overview

Squadcast SDK for TypeScript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage openapi API.

Summary

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @solarwinds/squadcast-sdk-typescript

PNPM

pnpm add @solarwinds/squadcast-sdk-typescript

Bun

bun add @solarwinds/squadcast-sdk-typescript

Yarn

yarn add @solarwinds/squadcast-sdk-typescript

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.analytics.getOrganization({
    from: "<value>",
    to: "<value>",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name

Type

Scheme

bearerAuth

http

HTTP Bearer

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.analytics.getOrganization({
    from: "<value>",
    to: "<value>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Analytics

getOrganization - Get Org level analytics
getTeam - Get Team level analytics

AuditLogs

list - List all Audit Logs
export - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.
listExportHistory - List all Audit Logs export history
getById - Get audit log by ID

AuditLogs.ExportHistory

get - Get details of Audit Logs export history by ID

CommunicationCards

createSlackChannel - Create Slack Channel in Communication Card
delete - Delete Communication Card

Components

list - List Components
deleteById - Delete Component By ID

DedupKeyOverlays

renderTemplate - Render Dedup Key template
getForAlertSource - Get Dedup Key Overlay for Alert Source
update - Update Dedup Key Overlay

DeduplicationRules

getRules - Get Deduplication Rules
createOrUpdate - Create or Update Deduplication Rules

EscalationPolicies

listByTeam - Get Escalation Policy By team
create - Create Escalation Policies
remove - Remove Escalation Policy
getById - Get Escalation Policy By ID
update - Update Escalation Policy

ExportSchedule

refreshIcalLink - Refresh Schedule ICal Link

Extensions.Webhooks

create - Create Webhook
update - Update Webhook

GlobalEventRules

list - List Global Event Rules
create - Create Global Event Rule
deleteById - Delete Global Event Rule by ID
getById - Get Global Event Rule by ID
updateById - Update Global Event Rule by ID

GlobalEventRules.Rulesets

create - Create Ruleset
get - Get Ruleset
update - Update Ruleset
reorder - Reorder Ruleset
listRules - List Ruleset Rules
createRule - Create Rule
updateRule - Update Rule by ID

GlobalEventRules.Rulesets.Rules

get - Get Rule by ID
reorderByIndex - Reorder Ruleset By Index

GlobalOncallReminderRules

delete - Delete Global Oncall Reminder Rules
get - Get Global Oncall Reminder Rules
create - Create Global Oncall Reminder Rules
update - Update Global Oncall Reminder Rules

Incidents

archiveSlackChannel - Archive Slack Channel
getAllCommunicationCards - Get All Communication Card
updateCommunicationCard - Update Communication Card
attachRunbooks - Attach Runbooks
createJiraServerTicket - Create a Ticket on Jira Server
createInServiceNow - Create an Incident in ServiceNow
triggerWebhook - Trigger a Webhook Manually
getAdditionalResponders - Get Additional Responders
removeAdditionalResponder - Remove Additional Responders
markAsTransient - Mark as Transient
updatePostmortem - Update Postmortem By Incident
unsnoozeNotifications - Unsnooze Incident Notifications
export - Incident Export
exportAsync - Incident Export Async
bulkUpdatePriority - Bulk Incidents Priority Update
bulkResolve - Bulk Resolve Incidents
getById - Get Incident by ID
acknowledge - Acknowledge Incident
markSloFalsePositive - Mark Incident SLO False Positive
updatePriority - Incident Priority Update
reassign - Reassign Incident
resolve - Resolve Incident
getStatusByRequestIds - Get Incidents Status By RequestIDs

Incidents.Actions.JiraCloud

createTicket - Create a Ticket on Jira Cloud

Incidents.AdditionalResponders

add - Add Additional Responders

Incidents.AutoPauseTransientAlerts

markAsNotTransient - Mark as Not Transient

Incidents.CommunicationCards

create - Create Communication Card

Incidents.Events

list - Get Incident Events

Incidents.Notes

create - Create Notes
list - Get All Notes
update - Update Note

Incidents.Postmortems

getAll - Get All Postmortems
getByIncident - Get Postmortem By Incident
create - Create Postmortem

Incidents.Snooze

set - Snooze Incident Notifications

Incidents.Tags

update - Update Tag
append - Append Tag

IncidentsV3

bulkAcknowledge - Bulk Acknowledge Incidents

Issues

create - Create Issue
delete - Delete Issue By ID

Maintenances

create - Create Maintenance
deleteById - Delete Maintenance By ID

Msteams

createOrUpdateConfiguration - Create Or Update MSTeams Configuration

Overlays

getAllDedupKeysByService - Get All Dedup Key Overlay by Service

Postmortems

deleteByIncident - Delete Postmortem By Incident

Rotations

getScheduleRotations - List Schedule Rotations
delete - Delete Rotation
getById - Get Schedule Rotation by ID
getParticipants - Get Rotation Participants
updateParticipants - Update Rotation Participants

RoutingRules

get - Get Routing Rules
createOrUpdate - Create or Update Routing Rules

Runbooks

listByTeam - Get All Runbooks By Team
create - Create Runbook
remove - Remove Runbook
getById - Get Runbook By ID
update - Update Runbook

Schedules

list - List Schedules
create - Create Schedule
delete - Delete Schedule
getById - Get Schedule by ID
update - Update Schedule
changeTimezone - Change Timezone
clone - Clone Schedule
createIcalLink - Create Schedule ICal Link
deleteOverride - Delete Schedule Override
getOverrideById - Get Override by ID
createRotation - Create Rotation

Schedules.Actions

pauseResume - Pause/Resume Schedule

Schedules.Export

getIcalLink - Get Schedule ICal Link

Schedules.Overrides

create - Create Schedule Override
update - Update Schedule Override

Schedules.Rotations

update - Update Rotation

Services

list - Get All Services
create - Create Service
listByName - Get Services By Name
getById - Get Service By ID
update - Update Service
delete - Delete Service
createOrUpdateIAGConfig - Intelligent Alert Grouping (IAG)
updateNotificationDelayConfig - Delayed Notification Config
updateSlackExtension - Update Slack Extension
getCustomContentTemplates - Get All Custom Content Template Overlay by Service

Services.AptaConfig

createOrUpdate - Auto Pause Transient Alerts (APTA)

Services.Dependencies

createOrUpdate - Create or Update Dependencies

Services.Maintenance

get - Get Maintenance Mode
createOrUpdate - Create or Update Maintenance Mode

Services.Overlay

getOptinForKeyBasedDeduplication - Get Opt-in for Key Based Deduplication for a service

Services.Overlays

optinKeyBasedDeduplication - Opt-in for Key Based Deduplication for a service
renderCustomContent - Render Custom Content Overlay
deleteCustomContent - Delete Notification Template Overlay
getCustomContentTemplate - Get Custom Content Template Overlay

Services.Overlays.CustomContent

createOrUpdate - Create or Update Notification Template Overlay

Services.Overlays.DedupKey

delete - Delete Dedup Key Overlay

Services.SuppressionRules

list - Get Suppression Rules
createOrUpdate - Create or Update Suppression Rules

Services.TaggingRules

list - Get Tagging Rules
createOrUpdate - Create or Update Tagging Rules

Slos

list - Get All SLOs
create - Create SLO
update - Update SLO
remove - Remove SLO
getById - Get SLO By ID
markFalsePositive - Mark SLO False Positive

Squads

list - Get All Squads
createV4 - Create Squad
updateMember - Update Squad Member
updateName - Update Squad Name
delete - Delete Squad

Squads.Members

remove - Remove Squad Member

SquadsV4

getById - Get Squad By ID
update - Update Squad

StatusPages

list - List Status Pages
create - Create Status Page
delete - Delete Status Page By ID
getById - Get Status Page By ID
updateById - Update Status Page By ID
getIssueById - Get Issue By ID
listStatuses - List Status Page Statuses

StatusPages.ComponentGroups

list - List Component Groups
create - Create Component Group
deleteById - Delete Component Group By ID
getById - Get Component Group By ID

StatusPages.Components

create - Create Component
getById - Get Component By ID
updateById - Update Component By ID

StatusPages.Issues

list - List Issues
update - Update Issue

StatusPages.Maintenances

list - List Maintenances
getById - Get Maintenance By ID
updateById - Update Maintenance By ID

Teams

list - Get All Teams
create - Create Team
getById - Get Team By ID
update - Update Team
remove - Remove Team
listMembers - Get All Team Members
getRoles - Get All Team Roles

Teams.Members

add - Add Team Member
bulkAdd - Add Bulk Team Member
remove - Remove Team Member
update - Update Team Member

Teams.Roles

create - Create Team Role
remove - Remove Team Role
update - Update Team Role

Users

getAllTokens - Get All Tokens
removeToken - Remove Token
list - Get All Users
add - Add User
updateOrgLevelPermissions - Update Org Level Permissions
delete - Delete User
getRoles - Get User Roles
removeFromOrg - Remove User From Org
getById - Get User By ID
updateById - Update User by userID

Webforms

getAll - Get All Webforms
create - Create Webform
update - Update Webform
remove - Remove Webform
getById - Get Webform By ID

Webhooks

getAll - Get All Webhooks
delete - Delete Webhook
getById - Get Webhook By ID

Workflows

list - List Workflows
create - Create Workflow
bulkEnableDisable - Bulk Enable/Disable Workflows
delete - Delete Workflow
getById - Get Workflow By ID
update - Update Workflow
updateActionsOrder - Update Actions Order
deleteAction - Delete Workflow Action
updateAction - Update Workflow Action
enableDisable - Enable/Disable Workflow

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

analyticsGetOrganization - Get Org level analytics
analyticsGetTeam - Get Team level analytics
auditLogsExport - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.
auditLogsExportHistoryGet - Get details of Audit Logs export history by ID
auditLogsGetById - Get audit log by ID
auditLogsList - List all Audit Logs
auditLogsListExportHistory - List all Audit Logs export history
communicationCardsCreateSlackChannel - Create Slack Channel in Communication Card
communicationCardsDelete - Delete Communication Card
componentsDeleteById - Delete Component By ID
componentsList - List Components
dedupKeyOverlaysGetForAlertSource - Get Dedup Key Overlay for Alert Source
dedupKeyOverlaysRenderTemplate - Render Dedup Key template
dedupKeyOverlaysUpdate - Update Dedup Key Overlay
deduplicationRulesCreateOrUpdate - Create or Update Deduplication Rules
deduplicationRulesGetRules - Get Deduplication Rules
escalationPoliciesCreate - Create Escalation Policies
escalationPoliciesGetById - Get Escalation Policy By ID
escalationPoliciesListByTeam - Get Escalation Policy By team
escalationPoliciesRemove - Remove Escalation Policy
escalationPoliciesUpdate - Update Escalation Policy
exportScheduleRefreshIcalLink - Refresh Schedule ICal Link
exportsGetDetails - Get Export Details
extensionsMsteamsGetConfig - Get MSTeams Config
extensionsWebhooksCreate - Create Webhook
extensionsWebhooksUpdate - Update Webhook
globalEventRulesCreate - Create Global Event Rule
globalEventRulesDeleteById - Delete Global Event Rule by ID
globalEventRulesGetById - Get Global Event Rule by ID
globalEventRulesList - List Global Event Rules
globalEventRulesRulesetsCreate - Create Ruleset
globalEventRulesRulesetsCreateRule - Create Rule
globalEventRulesRulesetsGet - Get Ruleset
globalEventRulesRulesetsListRules - List Ruleset Rules
globalEventRulesRulesetsReorder - Reorder Ruleset
globalEventRulesRulesetsRulesGet - Get Rule by ID
globalEventRulesRulesetsRulesReorderByIndex - Reorder Ruleset By Index
globalEventRulesRulesetsUpdate - Update Ruleset
globalEventRulesRulesetsUpdateRule - Update Rule by ID
globalEventRulesUpdateById - Update Global Event Rule by ID
globalOncallReminderRulesCreate - Create Global Oncall Reminder Rules
globalOncallReminderRulesDelete - Delete Global Oncall Reminder Rules
globalOncallReminderRulesGet - Get Global Oncall Reminder Rules
globalOncallReminderRulesUpdate - Update Global Oncall Reminder Rules
incidentActionsCircleciRebuild - Rebuild a Project In CircleCI
incidentsAcknowledge - Acknowledge Incident
incidentsActionsJiraCloudCreateTicket - Create a Ticket on Jira Cloud
incidentsAdditionalRespondersAdd - Add Additional Responders
incidentsArchiveSlackChannel - Archive Slack Channel
incidentsAttachRunbooks - Attach Runbooks
incidentsAutoPauseTransientAlertsMarkAsNotTransient - Mark as Not Transient
incidentsBulkResolve - Bulk Resolve Incidents
incidentsBulkUpdatePriority - Bulk Incidents Priority Update
incidentsCommunicationCardsCreate - Create Communication Card
incidentsCreateInServiceNow - Create an Incident in ServiceNow
incidentsCreateJiraServerTicket - Create a Ticket on Jira Server
incidentsEventsList - Get Incident Events
incidentsExport - Incident Export
incidentsExportAsync - Incident Export Async
incidentsGetAdditionalResponders - Get Additional Responders
incidentsGetAllCommunicationCards - Get All Communication Card
incidentsGetById - Get Incident by ID
incidentsGetStatusByRequestIds - Get Incidents Status By RequestIDs
incidentsMarkAsTransient - Mark as Transient
incidentsMarkSloFalsePositive - Mark Incident SLO False Positive
incidentsNotesCreate - Create Notes
incidentsNotesList - Get All Notes
incidentsNotesUpdate - Update Note
incidentsPostmortemsCreate - Create Postmortem
incidentsPostmortemsGetAll - Get All Postmortems
incidentsPostmortemsGetByIncident - Get Postmortem By Incident
incidentsReassign - Reassign Incident
incidentsRemoveAdditionalResponder - Remove Additional Responders
incidentsResolve - Resolve Incident
incidentsSnoozeSet - Snooze Incident Notifications
incidentsTagsAppend - Append Tag
incidentsTagsUpdate - Update Tag
incidentsTriggerWebhook - Trigger a Webhook Manually
incidentsUnsnoozeNotifications - Unsnooze Incident Notifications
incidentsUpdateCommunicationCard - Update Communication Card
incidentsUpdatePostmortem - Update Postmortem By Incident
incidentsUpdatePriority - Incident Priority Update
incidentsV3BulkAcknowledge - Bulk Acknowledge Incidents
issuesCreate - Create Issue
issuesDelete - Delete Issue By ID
issueStatesList - List Status Page Issue States
maintenancesCreate - Create Maintenance
maintenancesDeleteById - Delete Maintenance By ID
msteamsCreateOrUpdateConfiguration - Create Or Update MSTeams Configuration
notesDelete - Delete Note
overlaysGetAllDedupKeysByService - Get All Dedup Key Overlay by Service
overridesList - List Overrides
postmortemsDeleteByIncident - Delete Postmortem By Incident
rotationsDelete - Delete Rotation
rotationsGetById - Get Schedule Rotation by ID
rotationsGetParticipants - Get Rotation Participants
rotationsGetScheduleRotations - List Schedule Rotations
rotationsUpdateParticipants - Update Rotation Participants
routingRulesCreateOrUpdate - Create or Update Routing Rules
routingRulesGet - Get Routing Rules
rulesDeleteById - Delete Rule by ID
rulesetsDeleteById - Delete GER Ruleset
runbooksCreate - Create Runbook
runbooksGetById - Get Runbook By ID
runbooksListByTeam - Get All Runbooks By Team
runbooksRemove - Remove Runbook
runbooksUpdate - Update Runbook
scheduleExportDeleteICalLink - Delete ICal Link
schedulesActionsPauseResume - Pause/Resume Schedule
schedulesChangeTimezone - Change Timezone
schedulesClone - Clone Schedule
schedulesCreate - Create Schedule
schedulesCreateIcalLink - Create Schedule ICal Link
schedulesCreateRotation - Create Rotation
schedulesDelete - Delete Schedule
schedulesDeleteOverride - Delete Schedule Override
schedulesExportGetIcalLink - Get Schedule ICal Link
schedulesGetById - Get Schedule by ID
schedulesGetOverrideById - Get Override by ID
schedulesList - List Schedules
schedulesOverridesCreate - Create Schedule Override
schedulesOverridesUpdate - Update Schedule Override
schedulesRotationsUpdate - Update Rotation
schedulesUpdate - Update Schedule
servicesAptaConfigCreateOrUpdate - Auto Pause Transient Alerts (APTA)
servicesCreate - Create Service
servicesCreateOrUpdateIAGConfig - Intelligent Alert Grouping (IAG)
servicesDelete - Delete Service
servicesDependenciesCreateOrUpdate - Create or Update Dependencies
servicesGetById - Get Service By ID
servicesGetCustomContentTemplates - Get All Custom Content Template Overlay by Service
servicesList - Get All Services
servicesListByName - Get Services By Name
servicesMaintenanceCreateOrUpdate - Create or Update Maintenance Mode
servicesMaintenanceGet - Get Maintenance Mode
servicesOverlayGetOptinForKeyBasedDeduplication - Get Opt-in for Key Based Deduplication for a service
servicesOverlaysCustomContentCreateOrUpdate - Create or Update Notification Template Overlay
servicesOverlaysDedupKeyDelete - Delete Dedup Key Overlay
servicesOverlaysDeleteCustomContent - Delete Notification Template Overlay
servicesOverlaysGetCustomContentTemplate - Get Custom Content Template Overlay
servicesOverlaysOptinKeyBasedDeduplication - Opt-in for Key Based Deduplication for a service
servicesOverlaysRenderCustomContent - Render Custom Content Overlay
servicesSuppressionRulesCreateOrUpdate - Create or Update Suppression Rules
servicesSuppressionRulesList - Get Suppression Rules
servicesTaggingRulesCreateOrUpdate - Create or Update Tagging Rules
servicesTaggingRulesList - Get Tagging Rules
servicesUpdate - Update Service
servicesUpdateNotificationDelayConfig - Delayed Notification Config
servicesUpdateSlackExtension - Update Slack Extension
sloMarkAffected - Mark SLO Affected
slosCreate - Create SLO
slosGetById - Get SLO By ID
slosList - Get All SLOs
slosMarkFalsePositive - Mark SLO False Positive
slosRemove - Remove SLO
slosUpdate - Update SLO
squadsCreateV4 - Create Squad
squadsDelete - Delete Squad
squadsList - Get All Squads
squadsMembersRemove - Remove Squad Member
squadsUpdateMember - Update Squad Member
squadsUpdateName - Update Squad Name
squadsV4GetById - Get Squad By ID
squadsV4Update - Update Squad
statusPagesComponentGroupsCreate - Create Component Group
statusPagesComponentGroupsDeleteById - Delete Component Group By ID
statusPagesComponentGroupsGetById - Get Component Group By ID
statusPagesComponentGroupsList - List Component Groups
statusPagesComponentsCreate - Create Component
statusPagesComponentsGetById - Get Component By ID
statusPagesComponentsUpdateById - Update Component By ID
statusPagesCreate - Create Status Page
statusPagesDelete - Delete Status Page By ID
statusPagesGetById - Get Status Page By ID
statusPagesGetIssueById - Get Issue By ID
statusPagesIssuesList - List Issues
statusPagesIssuesUpdate - Update Issue
statusPagesList - List Status Pages
statusPagesListStatuses - List Status Page Statuses
statusPagesMaintenancesGetById - Get Maintenance By ID
statusPagesMaintenancesList - List Maintenances
statusPagesMaintenancesUpdateById - Update Maintenance By ID
statusPageSubscribersList - List Subscribers
statusPagesUpdateById - Update Status Page By ID
teamsCreate - Create Team
teamsGetById - Get Team By ID
teamsGetRoles - Get All Team Roles
teamsList - Get All Teams
teamsListMembers - Get All Team Members
teamsMembersAdd - Add Team Member
teamsMembersBulkAdd - Add Bulk Team Member
teamsMembersRemove - Remove Team Member
teamsMembersUpdate - Update Team Member
teamsRemove - Remove Team
teamsRolesCreate - Create Team Role
teamsRolesRemove - Remove Team Role
teamsRolesUpdate - Update Team Role
teamsUpdate - Update Team
tokensCreate - Create Token
usersAdd - Add User
usersDelete - Delete User
usersGetAllTokens - Get All Tokens
usersGetById - Get User By ID
usersGetRoles - Get User Roles
usersList - Get All Users
usersRemoveFromOrg - Remove User From Org
usersRemoveToken - Remove Token
usersUpdateById - Update User by userID
usersUpdateOrgLevelPermissions - Update Org Level Permissions
webformsCreate - Create Webform
webformsGetAll - Get All Webforms
webformsGetById - Get Webform By ID
webformsRemove - Remove Webform
webformsUpdate - Update Webform
webhooksDelete - Delete Webhook
webhooksGetAll - Get All Webhooks
webhooksGetById - Get Webhook By ID
workflowActionsGetById - Get Workflow Action By ID
workflowLogsGet - Get Workflow Logs
workflowsActionsCreate - Create Action
workflowsBulkEnableDisable - Bulk Enable/Disable Workflows
workflowsCreate - Create Workflow
workflowsDelete - Delete Workflow
workflowsDeleteAction - Delete Workflow Action
workflowsEnableDisable - Enable/Disable Workflow
workflowsGetById - Get Workflow By ID
workflowsList - List Workflows
workflowsUpdate - Update Workflow
workflowsUpdateAction - Update Workflow Action
workflowsUpdateActionsOrder - Update Actions Order

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";
import { RFCDate } from "@solarwinds/squadcast-sdk-typescript/types";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.auditLogs.list({
    pageSize: 832442,
    pageNumber: 555332,
    startDate: new RFCDate("2023-03-04"),
    endDate: new RFCDate("2024-08-07"),
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";
import { openAsBlob } from "node:fs";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.escalationPolicies.update({
    escalationPolicyID: "<id>",
    v3EscalationPoliciesUpdateEscalationPolicyRequest: await openAsBlob(
      "example.file",
    ),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.analytics.getOrganization({
    from: "<value>",
    to: "<value>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.analytics.getOrganization({
    from: "<value>",
    to: "<value>",
  });

  console.log(result);
}

run();

Error Handling

SquadcastSDKError is the base class for all HTTP error responses. It has the following properties:

Property

Type

Description

error.message

string

Error message

error.statusCode

number

HTTP response status code eg 404

error.headers

Headers

HTTP response headers

error.body

string

HTTP body. Can be empty string if no body is returned.

error.rawResponse

Response

Raw HTTP response

error.data$

Optional. Some errors may contain structured data. See Error Classes.

Example

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";
import * as errors from "@solarwinds/squadcast-sdk-typescript/models/errors";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  try {
    const result = await squadcastSDK.analytics.getOrganization({
      from: "<value>",
      to: "<value>",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SquadcastSDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestError) {
        console.log(error.data$.meta); // models.CommonV3ErrorMeta
      }
    }
  }
}

run();

Error Classes

Primary errors:

SquadcastSDKError: The base class for HTTP error responses.
- PaymentRequiredError: Client error. Status code 402. *
- ForbiddenError: Access is forbidden. Status code 403. *
- NotFoundError: The server cannot find the requested resource. Status code 404. *
- ConflictError: The request conflicts with the current state of the server. Status code 409. *
- UnprocessableEntityError: Client error. Status code 422. *
- InternalServerError: Server error. Status code 500. *
- BadGatewayError: Server error. Status code 502. *
- ServiceUnavailableError: Service unavailable. Status code 503. *
- GatewayTimeoutError: Server error. Status code 504. *
- UnauthorizedError: Access is unauthorized. Status code 401. *
- BadRequestError: The server could not understand the request due to invalid syntax. Status code 400. *

Less common errors (9)

Network errors:

ConnectionError: HTTP client was unable to make a request to a server.
RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
RequestAbortedError: HTTP request was aborted by the client.
InvalidRequestError: Any input used to create a request is invalid.
UnexpectedClientError: Unrecognised or unexpected error.

Inherit from SquadcastSDKError:

CommonV4Error: The server could not understand the request due to invalid syntax. Applicable to 32 of 230 methods.*
ResponseBodyError1: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 230 methods.*
ResponseBodyError2: Represents a CircleCI error response for a 400 status code. Status code 400. Applicable to 1 of 230 methods.*
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  serverURL: "https://api.squadcast.com",
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.analytics.getOrganization({
    from: "<value>",
    to: "<value>",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";
import { HTTPClient } from "@solarwinds/squadcast-sdk-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new SquadcastSDK({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const sdk = new SquadcastSDK({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

NextStandalone Functions

Last updated 1 month ago

Good morning

hashtagSquadcast SDK for TypeScript

hashtagSummary

hashtagTable of Contents

hashtagSDK Installation

hashtagNPM

hashtagPNPM

hashtagBun

hashtagYarn

hashtagRequirements

hashtagSDK Example Usage

hashtagExample

hashtagAuthentication

hashtagPer-Client Security Schemes

hashtagAvailable Resources and Operations

hashtagStandalone functions

hashtagPagination

hashtagFile uploads

hashtagRetries

hashtagError Handling

hashtagExample

hashtagError Classes

hashtagServer Selection

hashtagOverride Server URL Per-Client

hashtagCustom HTTP Client

hashtagDebugging

hashtagDevelopment

hashtagMaturity

hashtagContributions

hashtagSDK Created by Speakeasyarrow-up-right

Squadcast SDK for TypeScript

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Standalone functions

Pagination

File uploads

Retries

Error Handling

Example

Error Classes

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy