Rotations

Overview

Available Operations

• getScheduleRotations - List Schedule Rotations

• delete - Delete Rotation

• getById - Get Schedule Rotation by ID

• getParticipants - Get Rotation Participants

• updateParticipants - Update Rotation Participants

getScheduleRotations

List Schedule Rotations

Example Usage

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

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

async function run() {
  const result = await squadcastSDK.rotations.getScheduleRotations({
    scheduleID: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { rotationsGetScheduleRotations } from "@solarwinds/squadcast-sdk-typescript/funcs/rotationsGetScheduleRotations.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await rotationsGetScheduleRotations(squadcastSDK, {
    scheduleID: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("rotationsGetScheduleRotations failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RotationsGetScheduleRotationsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.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	*/*

delete

Delete Rotation

Example Usage

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

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

async function run() {
  const result = await squadcastSDK.rotations.delete({
    scheduleID: "<id>",
    rotationID: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { rotationsDelete } from "@solarwinds/squadcast-sdk-typescript/funcs/rotationsDelete.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await rotationsDelete(squadcastSDK, {
    scheduleID: "<id>",
    rotationID: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("rotationsDelete failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RotationsDeleteRotationRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<Uint8Array>

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

getById

Get Schedule Rotation by ID

Example Usage

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

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

async function run() {
  const result = await squadcastSDK.rotations.getById({
    scheduleID: "<id>",
    rotationID: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { rotationsGetById } from "@solarwinds/squadcast-sdk-typescript/funcs/rotationsGetById.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await rotationsGetById(squadcastSDK, {
    scheduleID: "<id>",
    rotationID: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("rotationsGetById failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RotationsGetScheduleRotationByIdRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.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	*/*

getParticipants

Get Rotation Participants

Example Usage

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

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

async function run() {
  const result = await squadcastSDK.rotations.getParticipants({
    scheduleID: "<id>",
    rotationID: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { rotationsGetParticipants } from "@solarwinds/squadcast-sdk-typescript/funcs/rotationsGetParticipants.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await rotationsGetParticipants(squadcastSDK, {
    scheduleID: "<id>",
    rotationID: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("rotationsGetParticipants failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RotationsGetRotationParticipantsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.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	*/*

updateParticipants

Update Rotation Participants

Example Usage

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

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

async function run() {
  const result = await squadcastSDK.rotations.updateParticipants({
    scheduleID: "<id>",
    rotationID: "<id>",
    v4UpdateRotationParticipantsRequest: {
      participantGroups: [],
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { rotationsUpdateParticipants } from "@solarwinds/squadcast-sdk-typescript/funcs/rotationsUpdateParticipants.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await rotationsUpdateParticipants(squadcastSDK, {
    scheduleID: "<id>",
    rotationID: "<id>",
    v4UpdateRotationParticipantsRequest: {
      participantGroups: [],
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("rotationsUpdateParticipants failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RotationsUpdateRotationParticipantsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.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	*/*