Teams

Overview

Available Operations

• 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

list

Returns all the teams of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.list();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

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

run();

Parameters

Parameter	Type	Required	Description
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.TeamsGetAllTeamsResponse>

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

create

Add team to the organization. Returns the team object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.create({
    name: "<value>",
    memberIds: [
      "<value 1>",
      "<value 2>",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

async function run() {
  const res = await teamsCreate(squadcastSDK, {
    name: "<value>",
    memberIds: [
      "<value 1>",
      "<value 2>",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("teamsCreate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	models.V3TeamsCreateTeamRequest	✔️	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.TeamsCreateTeamResponse>

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

getById

Returns a team details of the given teamID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

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

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.TeamsGetTeamByIdRequest	✔️	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.TeamsGetTeamByIdResponse>

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 organization team details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.update({
    teamId: "<id>",
    v3TeamsUpdateTeamRequest: {
      members: [],
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

async function run() {
  const res = await teamsUpdate(squadcastSDK, {
    teamId: "<id>",
    v3TeamsUpdateTeamRequest: {
      members: [],
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("teamsUpdate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.TeamsUpdateTeamRequest	✔️	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.TeamsUpdateTeamResponse>

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

remove

Remove team from the organization. Upon success, the team will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.remove({
    teamId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.TeamsRemoveTeamRequest	✔️	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.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	*/*

listMembers

Returns all the team members of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.listMembers({
    teamId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.TeamsGetAllTeamMembersRequest	✔️	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.TeamsGetAllTeamMembersResponse>

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

getRoles

Returns all the roles of the teamId mentioned in params. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

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

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.teams.getRoles({
    teamId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

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

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.TeamsGetAllTeamRolesRequest	✔️	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.TeamsGetAllTeamRolesResponse>

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