@bpmnkit/api 0.0.8

package/dist/generated/admin-resources.js

@@ -0,0 +1,381 @@
+// This file is auto-generated by scripts/generate.mjs
+// Do not edit manually. Run `pnpm --filter @bpmnkit/api generate` to regenerate.
+import { CamundaBaseClient } from "../runtime/client.js";
+import { ResourceBase } from "../runtime/client.js";
+// ── Meta ──
+export class MetaResource extends ResourceBase {
+    /**
+     *
+     * This endpoint only exposes egress IP addresses for the related services.
+     * Expected changes will be published through the API at least 24 hours in advance.
+     * We expect interested customers to periodically read this list from the API and reflect the changes in their systems.
+     * @see GET /meta/ip-ranges
+     */
+    async getMeta() {
+        return this._http.request({
+            method: "GET",
+            path: "/meta/ip-ranges",
+        });
+    }
+}
+// ── Members ──
+export class MembersResource extends ResourceBase {
+    async getMembers() {
+        return this._http.request({
+            method: "GET",
+            path: "/members",
+        });
+    }
+    async updateMembers(email, body) {
+        return this._http.request({
+            method: "POST",
+            path: `/members/${email}`,
+            body,
+        });
+    }
+    async deleteMember(email) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/members/${email}`,
+        });
+    }
+}
+// ── Clusters ──
+export class ClustersResource extends ResourceBase {
+    /**
+     *
+     * Get Secure Connectivity status for a cluster
+     * @see GET /clusters/{clusterUuid}/secure-connectivity
+     */
+    async getSecureConnectivityStatus(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/secure-connectivity`,
+        });
+    }
+    /**
+     *
+     * Activates Secure Connectivity for a cluster
+     * @see POST /clusters/{clusterUuid}/secure-connectivity
+     */
+    async activateSecureConnectivity(clusterUuid, body) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/secure-connectivity`,
+            body,
+        });
+    }
+    /**
+     *
+     * Deactivates Secure Connectivity for a cluster
+     * @see DELETE /clusters/{clusterUuid}/secure-connectivity
+     */
+    async deactivateSecureConnectivity(clusterUuid) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/secure-connectivity`,
+        });
+    }
+    async getSecrets(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/secrets`,
+        });
+    }
+    /**
+     *
+     * Creates a new secret
+     * @see POST /clusters/{clusterUuid}/secrets
+     */
+    async createSecret(clusterUuid, body) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/secrets`,
+            body,
+        });
+    }
+    /**
+     *
+     * Updates a secret
+     * @see PUT /clusters/{clusterUuid}/secrets/{secretName}
+     */
+    async updateSecret(clusterUuid, secretName, body) {
+        return this._http.request({
+            method: "PUT",
+            path: `/clusters/${clusterUuid}/secrets/${secretName}`,
+            body,
+        });
+    }
+    /**
+     *
+     * Irreversibly deletes a secret
+     * @see DELETE /clusters/{clusterUuid}/secrets/{secretName}
+     */
+    async deleteSecret(clusterUuid, secretName) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/secrets/${secretName}`,
+        });
+    }
+    async getClusters() {
+        return this._http.request({
+            method: "GET",
+            path: "/clusters",
+        });
+    }
+    async createCluster(body) {
+        return this._http.request({
+            method: "POST",
+            path: "/clusters",
+            body,
+        });
+    }
+    async getCluster(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}`,
+        });
+    }
+    /**
+     *
+     * Updates name or labels of a cluster identified by the given clusterUuid.
+     * @see PATCH /clusters/{clusterUuid}
+     */
+    async updateCluster(clusterUuid, body) {
+        return this._http.request({
+            method: "PATCH",
+            path: `/clusters/${clusterUuid}`,
+            body,
+        });
+    }
+    /**
+     *
+     * Irreversibly deletes a cluster identified by the given clusterUuid.
+     * @see DELETE /clusters/{clusterUuid}
+     */
+    async deleteCluster(clusterUuid) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}`,
+        });
+    }
+    /**
+     *
+     * upgrades a cluster identified by the given clusterUuid to the latest generation available.
+     * @see PUT /clusters/{clusterUuid}/upgrade
+     */
+    async upgradeCluster(clusterUuid) {
+        return this._http.request({
+            method: "PUT",
+            path: `/clusters/${clusterUuid}/upgrade`,
+        });
+    }
+    /**
+     *
+     * Gets all possible options to create a Camunda cluster.
+     * @see GET /clusters/parameters
+     */
+    async getParameters() {
+        return this._http.request({
+            method: "GET",
+            path: "/clusters/parameters",
+        });
+    }
+    /**
+     *
+     * Updates the IP Allowlist rules for your cluster. Each entry in the array must be a valid comma separated list of CIDRs.
+     * @see PUT /clusters/{clusterUuid}/ipallowlist
+     */
+    async updateIpAllowlist(clusterUuid, body) {
+        return this._http.request({
+            method: "PUT",
+            path: `/clusters/${clusterUuid}/ipallowlist`,
+            body,
+        });
+    }
+    /**
+     *
+     * Updates the IP Whitelist rules for your cluster. Each entry in the array must be a valid comma separated list of CIDRs.
+     * THIS IS DEPRECATED AND WILL BE REMOVED FROM THE API IN JUNE 2025. USE /clusters/:clusterUuid/ipallowlist INSTEAD.
+     * @see PUT /clusters/{clusterUuid}/ipwhitelist
+     */
+    async updateIpWhitelist(clusterUuid, body) {
+        return this._http.request({
+            method: "PUT",
+            path: `/clusters/${clusterUuid}/ipwhitelist`,
+            body,
+        });
+    }
+    /**
+     *
+     * Resumes a 'Suspended' Cluster.
+     * @see PUT /clusters/{clusterUuid}/wake
+     */
+    async wake(clusterUuid) {
+        return this._http.request({
+            method: "PUT",
+            path: `/clusters/${clusterUuid}/wake`,
+        });
+    }
+    async getClients(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/clients`,
+        });
+    }
+    async createClient(clusterUuid, body) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/clients`,
+            body,
+        });
+    }
+    async getClient(clusterUuid, clientId) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/clients/${clientId}`,
+        });
+    }
+    /**
+     *
+     * Irreversibly deletes a cluster client.
+     * @see DELETE /clusters/{clusterUuid}/clients/{clientId}
+     */
+    async deleteClient(clusterUuid, clientId) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/clients/${clientId}`,
+        });
+    }
+    /**
+     *
+     * Activates External Monitoring for a cluster
+     * @see POST /clusters/{clusterUuid}/monitoring
+     */
+    async activateMonitoring(clusterUuid) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/monitoring`,
+        });
+    }
+    /**
+     *
+     * Deactivates External Monitoring for a cluster
+     * @see DELETE /clusters/{clusterUuid}/monitoring
+     */
+    async deactivateMonitoring(clusterUuid) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/monitoring`,
+        });
+    }
+    /**
+     *
+     * Get all External Monitoring clients for a cluster
+     * @see GET /clusters/{clusterUuid}/monitoring/clients
+     */
+    async getMonitoringClients(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/monitoring/clients`,
+        });
+    }
+    /**
+     *
+     * Creates a new External Monitoring client
+     * @see POST /clusters/{clusterUuid}/monitoring/clients
+     */
+    async createMonitoringClient(clusterUuid, body) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/monitoring/clients`,
+            body,
+        });
+    }
+    /**
+     *
+     * Rotates the password for an External Monitoring client
+     * @see POST /clusters/{clusterUuid}/monitoring/clients/{clientUuid}/rotate
+     */
+    async rotateMonitoringClientPassword(clusterUuid, clientUuid) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/monitoring/clients/${clientUuid}/rotate`,
+        });
+    }
+    /**
+     *
+     * Deletes an External Monitoring client
+     * @see DELETE /clusters/{clusterUuid}/monitoring/clients/{clientUuid}
+     */
+    async deleteMonitoringClient(clusterUuid, clientUuid) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/monitoring/clients/${clientUuid}`,
+        });
+    }
+    async getBackups(clusterUuid) {
+        return this._http.request({
+            method: "GET",
+            path: `/clusters/${clusterUuid}/backups`,
+        });
+    }
+    /**
+     *
+     * Creates a new backup
+     * @see POST /clusters/{clusterUuid}/backups
+     */
+    async createBackup(clusterUuid) {
+        return this._http.request({
+            method: "POST",
+            path: `/clusters/${clusterUuid}/backups`,
+        });
+    }
+    /**
+     *
+     * Irreversibly deletes a cluster
+     * @see DELETE /clusters/{clusterUuid}/backups/{backupId}
+     */
+    async deleteBackup(clusterUuid, backupId) {
+        return this._http.request({
+            method: "DELETE",
+            path: `/clusters/${clusterUuid}/backups/${backupId}`,
+        });
+    }
+}
+// ── Activity ──
+export class ActivityResource extends ResourceBase {
+    async getJson() {
+        return this._http.request({
+            method: "GET",
+            path: "/activity/json",
+        });
+    }
+    async getCsv() {
+        return this._http.request({
+            method: "GET",
+            path: "/activity/csv",
+        });
+    }
+}
+/**
+ * Camunda Admin API client.
+ */
+export class AdminApiClient extends CamundaBaseClient {
+    /** Meta operations */
+    meta;
+    /** Members operations */
+    members;
+    /** Clusters operations */
+    clusters;
+    /** Activity operations */
+    activity;
+    constructor(config = {}) {
+        super(config);
+        this.meta = new MetaResource(this.http);
+        this.members = new MembersResource(this.http);
+        this.clusters = new ClustersResource(this.http);
+        this.activity = new ActivityResource(this.http);
+    }
+}
+//# sourceMappingURL=admin-resources.js.map

package/dist/generated/admin-types.d.ts

@@ -0,0 +1,283 @@
+export interface MetaDto {
+    "web-modeler": Array<string>;
+}
+export type OrganizationRole = "member" | "admin" | "organizationadmin" | "organizationowner" | "owner" | "supportagent" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor" | "modeler";
+export interface Member {
+    name: string;
+    email: string;
+    roles: Array<"member" | "admin" | "organizationadmin" | "organizationowner" | "owner" | "supportagent" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor" | "modeler">;
+    invitePending: boolean;
+}
+export type AssignableOrganizationRoleType = "admin" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor" | "modeler";
+export interface PostMemberBody {
+    orgRoles: Array<"admin" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor" | "modeler">;
+}
+export interface SecureConnectivityDto {
+    status: {
+        privateEndpoint: {
+            status: string;
+            "type": string;
+            service: string;
+            region: string;
+        };
+    };
+    connectivity: {
+        "private": {
+            allowedPrincipals: Array<string>;
+            allowedRegions: Array<string>;
+        };
+        "type": string;
+    };
+}
+export interface ClusterSecrets {
+    [key: string]: string;
+}
+export interface CreateSecretBody {
+    secretName: string;
+    secretValue: string;
+}
+export interface UpdateSecretBody {
+    secretValue: string;
+}
+export type ClusterStatus = "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+/** Describing a Camunda cluster running in your organization. For reference, use the UUID. */
+export interface Cluster {
+    /** The ID used in all further API operations referencing your cluster. */
+    uuid: string;
+    name: string;
+    /** Optional description for the cluster (max 150 characters). */
+    description?: string;
+    ownerId: string;
+    created: string;
+    /** Also called `ClusterPlanType`, this describes the hardware used to run your Camunda cluster. */
+    planType: {
+        name: string;
+        uuid: string;
+    };
+    /** The data center where your Camunda cluster is running. */
+    region: {
+        name: string;
+        uuid: string;
+    };
+    /** The data center where your backups are stored. Only available if the Sales Plan supports this. (Enterprise) */
+    backupRegion?: {
+        name: string;
+        uuid: string;
+    };
+    /** The version of Camunda running on your cluster. */
+    generation: {
+        name: string;
+        uuid: string;
+    };
+    /** The software channel your cluster is running on. */
+    channel: {
+        name: string;
+        uuid: string;
+    };
+    /** The cluster will automatically be updated by Camunda when a new C8 version is released
+If the cluster you want to create is running on a non-stable Channel passing this property will be ignored! */
+    autoUpdate: boolean;
+    /** DEPRECATED: this field is going to be removed in June 2025, please use ipallowlist instead
+
+the IP Whitelist rules for your cluster - will only be returned if your organization has the feature enabled and the client you are using has the permission to see it. */
+    ipwhitelist?: Array<{
+        description: string;
+        ip: string;
+    }>;
+    /** the IP Allowlist rules for your cluster - will only be returned if your organization has the feature enabled and the client you are using has the permission to see it. */
+    ipallowlist?: Array<{
+        description: string;
+        ip: string;
+    }>;
+    /** A health indicator for your Camunda cluster. Each of the components have their own state. The combined state is in the field `ready`. */
+    status: {
+        connectorsStatus?: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+        optimizeStatus?: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+        tasklistStatus?: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+        operateStatus?: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+        zeebeStatus?: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+        ready: "Creating" | "Healthy" | "Unhealthy" | "Updating" | "Resuming" | "Suspended";
+    };
+    /** Endpoints for the components running in your Camunda cluster. */
+    links: {
+        oauth?: string;
+        connectors?: string;
+        console?: string;
+        identity?: string;
+        optimize?: string;
+        tasklist?: string;
+        operate?: string;
+        zeebe?: string;
+    };
+    labels?: Array<string>;
+}
+export type CamundaClusterStage = "dev" | "test" | "stage" | "prod";
+export type ClusterEncryptionKey = "Software" | "Hardware" | "Provider" | "External";
+/** Used to create a cluster through this API. All necessary values can be retrieved from the <pre>/clusters/parameters</pre> endpoint. */
+export interface CreateClusterBody {
+    /** The name of your new cluster. */
+    name: string;
+    /** Optional description for the cluster (max 150 characters). */
+    description?: string;
+    /** The planType (hardware spec) to use. */
+    planTypeId: string;
+    /** The channel (software spec) to use. */
+    channelId: string;
+    /** The generation (software version) to use. */
+    generationId: string;
+    /** The data center to use. */
+    regionId: string;
+    /** The backup region to choose. Only available if the Sales Plan supports this. (Enterprise) */
+    backupRegionId?: string;
+    /** If set to false, no automatic updates will be performed on your cluster. */
+    autoUpdate?: boolean;
+    stageLabel?: "dev" | "test" | "stage" | "prod";
+    encryption?: "Software" | "Hardware" | "Provider" | "External";
+    /** Optional number uf hardware packages, defaults to 1. Only availabe on request and for Advanced offering cluster types. */
+    hardwarePackages?: number;
+}
+export interface GenerationUpgradeForClusterDto {
+    cluster: {
+        id: string;
+        name: string;
+    };
+    oldGeneration: {
+        id: string;
+        name: string;
+    };
+    newGeneration: {
+        id: string;
+        name: string;
+    };
+    orgId: string;
+}
+/** Used to update a cluster through this API. */
+export interface UpdateClusterBody {
+    /** The name of your cluster. */
+    name?: string;
+    /** Optional description for the cluster (max 150 characters). */
+    description?: string;
+    stageLabel?: "dev" | "test" | "stage" | "prod";
+    /** Optional number uf hardware packages, defaults to 1. Only availabe on request and for Advanced offering cluster types. */
+    numberOfAllocatedHwPackages?: number;
+}
+/** Describes the different options to create a Camunda cluster. */
+export interface Parameters {
+    channels: Array<{
+        allowedGenerations: Array<{
+            name: string;
+            uuid: string;
+        }>;
+        defaultGeneration: {
+            name: string;
+            uuid: string;
+        };
+        name: string;
+        uuid: string;
+    }>;
+    clusterPlanTypes: Array<{
+        name: string;
+        uuid: string;
+    }>;
+    regions: Array<{
+        backups?: Array<{
+            regions: Array<{
+                label: string;
+                id: string;
+            }>;
+            uuid: string;
+        }>;
+        provider: string;
+        name: string;
+        uuid: string;
+    }>;
+}
+export interface IpAllowListBody {
+    ipallowlist: Array<{
+        description: string;
+        ip: string;
+    }>;
+}
+export interface IpWhiteListBody {
+    ipwhitelist: Array<{
+        description: string;
+        ip: string;
+    }>;
+}
+export interface ClusterClient {
+    name: string;
+    clientId: string;
+    permissions: Array<"Zeebe" | "Operate" | "Tasklist" | "Optimize" | "Secrets">;
+}
+export interface CreatedClusterClient {
+    name: string;
+    uuid: string;
+    clientId: string;
+    clientSecret: string;
+    permissions: Array<string>;
+    links?: {
+        oauth?: string;
+        console?: string;
+        connectors?: string;
+        optimize?: string;
+        tasklist?: string;
+        operate?: string;
+        zeebe?: string;
+    };
+}
+/** if no permissions are passed, the client will be created with all the permissions available at the time of creation */
+export interface CreateClusterClientBody {
+    clientName: string;
+    permissions?: Array<"Zeebe" | "Operate" | "Tasklist" | "Optimize" | "Secrets">;
+}
+export interface ClusterClientConnectionDetails {
+    name: string;
+    ZEEBE_ADDRESS: string;
+    ZEEBE_CLIENT_ID: string;
+    ZEEBE_AUTHORIZATION_SERVER_URL: string;
+}
+export interface ByomStatus {
+    metricsEndpoint: {
+        target: string;
+        scheme: string;
+        path: string;
+    };
+    conditions: Array<unknown>;
+}
+export interface ByomClientDto {
+    uuid: string;
+    name: string;
+    username: string;
+    created: string;
+    lastUsed: string;
+    createdBy: string;
+    createdByName: string;
+}
+export type BackupStatus = "In progress" | "Failed" | "Complete" | "-";
+export interface BackupDto {
+    uuid: string;
+    name: string;
+    created: string;
+    completed: string;
+    status: "In progress" | "Failed" | "Complete" | "-";
+    zeebeStatus: "In progress" | "Failed" | "Complete" | "-";
+    tasklistStatus: "In progress" | "Failed" | "Complete" | "-";
+    operateStatus: "In progress" | "Failed" | "Complete" | "-";
+    optimizeStatus: "In progress" | "Failed" | "Complete" | "-";
+}
+export interface AuditDto {
+    service: string;
+    orgId: string;
+    timestamp?: number;
+    audit: string;
+    auditType: "c" | "r" | "u" | "d";
+    entity: string;
+    entityId: string;
+    parentEntity?: string;
+    parentEntityId?: string;
+    userId: string;
+    entityAttribute?: string;
+    entityAttributeValueFrom?: string;
+    entityAttributeValueTo?: string;
+}
+//# sourceMappingURL=admin-types.d.ts.map

package/dist/generated/admin-types.js

@@ -0,0 +1,4 @@
+// This file is auto-generated by scripts/generate.mjs
+// Do not edit manually. Run `pnpm --filter @bpmnkit/api generate` to regenerate.
+export {};
+//# sourceMappingURL=admin-types.js.map