mirror of
https://github.com/LukeHagar/Dokploy-ts-sdk.git
synced 2025-12-06 04:19:37 +00:00
initial commit
This commit is contained in:
Luke Hagar
299
docs/sdks/mounts/README.md
Normal file
299
docs/sdks/mounts/README.md
Normal file
@@ -0,0 +1,299 @@
|
||||
# Mounts
|
||||
(*mounts*)
|
||||
|
||||
## Overview
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [create](#create)
|
||||
* [remove](#remove)
|
||||
* [get](#get)
|
||||
* [update](#update)
|
||||
|
||||
## create
|
||||
|
||||
### Example Usage
|
||||
|
||||
<!-- UsageSnippet language="typescript" operationID="mounts-create" method="post" path="/mounts.create" -->
|
||||
```typescript
|
||||
import { Dokploy } from "dokploy";
|
||||
|
||||
const dokploy = new Dokploy({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dokploy.mounts.create({
|
||||
type: "file",
|
||||
mountPath: "<value>",
|
||||
serviceId: "<id>",
|
||||
});
|
||||
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { DokployCore } from "dokploy/core.js";
|
||||
import { mountsCreate } from "dokploy/funcs/mountsCreate.js";
|
||||
|
||||
// Use `DokployCore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const dokploy = new DokployCore({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await mountsCreate(dokploy, {
|
||||
type: "file",
|
||||
mountPath: "<value>",
|
||||
serviceId: "<id>",
|
||||
});
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("mountsCreate failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.MountsCreateRequest](../../models/operations/mountscreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.ErrorT](../../models/errort.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.DokployDefaultError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## remove
|
||||
|
||||
### Example Usage
|
||||
|
||||
<!-- UsageSnippet language="typescript" operationID="mounts-remove" method="post" path="/mounts.remove" -->
|
||||
```typescript
|
||||
import { Dokploy } from "dokploy";
|
||||
|
||||
const dokploy = new Dokploy({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dokploy.mounts.remove({
|
||||
mountId: "<id>",
|
||||
});
|
||||
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { DokployCore } from "dokploy/core.js";
|
||||
import { mountsRemove } from "dokploy/funcs/mountsRemove.js";
|
||||
|
||||
// Use `DokployCore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const dokploy = new DokployCore({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await mountsRemove(dokploy, {
|
||||
mountId: "<id>",
|
||||
});
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("mountsRemove failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.MountsRemoveRequest](../../models/operations/mountsremoverequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.ErrorT](../../models/errort.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.DokployDefaultError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## get
|
||||
|
||||
### Example Usage
|
||||
|
||||
<!-- UsageSnippet language="typescript" operationID="mounts-one" method="get" path="/mounts.one" -->
|
||||
```typescript
|
||||
import { Dokploy } from "dokploy";
|
||||
|
||||
const dokploy = new Dokploy({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dokploy.mounts.get({
|
||||
mountId: "<id>",
|
||||
});
|
||||
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { DokployCore } from "dokploy/core.js";
|
||||
import { mountsGet } from "dokploy/funcs/mountsGet.js";
|
||||
|
||||
// Use `DokployCore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const dokploy = new DokployCore({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await mountsGet(dokploy, {
|
||||
mountId: "<id>",
|
||||
});
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("mountsGet failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.MountsOneRequest](../../models/operations/mountsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.ErrorT](../../models/errort.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.DokployDefaultError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## update
|
||||
|
||||
### Example Usage
|
||||
|
||||
<!-- UsageSnippet language="typescript" operationID="mounts-update" method="post" path="/mounts.update" -->
|
||||
```typescript
|
||||
import { Dokploy } from "dokploy";
|
||||
|
||||
const dokploy = new Dokploy({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dokploy.mounts.update({
|
||||
mountId: "<id>",
|
||||
});
|
||||
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { DokployCore } from "dokploy/core.js";
|
||||
import { mountsUpdate } from "dokploy/funcs/mountsUpdate.js";
|
||||
|
||||
// Use `DokployCore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const dokploy = new DokployCore({
|
||||
authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await mountsUpdate(dokploy, {
|
||||
mountId: "<id>",
|
||||
});
|
||||
if (res.ok) {
|
||||
const { value: result } = res;
|
||||
console.log(result);
|
||||
} else {
|
||||
console.log("mountsUpdate failed:", res.error);
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.MountsUpdateRequest](../../models/operations/mountsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.ErrorT](../../models/errort.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.DokployDefaultError | 4XX, 5XX | \*/\* |
|
||||
Reference in New Issue
Block a user