@townco/fly 0.1.53 → 0.1.55

package/dist/sdk.gen.js

@@ -0,0 +1,557 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from "./client.gen";
+/**
+ * List Apps
+ *
+ * List all apps with the ability to filter by organization slug.
+ *
+ */
+export const appsList = (options) => (options.client ?? client).get({
+    url: "/apps",
+    ...options,
+});
+/**
+ * Create App
+ *
+ * Create an app with the specified details in the request body.
+ *
+ */
+export const appsCreate = (options) => (options.client ?? client).post({
+    url: "/apps",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Destroy App
+ *
+ * Delete an app by its name.
+ *
+ */
+export const appsDelete = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}", ...options });
+/**
+ * Get App
+ *
+ * Retrieve details about a specific app by its name.
+ *
+ */
+export const appsShow = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}",
+    ...options,
+});
+/**
+ * Create App deploy token
+ */
+export const appCreateDeployToken = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/deploy_token",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * List IP assignments for app
+ */
+export const appIpAssignmentsList = (options) => (options?.client ?? client).get({ url: "/apps/{app_name}/ip_assignments", ...options });
+/**
+ * Assign new IP address to app
+ */
+export const appIpAssignmentsCreate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/ip_assignments",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Remove IP assignment from app
+ */
+export const appIpAssignmentsDelete = (options) => (options?.client ?? client).delete({ url: "/apps/{app_name}/ip_assignments/{ip}", ...options });
+/**
+ * List Machines
+ *
+ * List all Machines associated with a specific app, with optional filters for including deleted Machines and filtering by region.
+ *
+ */
+export const machinesList = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/machines",
+    ...options,
+});
+/**
+ * Create Machine
+ *
+ * Create a Machine within a specific app using the details provided in the request body.
+ *
+ * **Important**: This request can fail, and you’re responsible for handling that failure. If you ask for a large Machine, or a Machine in a region we happen to be at capacity for, you might need to retry the request, or to fall back to another region. If you’re working directly with the Machines API, you’re taking some responsibility for your own orchestration!
+ *
+ */
+export const machinesCreate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Destroy Machine
+ *
+ * Delete a specific Machine within an app by Machine ID, with an optional force parameter to force kill the Machine if it's running.
+ *
+ */
+export const machinesDelete = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}/machines/{machine_id}", ...options });
+/**
+ * Get Machine
+ *
+ * Get details of a specific Machine within an app by the Machine ID.
+ *
+ */
+export const machinesShow = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/machines/{machine_id}",
+    ...options,
+});
+/**
+ * Update Machine
+ *
+ * Update a Machine's configuration using the details provided in the request body.
+ *
+ */
+export const machinesUpdate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Cordon Machine
+ *
+ * “Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.
+ *
+ */
+export const machinesCordon = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/machines/{machine_id}/cordon", ...options });
+/**
+ * List Events
+ *
+ * List all events associated with a specific Machine within an app.
+ *
+ */
+export const machinesListEvents = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/events", ...options });
+/**
+ * Execute Command
+ *
+ * Execute a command on a specific Machine and return the raw command output bytes.
+ *
+ */
+export const machinesExec = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/exec",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Release Lease
+ *
+ * Release the lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
+ *
+ */
+export const machinesReleaseLease = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}/machines/{machine_id}/lease", ...options });
+/**
+ * Get Lease
+ *
+ * Retrieve the current lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
+ *
+ */
+export const machinesShowLease = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/lease", ...options });
+/**
+ * Create Lease
+ *
+ * Create a lease for a specific Machine within an app using the details provided in the request body. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
+ *
+ */
+export const machinesCreateLease = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/lease",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Reclaim Machine Memory
+ *
+ * Trigger the balloon device to reclaim memory from a machine
+ */
+export const machinesReclaimMemory = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/memory/reclaim",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Get Metadata
+ *
+ * Retrieve metadata for a specific Machine within an app.
+ *
+ */
+export const machinesShowMetadata = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/metadata", ...options });
+/**
+ * Patch Metadata (set/remove multiple keys)
+ *
+ * Update multiple metadata keys at once. Null values and empty strings remove keys.
+ */
+export const machinesPatchMetadata = (options) => (options.client ?? client).patch({ url: "/apps/{app_name}/machines/{machine_id}/metadata", ...options });
+/**
+ * Delete Metadata
+ *
+ * Delete metadata for a specific Machine within an app by providing a metadata key.
+ *
+ */
+export const machinesDeleteMetadata = (options) => (options.client ?? client).delete({
+    url: "/apps/{app_name}/machines/{machine_id}/metadata/{key}",
+    ...options,
+});
+/**
+ * Update Metadata
+ *
+ * Update metadata for a specific machine within an app by providing a metadata key.
+ *
+ */
+export const machinesUpdateMetadata = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/metadata/{key}",
+    ...options,
+});
+/**
+ * List Processes
+ *
+ * List all processes running on a specific Machine within an app, with optional sorting parameters.
+ *
+ */
+export const machinesListProcesses = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/ps", ...options });
+/**
+ * Restart Machine
+ *
+ * Restart a specific Machine within an app, with an optional timeout parameter.
+ *
+ */
+export const machinesRestart = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/machines/{machine_id}/restart", ...options });
+/**
+ * Signal Machine
+ *
+ * Send a signal to a specific Machine within an app using the details provided in the request body.
+ *
+ */
+export const machinesSignal = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/signal",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Start Machine
+ *
+ * Start a specific Machine within an app.
+ *
+ */
+export const machinesStart = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/machines/{machine_id}/start", ...options });
+/**
+ * Stop Machine
+ *
+ * Stop a specific Machine within an app, with an optional request body to specify signal and timeout.
+ *
+ */
+export const machinesStop = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/machines/{machine_id}/stop",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Suspend Machine
+ *
+ * Suspend a specific Machine within an app. The next start operation will attempt (but is not guaranteed) to resume the Machine from a snapshot taken at suspension time, rather than performing a cold boot.
+ *
+ */
+export const machinesSuspend = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/machines/{machine_id}/suspend", ...options });
+/**
+ * Uncordon Machine
+ *
+ * “Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.
+ *
+ */
+export const machinesUncordon = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/machines/{machine_id}/uncordon", ...options });
+/**
+ * List Versions
+ *
+ * List all versions of the configuration for a specific Machine within an app.
+ *
+ */
+export const machinesListVersions = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/versions", ...options });
+/**
+ * Wait for State
+ *
+ * Wait for a Machine to reach a specific state. Specify the desired state with the state parameter. See the [Machine states table](https://fly.io/docs/machines/working-with-machines/#machine-states) for a list of possible states. The default for this parameter is `started`.
+ *
+ * This request will block for up to 60 seconds. Set a shorter timeout with the timeout parameter.
+ *
+ */
+export const machinesWait = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/machines/{machine_id}/wait", ...options });
+/**
+ * List secret keys belonging to an app
+ */
+export const secretkeysList = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/secretkeys", ...options });
+/**
+ * Delete an app's secret key
+ */
+export const secretkeyDelete = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}/secretkeys/{secret_name}", ...options });
+/**
+ * Get an app's secret key
+ */
+export const secretkeyGet = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/secretkeys/{secret_name}",
+    ...options,
+});
+/**
+ * Create or update a secret key
+ */
+export const secretkeySet = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Decrypt with a secret key
+ */
+export const secretkeyDecrypt = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}/decrypt",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Encrypt with a secret key
+ */
+export const secretkeyEncrypt = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}/encrypt",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Generate a random secret key
+ */
+export const secretkeyGenerate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}/generate",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Sign with a secret key
+ */
+export const secretkeySign = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}/sign",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Verify with a secret key
+ */
+export const secretkeyVerify = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secretkeys/{secret_name}/verify",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * List app secrets belonging to an app
+ */
+export const secretsList = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/secrets",
+    ...options,
+});
+/**
+ * Update app secrets belonging to an app
+ */
+export const secretsUpdate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secrets",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Delete an app secret
+ */
+export const secretDelete = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}/secrets/{secret_name}", ...options });
+/**
+ * Get an app secret
+ */
+export const secretGet = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/secrets/{secret_name}",
+    ...options,
+});
+/**
+ * Create or update Secret
+ */
+export const secretCreate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/secrets/{secret_name}",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * List Volumes
+ *
+ * List all volumes associated with a specific app.
+ *
+ */
+export const volumesList = (options) => (options.client ?? client).get({
+    url: "/apps/{app_name}/volumes",
+    ...options,
+});
+/**
+ * Create Volume
+ *
+ * Create a volume for a specific app using the details provided in the request body.
+ *
+ */
+export const volumesCreate = (options) => (options.client ?? client).post({
+    url: "/apps/{app_name}/volumes",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Destroy Volume
+ *
+ * Delete a specific volume within an app by volume ID.
+ *
+ */
+export const volumeDelete = (options) => (options.client ?? client).delete({ url: "/apps/{app_name}/volumes/{volume_id}", ...options });
+/**
+ * Get Volume
+ *
+ * Retrieve details about a specific volume by its ID within an app.
+ *
+ */
+export const volumesGetById = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/volumes/{volume_id}", ...options });
+/**
+ * Update Volume
+ *
+ * Update a volume's configuration using the details provided in the request body.
+ *
+ */
+export const volumesUpdate = (options) => (options.client ?? client).put({
+    url: "/apps/{app_name}/volumes/{volume_id}",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Extend Volume
+ *
+ * Extend a volume's size within an app using the details provided in the request body.
+ *
+ */
+export const volumesExtend = (options) => (options.client ?? client).put({
+    url: "/apps/{app_name}/volumes/{volume_id}/extend",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * List Snapshots
+ *
+ * List all snapshots for a specific volume within an app.
+ *
+ */
+export const volumesListSnapshots = (options) => (options.client ?? client).get({ url: "/apps/{app_name}/volumes/{volume_id}/snapshots", ...options });
+/**
+ * Create Snapshot
+ *
+ * Create a snapshot for a specific volume within an app.
+ *
+ */
+export const createVolumeSnapshot = (options) => (options.client ?? client).post({ url: "/apps/{app_name}/volumes/{volume_id}/snapshots", ...options });
+/**
+ * Get Placements
+ *
+ * Simulates placing the specified number of machines into regions, depending on available capacity and limits.
+ */
+export const platformPlacementsPost = (options) => (options.client ?? client).post({
+    url: "/platform/placements",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Get Regions
+ *
+ * List all regions on the platform with their current Machine capacity.
+ */
+export const platformRegionsGet = (options) => (options?.client ?? client).get({ url: "/platform/regions", ...options });
+/**
+ * Request a Petsem token for accessing KMS
+ *
+ * This site hosts documentation generated from the Fly.io Machines API OpenAPI specification. Visit our complete [Machines API docs](https://fly.io/docs/machines/api/apps-resource/) for details about using the Apps resource.
+ */
+export const tokensRequestKms = (options) => (options?.client ?? client).post({ url: "/tokens/kms", ...options });
+/**
+ * Request an OIDC token
+ *
+ * Request an Open ID Connect token for your machine. Customize the audience claim with the `aud` parameter. This returns a JWT token. Learn more about [using OpenID Connect](/docs/reference/openid-connect/) on Fly.io.
+ *
+ */
+export const tokensRequestOidc = (options) => (options.client ?? client).post({
+    url: "/tokens/oidc",
+    ...options,
+    headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+    },
+});
+/**
+ * Get Current Token Information
+ *
+ * Get information about the current macaroon token(s), including organizations, apps, and whether each token is from a user or machine
+ */
+export const currentTokenShow = (options) => (options?.client ?? client).get({ url: "/v1/tokens/current", ...options });