LukeParke/Coolify-TypeScript-SDK

Fork 0

mirror of https://github.com/LukeHagar/Coolify-TypeScript-SDK.git synced 2025-12-06 12:27:46 +00:00

Files

History

Luke Hagar c70b67b33e Saving initial generation

2024-11-19 21:24:42 -06:00

README.md

Saving initial generation

2024-11-19 21:24:42 -06:00

README.md

Projects

(projects)

Overview

Projects

Available Operations

list - List
create - Create
get - Get
delete - Delete
update - Update
getEnvironment - Environment

list

List projects.

Example Usage

import { Coolify } from "coolify";

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

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

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsList } from "coolify/funcs/projectsList.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 projectsList(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.Project[]>

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	/

create

Create Project.

Example Usage

import { Coolify } from "coolify";

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

async function run() {
  const result = await coolify.projects.create({});

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsCreate } from "coolify/funcs/projectsCreate.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 projectsCreate(coolify, {});

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateProjectRequestBody	✔️	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.CreateProjectResponseBody>

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 project by UUID.

Example Usage

import { Coolify } from "coolify";

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

async function run() {
  const result = await coolify.projects.get({
    uuid: "8ee4c350-f599-4db3-ad60-4e858f981b76",
  });

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsGet } from "coolify/funcs/projectsGet.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 projectsGet(coolify, {
    uuid: "8ee4c350-f599-4db3-ad60-4e858f981b76",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetProjectByUuidRequest	✔️	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.Project>

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.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.NotFound	501, 505	application/json
errors.APIError	4XX, 5XX	/

delete

Delete project by UUID.

Example Usage

import { Coolify } from "coolify";

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

async function run() {
  const result = await coolify.projects.delete({
    uuid: "9e5be611-8766-4db1-9ad7-f03e9284084f",
  });

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsDelete } from "coolify/funcs/projectsDelete.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 projectsDelete(coolify, {
    uuid: "9e5be611-8766-4db1-9ad7-f03e9284084f",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteProjectByUuidRequest	✔️	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.DeleteProjectByUuidResponseBody>

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	/

update

Update Project.

Example Usage

import { Coolify } from "coolify";

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

async function run() {
  const result = await coolify.projects.update({
    uuid: "d493415b-6548-4c8b-8e4a-d0ae131f3835",
    requestBody: {},
  });

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsUpdate } from "coolify/funcs/projectsUpdate.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 projectsUpdate(coolify, {
    uuid: "d493415b-6548-4c8b-8e4a-d0ae131f3835",
    requestBody: {},
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateProjectByUuidRequest	✔️	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.UpdateProjectByUuidResponseBody>

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	/

getEnvironment

Get environment by name.

Example Usage

import { Coolify } from "coolify";

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

async function run() {
  const result = await coolify.projects.getEnvironment({
    uuid: "d9b108d3-6f92-44fb-9c22-b9c31c745f88",
    environmentName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { CoolifyCore } from "coolify/core.js";
import { projectsGetEnvironment } from "coolify/funcs/projectsGetEnvironment.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 projectsGetEnvironment(coolify, {
    uuid: "d9b108d3-6f92-44fb-9c22-b9c31c745f88",
    environmentName: "<value>",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetEnvironmentByNameRequest	✔️	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.Environment>

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	/

README.md Unescape Escape

Projects

Overview

Available Operations

list

Example Usage

Standalone function

Parameters

Response

Errors

create

Example Usage

Standalone function

Parameters

Response

Errors

get

Example Usage

Standalone function

Parameters

Response

Errors

delete

Example Usage

Standalone function

Parameters

Response

Errors

update

Example Usage

Standalone function

Parameters

Response

Errors

getEnvironment

Example Usage

Standalone function

Parameters

Response

Errors

README.md