Coolify-TypeScript-SDK/docs/sdks/teams

Teams

(teams)

Overview

Teams

Available Operations

• list - List
• get - Get
• getMembers - Members
• getCurrent - Authenticated Team
• getCurrentMembers - Authenticated Team Members

list

Get all teams.

Example Usage

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

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

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { teamsList } from "coolify/funcs/teamsList.js";

// Use `CoolifyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const coolify = new CoolifyCore({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await teamsList(coolify);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

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<components.Team[]>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*

get

Get team by TeamId.

Example Usage

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.teams.get({
    id: 393445,
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { teamsGet } from "coolify/funcs/teamsGet.js";

// Use `CoolifyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const coolify = new CoolifyCore({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await teamsGet(coolify, {
    id: 393445,
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetTeamByIdRequest	✔️	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<components.Team>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*

getMembers

Get members by TeamId.

Example Usage

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.teams.getMembers({
    id: 272299,
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { teamsGetMembers } from "coolify/funcs/teamsGetMembers.js";

// Use `CoolifyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const coolify = new CoolifyCore({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await teamsGetMembers(coolify, {
    id: 272299,
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetMembersByTeamIdRequest	✔️	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<components.User[]>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*

getCurrent

Get currently authenticated team.

Example Usage

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.teams.getCurrent();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { teamsGetCurrent } from "coolify/funcs/teamsGetCurrent.js";

// Use `CoolifyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const coolify = new CoolifyCore({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await teamsGetCurrent(coolify);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

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<components.Team>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*

getCurrentMembers

Get currently authenticated team members.

Example Usage

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.teams.getCurrentMembers();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { teamsGetCurrentMembers } from "coolify/funcs/teamsGetCurrentMembers.js";

// Use `CoolifyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const coolify = new CoolifyCore({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await teamsGetCurrentMembers(coolify);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

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<components.User[]>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*