Skip to content

Variable: AppInstallView ​

ts
const AppInstallView: z.ZodObject<{
  aliases: z.ZodArray<z.ZodString>;
  appName: z.ZodString;
  autoUpgrade: z.ZodEnum<{
     compatible: "compatible";
     off: "off";
  }>;
  circuit: z.ZodObject<{
     defaults: z.ZodObject<{
        failureThreshold: z.ZodNumber;
        openSeconds: z.ZodNumber;
     }, z.core.$strip>;
     failures: z.ZodNumber;
     settings: z.ZodObject<{
        failureThreshold: z.ZodNullable<z.ZodNumber>;
        openSeconds: z.ZodNullable<z.ZodNumber>;
     }, z.core.$strip>;
     since: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     state: z.ZodEnum<{
        closed: "closed";
        half_open: "half_open";
        open: "open";
     }>;
  }, z.core.$strip>;
  config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
  createdAt: z.ZodCoercedDate<unknown>;
  enabled: z.ZodBoolean;
  hosts: z.ZodArray<z.ZodString>;
  id: z.ZodGUID;
  missingSecrets: z.ZodArray<z.ZodString>;
  name: z.ZodString;
  pendingChange: z.ZodNullable<z.ZodObject<{
     approvalSettings: z.ZodObject<{
        fourEyes: z.ZodBoolean;
        required: z.ZodBoolean;
     }, z.core.$strip>;
     comment: z.ZodNullable<z.ZodString>;
     config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     decidedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     decidedBy: z.ZodNullable<z.ZodString>;
     decision: z.ZodNullable<z.ZodEnum<{
        approved: "approved";
        rejected: "rejected";
        withdrawn: "withdrawn";
     }>>;
     decisionComment: z.ZodNullable<z.ZodString>;
     enabled: z.ZodBoolean;
     handlesAdded: z.ZodArray<z.ZodEnum<{
        handoff: "handoff";
        webhook: "webhook";
     }>>;
     hosts: z.ZodArray<z.ZodString>;
     hostsAdded: z.ZodArray<z.ZodString>;
     id: z.ZodGUID;
     installId: z.ZodGUID;
     installName: z.ZodString;
     installUpdatedAt: z.ZodCoercedDate<unknown>;
     needsAdded: z.ZodArray<z.ZodEnum<{
        documents: "documents";
     }>>;
     newInstall: z.ZodBoolean;
     origin: z.ZodEnum<{
        auto_upgrade: "auto_upgrade";
        save: "save";
     }>;
     requestedAt: z.ZodCoercedDate<unknown>;
     requestedBy: z.ZodString;
     tenantId: z.ZodGUID;
     versionId: z.ZodGUID;
  }, z.core.$strip>>;
  requiredSecrets: z.ZodArray<z.ZodString>;
  storedSecrets: z.ZodArray<z.ZodString>;
  tenantId: z.ZodGUID;
  updateAvailable: z.ZodBoolean;
  updatedAt: z.ZodCoercedDate<unknown>;
  upgrade: z.ZodNullable<z.ZodObject<{
     actions: z.ZodArray<z.ZodObject<{
        action: z.ZodString;
        problem: z.ZodEnum<{
           async: "async";
           missing: "missing";
        }>;
        usedBy: z.ZodArray<z.ZodString>;
     }, z.core.$strip>>;
     changeId: z.ZodNullable<z.ZodGUID>;
     handlesAdded: z.ZodArray<z.ZodEnum<{
        handoff: "handoff";
        webhook: "webhook";
     }>>;
     hostsAdded: z.ZodArray<z.ZodString>;
     issues: z.ZodArray<z.ZodObject<{
        message: z.ZodString;
        path: z.ZodString;
     }, z.core.$strip>>;
     missingSecrets: z.ZodArray<z.ZodString>;
     needsAdded: z.ZodArray<z.ZodEnum<{
        documents: "documents";
     }>>;
     rollback: z.ZodBoolean;
     target: z.ZodObject<{
        id: z.ZodGUID;
        version: z.ZodString;
     }, z.core.$strip>;
     waitingFor: z.ZodNullable<z.ZodEnum<{
        actions: "actions";
        approval: "approval";
        config: "config";
        declined: "declined";
        secrets: "secrets";
     }>>;
  }, z.core.$strip>>;
  upgradedFromVersionId: z.ZodNullable<z.ZodGUID>;
  version: z.ZodObject<{
     actions: z.ZodArray<z.ZodObject<{
        callbackTimeoutSeconds: z.ZodOptional<z.ZodNumber>;
        description: z.ZodOptional<z.ZodString>;
        idempotent: z.ZodBoolean;
        inputSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        mappable: z.ZodOptional<z.ZodArray<z.ZodString>>;
        name: z.ZodString;
        outputFromInput: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[..., ...], "kind">>>;
        outputSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        retry: z.ZodOptional<z.ZodObject<{
           backoffMs: z.ZodNumber;
           maxAttempts: z.ZodNumber;
        }, z.core.$strip>>;
        timeoutMs: z.ZodNumber;
     }, z.core.$strip>>;
     capabilities: z.ZodArray<z.ZodString>;
     category: z.ZodOptional<z.ZodString>;
     configSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     createdAt: z.ZodCoercedDate<unknown>;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodOptional<z.ZodString>;
     documentsFromConfig: z.ZodOptional<z.ZodString>;
     handles: z.ZodObject<{
        handoff: z.ZodOptional<z.ZodBoolean>;
        webhook: z.ZodDefault<z.ZodBoolean>;
        webhookExternalId: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<..., ...>, z.ZodObject<..., ...>, z.ZodObject<..., ...>]>>;
        webhookExternalIdFromConfig: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
     hosts: z.ZodArray<z.ZodString>;
     hostsFromConfig: z.ZodArray<z.ZodString>;
     id: z.ZodGUID;
     memoryMiB: z.ZodNumber;
     name: z.ZodString;
     needs: z.ZodArray<z.ZodEnum<{
        documents: "documents";
     }>>;
     platformSource: z.ZodNullable<z.ZodEnum<{
        operator: "operator";
        release: "release";
     }>>;
     pricingNote: z.ZodOptional<z.ZodString>;
     provenance: z.ZodNullable<z.ZodObject<{
        kind: z.ZodEnum<{
           attestation: "attestation";
           release: "release";
           signature: "signature";
        }>;
        recordedBy: z.ZodString;
        signedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
        signer: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<..., ...>, z.ZodObject<..., ...>], "type">>;
        source: z.ZodObject<{
           commit: z.ZodNullable<z.ZodString>;
           ref: z.ZodNullable<z.ZodString>;
           repository: z.ZodNullable<z.ZodString>;
        }, z.core.$strip>;
        transparencyLogIndex: z.ZodNullable<z.ZodNumber>;
        trusted: z.ZodBoolean;
        trustedSigner: z.ZodNullable<z.ZodString>;
        verifiedAt: z.ZodCoercedDate<unknown>;
     }, z.core.$strip>>;
     publishedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     publisher: z.ZodEnum<{
        platform: "platform";
        tenant: "tenant";
     }>;
     review: z.ZodNullable<z.ZodObject<{
        comment: z.ZodNullable<z.ZodString>;
        decidedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
        decidedBy: z.ZodNullable<z.ZodString>;
        id: z.ZodGUID;
        requestedAt: z.ZodCoercedDate<unknown>;
        requestedBy: z.ZodString;
        status: z.ZodEnum<{
           approved: "approved";
           pending: "pending";
           rejected: "rejected";
           withdrawn: "withdrawn";
        }>;
        tenantId: z.ZodGUID;
        versionId: z.ZodGUID;
     }, z.core.$strip>>;
     secrets: z.ZodArray<z.ZodObject<{
        description: z.ZodOptional<z.ZodString>;
        name: z.ZodString;
        requiredWhen: z.ZodOptional<z.ZodArray<z.ZodObject<{
           config: ...;
           in: ...;
        }, z.core.$strip>>>;
     }, z.core.$strip>>;
     secretsFromConfig: z.ZodOptional<z.ZodString>;
     sha256: z.ZodString;
     sizeBytes: z.ZodNumber;
     status: z.ZodEnum<{
        published: "published";
        uploaded: "uploaded";
        withdrawn: "withdrawn";
     }>;
     title: z.ZodOptional<z.ZodString>;
     vendor: z.ZodOptional<z.ZodString>;
     version: z.ZodString;
  }, z.core.$strip>;
  versionId: z.ZodGUID;
  webhookUrl: z.ZodNullable<z.ZodURL>;
}, z.core.$strip>;

An install as the API answers it: its version unfolded, the secrets its config requires and the ones still to store, and the change waiting for an approval, if any.

Released under the Apache-2.0 License.