@mochabug/adapt-web 0.0.1-beta

package/dist/genproto/mochabugapis/adapt/automations/v1/automations_pb.d.ts

@@ -0,0 +1,542 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import type { Timestamp, Value } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file mochabugapis/adapt/automations/v1/automations.proto.
+ */
+export declare const file_mochabugapis_adapt_automations_v1_automations: GenFile;
+/**
+ * The inherit session request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.InheritSessionRequest
+ */
+export type InheritSessionRequest = Message<"mochabugapis.adapt.automations.v1.InheritSessionRequest"> & {
+    /**
+     * The automation you would like to inherit
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.InheritSessionRequest.
+ * Use `create(InheritSessionRequestSchema)` to create a new message.
+ */
+export declare const InheritSessionRequestSchema: GenMessage<InheritSessionRequest>;
+/**
+ * The inherit session response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.InheritSessionResponse
+ */
+export type InheritSessionResponse = Message<"mochabugapis.adapt.automations.v1.InheritSessionResponse"> & {
+    /**
+     * The automation you inherited a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * The session identifier
+     *
+     * @generated from field: string session = 2;
+     */
+    session: string;
+    /**
+     * The session token
+     *
+     * @generated from field: string token = 3;
+     */
+    token: string;
+    /**
+     * The MQTT token to use for the MQTT API
+     *
+     * @generated from field: string mqtt_token = 4;
+     */
+    mqttToken: string;
+    /**
+     * The timestamp when the session expires, if not set, the session never expires (typically the case for long-running stream vertices)
+     *
+     * @generated from field: optional google.protobuf.Timestamp expires = 5;
+     */
+    expires?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.InheritSessionResponse.
+ * Use `create(InheritSessionResponseSchema)` to create a new message.
+ */
+export declare const InheritSessionResponseSchema: GenMessage<InheritSessionResponse>;
+/**
+ * The read output request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.ReadOutputRequest
+ */
+export type ReadOutputRequest = Message<"mochabugapis.adapt.automations.v1.ReadOutputRequest"> & {
+    /**
+     * The automation you would like to fetch a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * A timestamp to indicate that that the outputs need to be newer than
+     * Unset returns everything
+     *
+     * @generated from field: optional google.protobuf.Timestamp newer_than = 2;
+     */
+    newerThan?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.ReadOutputRequest.
+ * Use `create(ReadOutputRequestSchema)` to create a new message.
+ */
+export declare const ReadOutputRequestSchema: GenMessage<ReadOutputRequest>;
+/**
+ * The read output response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.ReadOutputResponse
+ */
+export type ReadOutputResponse = Message<"mochabugapis.adapt.automations.v1.ReadOutputResponse"> & {
+    /**
+     * The session information
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.Session session = 1;
+     */
+    session?: Session;
+    /**
+     * The outputs from the session, sorted with oldest first and newest last
+     *
+     * @generated from field: repeated mochabugapis.adapt.automations.v1.Output outputs = 2;
+     */
+    outputs: Output[];
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.ReadOutputResponse.
+ * Use `create(ReadOutputResponseSchema)` to create a new message.
+ */
+export declare const ReadOutputResponseSchema: GenMessage<ReadOutputResponse>;
+/**
+ * The read URLs request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.ReadUrlsRequest
+ */
+export type ReadUrlsRequest = Message<"mochabugapis.adapt.automations.v1.ReadUrlsRequest"> & {
+    /**
+     * The automation you would like to fetch a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * A timestamp to indicate that that the urls need to be newer than
+     * Unset returns everythings
+     *
+     * @generated from field: optional google.protobuf.Timestamp newer_than = 2;
+     */
+    newerThan?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.ReadUrlsRequest.
+ * Use `create(ReadUrlsRequestSchema)` to create a new message.
+ */
+export declare const ReadUrlsRequestSchema: GenMessage<ReadUrlsRequest>;
+/**
+ * The read URLs response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.ReadUrlsResponse
+ */
+export type ReadUrlsResponse = Message<"mochabugapis.adapt.automations.v1.ReadUrlsResponse"> & {
+    /**
+     * The session information
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.Session session = 1;
+     */
+    session?: Session;
+    /**
+     * The URLs for the session, sorted with oldest first and newest last
+     *
+     * @generated from field: repeated mochabugapis.adapt.automations.v1.Url urls = 2;
+     */
+    urls: Url[];
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.ReadUrlsResponse.
+ * Use `create(ReadUrlsResponseSchema)` to create a new message.
+ */
+export declare const ReadUrlsResponseSchema: GenMessage<ReadUrlsResponse>;
+/**
+ * The start session request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.StartSessionRequest
+ */
+export type StartSessionRequest = Message<"mochabugapis.adapt.automations.v1.StartSessionRequest"> & {
+    /**
+     * The automation to start
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * The transmitter to start from (optional, it defaults to the first one, always)
+     *
+     * @generated from field: optional string transmitter = 2;
+     */
+    transmitter?: string;
+    /**
+     * The signals on the transmitter you wish to start with
+     * Make sure that they align to the signals JTD schema
+     *
+     * @generated from field: map<string, google.protobuf.Value> signals = 3;
+     */
+    signals: {
+        [key: string]: Value;
+    };
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.StartSessionRequest.
+ * Use `create(StartSessionRequestSchema)` to create a new message.
+ */
+export declare const StartSessionRequestSchema: GenMessage<StartSessionRequest>;
+/**
+ * The start session response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.StartSessionResponse
+ */
+export type StartSessionResponse = Message<"mochabugapis.adapt.automations.v1.StartSessionResponse"> & {
+    /**
+     * The automation you started a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * The session identifier
+     *
+     * @generated from field: string session = 2;
+     */
+    session: string;
+    /**
+     * The session token
+     *
+     * @generated from field: string session_token = 3;
+     */
+    sessionToken: string;
+    /**
+     * The MQTT token to use for the MQTT API
+     *
+     * @generated from field: string mqtt_token = 4;
+     */
+    mqttToken: string;
+    /**
+     * The timestamp when the session expires, if not set, the session never expires (typically the case for long-running stream vertices)
+     *
+     * @generated from field: optional google.protobuf.Timestamp expires = 5;
+     */
+    expires?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.StartSessionResponse.
+ * Use `create(StartSessionResponseSchema)` to create a new message.
+ */
+export declare const StartSessionResponseSchema: GenMessage<StartSessionResponse>;
+/**
+ * The stop session request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.StopSessionRequest
+ */
+export type StopSessionRequest = Message<"mochabugapis.adapt.automations.v1.StopSessionRequest"> & {
+    /**
+     * The automation you would like to fetch a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.StopSessionRequest.
+ * Use `create(StopSessionRequestSchema)` to create a new message.
+ */
+export declare const StopSessionRequestSchema: GenMessage<StopSessionRequest>;
+/**
+ * The stop session response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.StopSessionResponse
+ */
+export type StopSessionResponse = Message<"mochabugapis.adapt.automations.v1.StopSessionResponse"> & {};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.StopSessionResponse.
+ * Use `create(StopSessionResponseSchema)` to create a new message.
+ */
+export declare const StopSessionResponseSchema: GenMessage<StopSessionResponse>;
+/**
+ * The get session request
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.GetSessionRequest
+ */
+export type GetSessionRequest = Message<"mochabugapis.adapt.automations.v1.GetSessionRequest"> & {
+    /**
+     * The automation you would like to fetch a session for
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.GetSessionRequest.
+ * Use `create(GetSessionRequestSchema)` to create a new message.
+ */
+export declare const GetSessionRequestSchema: GenMessage<GetSessionRequest>;
+/**
+ * The get session response
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.GetSessionResponse
+ */
+export type GetSessionResponse = Message<"mochabugapis.adapt.automations.v1.GetSessionResponse"> & {
+    /**
+     * The session information
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.Session session = 1;
+     */
+    session?: Session;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.GetSessionResponse.
+ * Use `create(GetSessionResponseSchema)` to create a new message.
+ */
+export declare const GetSessionResponseSchema: GenMessage<GetSessionResponse>;
+/**
+ * An identifier
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.AutomationId
+ */
+export type AutomationId = Message<"mochabugapis.adapt.automations.v1.AutomationId"> & {
+    /**
+     * The organization to start the automation in
+     *
+     * @generated from field: string organization = 1;
+     */
+    organization: string;
+    /**
+     * The group where the automation lies
+     *
+     * @generated from field: string group = 2;
+     */
+    group: string;
+    /**
+     * The actual automation inside the group to start
+     *
+     * @generated from field: string automation = 3;
+     */
+    automation: string;
+    /**
+     * The version of the automation
+     * Can be either a version like 1.0.0 or a version selector like 1.*.* or *.*.*
+     *
+     * @generated from field: string version = 4;
+     */
+    version: string;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.AutomationId.
+ * Use `create(AutomationIdSchema)` to create a new message.
+ */
+export declare const AutomationIdSchema: GenMessage<AutomationId>;
+/**
+ * Output data from the automation (corresponds to an output vertex instance)
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.Output
+ */
+export type Output = Message<"mochabugapis.adapt.automations.v1.Output"> & {
+    /**
+     * The vertex id
+     *
+     * @generated from field: string vertex = 1;
+     */
+    vertex: string;
+    /**
+     * The actual data that has been output from the vertex
+     *
+     * @generated from field: map<string, google.protobuf.Value> data = 2;
+     */
+    data: {
+        [key: string]: Value;
+    };
+    /**
+     * The timestamp when the output was created
+     *
+     * @generated from field: google.protobuf.Timestamp created = 3;
+     */
+    created?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.Output.
+ * Use `create(OutputSchema)` to create a new message.
+ */
+export declare const OutputSchema: GenMessage<Output>;
+/**
+ * A representation of a URL
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.Url
+ */
+export type Url = Message<"mochabugapis.adapt.automations.v1.Url"> & {
+    /**
+     * The URL
+     *
+     * @generated from field: string url = 1;
+     */
+    url: string;
+    /**
+     * The timestamp when the URL was created
+     *
+     * @generated from field: google.protobuf.Timestamp created = 2;
+     */
+    created?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.Url.
+ * Use `create(UrlSchema)` to create a new message.
+ */
+export declare const UrlSchema: GenMessage<Url>;
+/**
+ * The session information
+ *
+ * @generated from message mochabugapis.adapt.automations.v1.Session
+ */
+export type Session = Message<"mochabugapis.adapt.automations.v1.Session"> & {
+    /**
+     * The automation
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.AutomationId automation = 1;
+     */
+    automation?: AutomationId;
+    /**
+     * The actual session
+     *
+     * @generated from field: string session = 4;
+     */
+    session: string;
+    /**
+     * The status of the session
+     *
+     * @generated from field: mochabugapis.adapt.automations.v1.Status status = 5;
+     */
+    status: Status;
+};
+/**
+ * Describes the message mochabugapis.adapt.automations.v1.Session.
+ * Use `create(SessionSchema)` to create a new message.
+ */
+export declare const SessionSchema: GenMessage<Session>;
+/**
+ * The session enum status
+ *
+ * @generated from enum mochabugapis.adapt.automations.v1.Status
+ */
+export declare enum Status {
+    /**
+     * Unspecified
+     *
+     * @generated from enum value: STATUS_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The session is running
+     *
+     * @generated from enum value: STATUS_RUNNING = 1;
+     */
+    RUNNING = 1,
+    /**
+     * The session has been stopped
+     *
+     * @generated from enum value: STATUS_STOPPED = 2;
+     */
+    STOPPED = 2,
+    /**
+     * The session has been completed
+     *
+     * @generated from enum value: STATUS_COMPLETED = 3;
+     */
+    COMPLETED = 3,
+    /**
+     * The session has expired
+     *
+     * @generated from enum value: STATUS_EXPIRED = 4;
+     */
+    EXPIRED = 4,
+    /**
+     * The session has been errored (errors during the runtime)
+     *
+     * @generated from enum value: STATUS_ERRORED = 5;
+     */
+    ERRORED = 5
+}
+/**
+ * Describes the enum mochabugapis.adapt.automations.v1.Status.
+ */
+export declare const StatusSchema: GenEnum<Status>;
+/**
+ * A service that provides automation functionality.
+ *
+ * @generated from service mochabugapis.adapt.automations.v1.AutomationService
+ */
+export declare const AutomationService: GenService<{
+    /**
+     * Start a session of the specified automation
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.StartSession
+     */
+    startSession: {
+        methodKind: "unary";
+        input: typeof StartSessionRequestSchema;
+        output: typeof StartSessionResponseSchema;
+    };
+    /**
+     * Stop a specific session
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.StopSession
+     */
+    stopSession: {
+        methodKind: "unary";
+        input: typeof StopSessionRequestSchema;
+        output: typeof StopSessionResponseSchema;
+    };
+    /**
+     * Inherit a session
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.InheritSession
+     */
+    inheritSession: {
+        methodKind: "unary";
+        input: typeof InheritSessionRequestSchema;
+        output: typeof InheritSessionResponseSchema;
+    };
+    /**
+     * Get session information
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.GetSession
+     */
+    getSession: {
+        methodKind: "unary";
+        input: typeof GetSessionRequestSchema;
+        output: typeof GetSessionResponseSchema;
+    };
+    /**
+     * Read the output from the session
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.ReadOutput
+     */
+    readOutput: {
+        methodKind: "unary";
+        input: typeof ReadOutputRequestSchema;
+        output: typeof ReadOutputResponseSchema;
+    };
+    /**
+     * Read URLs for the session for browser-based clients
+     *
+     * @generated from rpc mochabugapis.adapt.automations.v1.AutomationService.ReadUrls
+     */
+    readUrls: {
+        methodKind: "unary";
+        input: typeof ReadUrlsRequestSchema;
+        output: typeof ReadUrlsResponseSchema;
+    };
+}>;