@toshicloud/sdk 0.4.0 → 0.5.0

package/dist/gen/toshi/workspace/v1/products_pb.d.ts

@@ -0,0 +1,703 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { FeatureValue, FeatureValueJson, ProductState, ProductStateJson, ProductSwitch, ProductSwitchJson } from "./discovery_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/products.proto.
+ */
+export declare const file_toshi_workspace_v1_products: GenFile;
+/**
+ * @generated from message toshi.workspace.v1.ListProductsRequest
+ */
+export type ListProductsRequest = Message<"toshi.workspace.v1.ListProductsRequest"> & {};
+/**
+ * @generated from message toshi.workspace.v1.ListProductsRequest
+ */
+export type ListProductsRequestJson = {};
+/**
+ * Describes the message toshi.workspace.v1.ListProductsRequest.
+ * Use `create(ListProductsRequestSchema)` to create a new message.
+ */
+export declare const ListProductsRequestSchema: GenMessage<ListProductsRequest, {
+    jsonType: ListProductsRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListProductsResponse
+ */
+export type ListProductsResponse = Message<"toshi.workspace.v1.ListProductsResponse"> & {
+    /**
+     * products are the products the deployment includes, by id.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProductSettings products = 1;
+     */
+    products: ProductSettings[];
+};
+/**
+ * @generated from message toshi.workspace.v1.ListProductsResponse
+ */
+export type ListProductsResponseJson = {
+    /**
+     * products are the products the deployment includes, by id.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProductSettings products = 1;
+     */
+    products?: ProductSettingsJson[];
+};
+/**
+ * Describes the message toshi.workspace.v1.ListProductsResponse.
+ * Use `create(ListProductsResponseSchema)` to create a new message.
+ */
+export declare const ListProductsResponseSchema: GenMessage<ListProductsResponse, {
+    jsonType: ListProductsResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateProductRequest
+ */
+export type UpdateProductRequest = Message<"toshi.workspace.v1.UpdateProductRequest"> & {
+    /**
+     * id names the product, such as "runners".
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * enabled turns the product on or off for the workspace: it sets the
+     * product's own switch, the feature "<id>.enabled". Unset leaves it.
+     * Turning on a product the workspace's entitlements leave off is
+     * INVALID_ARGUMENT.
+     *
+     * @generated from field: optional bool enabled = 2;
+     */
+    enabled?: boolean | undefined;
+    /**
+     * settings are the features to set, by key ("<id>.<name>"), each to a
+     * value of the feature's type.
+     *
+     * @generated from field: map<string, toshi.workspace.v1.FeatureValue> settings = 3;
+     */
+    settings: {
+        [key: string]: FeatureValue;
+    };
+    /**
+     * clear are the keys of the features whose settings to remove: the
+     * entitlement applies again. A key that is also in settings, or that
+     * enabled sets, is INVALID_ARGUMENT.
+     *
+     * @generated from field: repeated string clear = 4;
+     */
+    clear: string[];
+    /**
+     * accepted_access is the access an outside product, one a catalog source
+     * offers, asks for, as its catalog entry lists it. Turning such a product
+     * on for the first time, or again after it was removed, installs it and
+     * grants it that access, and needs the same permissions here, in any
+     * order: any other list is FAILED_PRECONDITION with an ErrorInfo of reason
+     * ACCESS_NOT_ACCEPTED whose metadata "access" lists what the entry asks
+     * for. Only a caller who holds every permission it asks for may install
+     * it, a person or a workspace token; one who lacks one is
+     * PERMISSION_DENIED naming it. Ignored when the product is built in or
+     * already installed.
+     *
+     * @generated from field: repeated string accepted_access = 5;
+     */
+    acceptedAccess: string[];
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateProductRequest
+ */
+export type UpdateProductRequestJson = {
+    /**
+     * id names the product, such as "runners".
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * enabled turns the product on or off for the workspace: it sets the
+     * product's own switch, the feature "<id>.enabled". Unset leaves it.
+     * Turning on a product the workspace's entitlements leave off is
+     * INVALID_ARGUMENT.
+     *
+     * @generated from field: optional bool enabled = 2;
+     */
+    enabled?: boolean;
+    /**
+     * settings are the features to set, by key ("<id>.<name>"), each to a
+     * value of the feature's type.
+     *
+     * @generated from field: map<string, toshi.workspace.v1.FeatureValue> settings = 3;
+     */
+    settings?: {
+        [key: string]: FeatureValueJson;
+    };
+    /**
+     * clear are the keys of the features whose settings to remove: the
+     * entitlement applies again. A key that is also in settings, or that
+     * enabled sets, is INVALID_ARGUMENT.
+     *
+     * @generated from field: repeated string clear = 4;
+     */
+    clear?: string[];
+    /**
+     * accepted_access is the access an outside product, one a catalog source
+     * offers, asks for, as its catalog entry lists it. Turning such a product
+     * on for the first time, or again after it was removed, installs it and
+     * grants it that access, and needs the same permissions here, in any
+     * order: any other list is FAILED_PRECONDITION with an ErrorInfo of reason
+     * ACCESS_NOT_ACCEPTED whose metadata "access" lists what the entry asks
+     * for. Only a caller who holds every permission it asks for may install
+     * it, a person or a workspace token; one who lacks one is
+     * PERMISSION_DENIED naming it. Ignored when the product is built in or
+     * already installed.
+     *
+     * @generated from field: repeated string accepted_access = 5;
+     */
+    acceptedAccess?: string[];
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateProductRequest.
+ * Use `create(UpdateProductRequestSchema)` to create a new message.
+ */
+export declare const UpdateProductRequestSchema: GenMessage<UpdateProductRequest, {
+    jsonType: UpdateProductRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateProductResponse
+ */
+export type UpdateProductResponse = Message<"toshi.workspace.v1.UpdateProductResponse"> & {
+    /**
+     * product is the product as the workspace has it after the change.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSettings product = 1;
+     */
+    product?: ProductSettings | undefined;
+    /**
+     * installation_token is the token an outside product's installation calls
+     * the Workspace API with, "toshi_in_" and 46 characters. Only the call
+     * that installs the product returns it.
+     *
+     * @generated from field: string installation_token = 2;
+     */
+    installationToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateProductResponse
+ */
+export type UpdateProductResponseJson = {
+    /**
+     * product is the product as the workspace has it after the change.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSettings product = 1;
+     */
+    product?: ProductSettingsJson;
+    /**
+     * installation_token is the token an outside product's installation calls
+     * the Workspace API with, "toshi_in_" and 46 characters. Only the call
+     * that installs the product returns it.
+     *
+     * @generated from field: string installation_token = 2;
+     */
+    installationToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateProductResponse.
+ * Use `create(UpdateProductResponseSchema)` to create a new message.
+ */
+export declare const UpdateProductResponseSchema: GenMessage<UpdateProductResponse, {
+    jsonType: UpdateProductResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.RemoveProductRequest
+ */
+export type RemoveProductRequest = Message<"toshi.workspace.v1.RemoveProductRequest"> & {
+    /**
+     * id names the outside product.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.RemoveProductRequest
+ */
+export type RemoveProductRequestJson = {
+    /**
+     * id names the outside product.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.RemoveProductRequest.
+ * Use `create(RemoveProductRequestSchema)` to create a new message.
+ */
+export declare const RemoveProductRequestSchema: GenMessage<RemoveProductRequest, {
+    jsonType: RemoveProductRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.RemoveProductResponse
+ */
+export type RemoveProductResponse = Message<"toshi.workspace.v1.RemoveProductResponse"> & {
+    /**
+     * product is the product as the workspace has it after the removal.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSettings product = 1;
+     */
+    product?: ProductSettings | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.RemoveProductResponse
+ */
+export type RemoveProductResponseJson = {
+    /**
+     * product is the product as the workspace has it after the removal.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSettings product = 1;
+     */
+    product?: ProductSettingsJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.RemoveProductResponse.
+ * Use `create(RemoveProductResponseSchema)` to create a new message.
+ */
+export declare const RemoveProductResponseSchema: GenMessage<RemoveProductResponse, {
+    jsonType: RemoveProductResponseJson;
+}>;
+/**
+ * ProductSettings is one product as the workspace has it.
+ *
+ * @generated from message toshi.workspace.v1.ProductSettings
+ */
+export type ProductSettings = Message<"toshi.workspace.v1.ProductSettings"> & {
+    /**
+     * id names the product, such as "runners": its config section, the
+     * prefix of its features and its permissions.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * switch says whether the product is on for the workspace and, when it
+     * is off, which switch turned it off.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSwitch switch = 2;
+     */
+    switch: ProductSwitch;
+    /**
+     * features are the product's features, in the order the product
+     * declares them.
+     *
+     * @generated from field: repeated toshi.workspace.v1.FeatureSetting features = 3;
+     */
+    features: FeatureSetting[];
+    /**
+     * state is where the product is in the deployment's lifecycle, as
+     * DiscoveryService.Discover reports it: a product the deployment's config
+     * turns off is winding down (no new work, draining) until its work ends,
+     * then stopped.
+     *
+     * @generated from field: toshi.workspace.v1.ProductState state = 4;
+     */
+    state: ProductState;
+    /**
+     * installation is the workspace's installation of an outside product, a
+     * removed one included; unset for a built-in product. Such a product
+     * declares no features, and its switch is ON while the installation is
+     * active and TURNED_OFF otherwise.
+     *
+     * @generated from field: toshi.workspace.v1.ProductInstallation installation = 5;
+     */
+    installation?: ProductInstallation | undefined;
+};
+/**
+ * ProductSettings is one product as the workspace has it.
+ *
+ * @generated from message toshi.workspace.v1.ProductSettings
+ */
+export type ProductSettingsJson = {
+    /**
+     * id names the product, such as "runners": its config section, the
+     * prefix of its features and its permissions.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * switch says whether the product is on for the workspace and, when it
+     * is off, which switch turned it off.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSwitch switch = 2;
+     */
+    switch?: ProductSwitchJson;
+    /**
+     * features are the product's features, in the order the product
+     * declares them.
+     *
+     * @generated from field: repeated toshi.workspace.v1.FeatureSetting features = 3;
+     */
+    features?: FeatureSettingJson[];
+    /**
+     * state is where the product is in the deployment's lifecycle, as
+     * DiscoveryService.Discover reports it: a product the deployment's config
+     * turns off is winding down (no new work, draining) until its work ends,
+     * then stopped.
+     *
+     * @generated from field: toshi.workspace.v1.ProductState state = 4;
+     */
+    state?: ProductStateJson;
+    /**
+     * installation is the workspace's installation of an outside product, a
+     * removed one included; unset for a built-in product. Such a product
+     * declares no features, and its switch is ON while the installation is
+     * active and TURNED_OFF otherwise.
+     *
+     * @generated from field: toshi.workspace.v1.ProductInstallation installation = 5;
+     */
+    installation?: ProductInstallationJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.ProductSettings.
+ * Use `create(ProductSettingsSchema)` to create a new message.
+ */
+export declare const ProductSettingsSchema: GenMessage<ProductSettings, {
+    jsonType: ProductSettingsJson;
+}>;
+/**
+ * ProductInstallation is a workspace's installation of an outside product.
+ *
+ * @generated from message toshi.workspace.v1.ProductInstallation
+ */
+export type ProductInstallation = Message<"toshi.workspace.v1.ProductInstallation"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.InstallationState state = 1;
+     */
+    state: InstallationState;
+    /**
+     * version and publisher are the catalog entry's when it was installed.
+     *
+     * @generated from field: string version = 2;
+     */
+    version: string;
+    /**
+     * @generated from field: string publisher = 3;
+     */
+    publisher: string;
+    /**
+     * access are the permissions the workspace granted it, sorted.
+     *
+     * @generated from field: repeated string access = 4;
+     */
+    access: string[];
+    /**
+     * role_id names the role that holds the access, "Product <id>", granted to
+     * token_id, the installation's token.
+     *
+     * @generated from field: string role_id = 5;
+     */
+    roleId: string;
+    /**
+     * @generated from field: string token_id = 6;
+     */
+    tokenId: string;
+    /**
+     * installed_by names who installed it: "person:" and their GitHub user
+     * id, or "token:" and the workspace token's id.
+     *
+     * @generated from field: string installed_by = 7;
+     */
+    installedBy: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp installed_at = 8;
+     */
+    installedAt?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 9;
+     */
+    updatedAt?: Timestamp | undefined;
+};
+/**
+ * ProductInstallation is a workspace's installation of an outside product.
+ *
+ * @generated from message toshi.workspace.v1.ProductInstallation
+ */
+export type ProductInstallationJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.InstallationState state = 1;
+     */
+    state?: InstallationStateJson;
+    /**
+     * version and publisher are the catalog entry's when it was installed.
+     *
+     * @generated from field: string version = 2;
+     */
+    version?: string;
+    /**
+     * @generated from field: string publisher = 3;
+     */
+    publisher?: string;
+    /**
+     * access are the permissions the workspace granted it, sorted.
+     *
+     * @generated from field: repeated string access = 4;
+     */
+    access?: string[];
+    /**
+     * role_id names the role that holds the access, "Product <id>", granted to
+     * token_id, the installation's token.
+     *
+     * @generated from field: string role_id = 5;
+     */
+    roleId?: string;
+    /**
+     * @generated from field: string token_id = 6;
+     */
+    tokenId?: string;
+    /**
+     * installed_by names who installed it: "person:" and their GitHub user
+     * id, or "token:" and the workspace token's id.
+     *
+     * @generated from field: string installed_by = 7;
+     */
+    installedBy?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp installed_at = 8;
+     */
+    installedAt?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 9;
+     */
+    updatedAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.ProductInstallation.
+ * Use `create(ProductInstallationSchema)` to create a new message.
+ */
+export declare const ProductInstallationSchema: GenMessage<ProductInstallation, {
+    jsonType: ProductInstallationJson;
+}>;
+/**
+ * FeatureSetting is one feature of a product as the workspace has it.
+ *
+ * @generated from message toshi.workspace.v1.FeatureSetting
+ */
+export type FeatureSetting = Message<"toshi.workspace.v1.FeatureSetting"> & {
+    /**
+     * key is "<product id>.<name>".
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * narrowable reports whether the workspace's settings may narrow the
+     * feature. UpdateProduct refuses a setting of a feature that is not.
+     *
+     * @generated from field: bool narrowable = 2;
+     */
+    narrowable: boolean;
+    /**
+     * entitlement is the most the workspace may choose: the operator's
+     * override for the workspace, else its plan's value, else the feature's
+     * default.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue entitlement = 3;
+     */
+    entitlement?: FeatureValue | undefined;
+    /**
+     * setting is the workspace's own choice; unset when it has none. A
+     * setting its entitlement no longer contains, after the plan or an
+     * override lowered it, is kept and not applied.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue setting = 4;
+     */
+    setting?: FeatureValue | undefined;
+    /**
+     * effective is the value the product uses while it is on: the setting
+     * when the entitlement contains it, else the entitlement.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue effective = 5;
+     */
+    effective?: FeatureValue | undefined;
+    /**
+     * changed_by names who made the setting, as the audit log names an
+     * actor, and changed_at when; both unset when the workspace has no
+     * setting.
+     *
+     * @generated from field: string changed_by = 6;
+     */
+    changedBy: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp changed_at = 7;
+     */
+    changedAt?: Timestamp | undefined;
+};
+/**
+ * FeatureSetting is one feature of a product as the workspace has it.
+ *
+ * @generated from message toshi.workspace.v1.FeatureSetting
+ */
+export type FeatureSettingJson = {
+    /**
+     * key is "<product id>.<name>".
+     *
+     * @generated from field: string key = 1;
+     */
+    key?: string;
+    /**
+     * narrowable reports whether the workspace's settings may narrow the
+     * feature. UpdateProduct refuses a setting of a feature that is not.
+     *
+     * @generated from field: bool narrowable = 2;
+     */
+    narrowable?: boolean;
+    /**
+     * entitlement is the most the workspace may choose: the operator's
+     * override for the workspace, else its plan's value, else the feature's
+     * default.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue entitlement = 3;
+     */
+    entitlement?: FeatureValueJson;
+    /**
+     * setting is the workspace's own choice; unset when it has none. A
+     * setting its entitlement no longer contains, after the plan or an
+     * override lowered it, is kept and not applied.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue setting = 4;
+     */
+    setting?: FeatureValueJson;
+    /**
+     * effective is the value the product uses while it is on: the setting
+     * when the entitlement contains it, else the entitlement.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue effective = 5;
+     */
+    effective?: FeatureValueJson;
+    /**
+     * changed_by names who made the setting, as the audit log names an
+     * actor, and changed_at when; both unset when the workspace has no
+     * setting.
+     *
+     * @generated from field: string changed_by = 6;
+     */
+    changedBy?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp changed_at = 7;
+     */
+    changedAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.FeatureSetting.
+ * Use `create(FeatureSettingSchema)` to create a new message.
+ */
+export declare const FeatureSettingSchema: GenMessage<FeatureSetting, {
+    jsonType: FeatureSettingJson;
+}>;
+/**
+ * InstallationState is where an installation stands.
+ *
+ * @generated from enum toshi.workspace.v1.InstallationState
+ */
+export declare enum InstallationState {
+    /**
+     * @generated from enum value: INSTALLATION_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The product is on and its token works.
+     *
+     * @generated from enum value: INSTALLATION_STATE_ACTIVE = 1;
+     */
+    ACTIVE = 1,
+    /**
+     * The product is turned off: its token is refused and its webhook
+     * endpoints are paused until it is turned on again.
+     *
+     * @generated from enum value: INSTALLATION_STATE_SUSPENDED = 2;
+     */
+    SUSPENDED = 2,
+    /**
+     * Its token is revoked and its role deleted; turning it on installs it
+     * again.
+     *
+     * @generated from enum value: INSTALLATION_STATE_REMOVED = 3;
+     */
+    REMOVED = 3
+}
+/**
+ * InstallationState is where an installation stands.
+ *
+ * @generated from enum toshi.workspace.v1.InstallationState
+ */
+export type InstallationStateJson = "INSTALLATION_STATE_UNSPECIFIED" | "INSTALLATION_STATE_ACTIVE" | "INSTALLATION_STATE_SUSPENDED" | "INSTALLATION_STATE_REMOVED";
+/**
+ * Describes the enum toshi.workspace.v1.InstallationState.
+ */
+export declare const InstallationStateSchema: GenEnum<InstallationState, InstallationStateJson>;
+/**
+ * ProductService reads and changes the workspace's settings of its
+ * products. A product, such as Runners, declares features: typed keys such
+ * as "runners.enabled", the product's own switch, or a limit such as
+ * "previews.max_count". The workspace's entitlement to each feature comes
+ * from its plan and the operator's overrides, and it cannot change it. Its
+ * settings are its own choices within the entitlement: they only narrow it,
+ * turning a product or a feature off or setting a lower limit.
+ *
+ * The caller's credential names the workspace, as for WorkloadService.
+ *
+ * @generated from service toshi.workspace.v1.ProductService
+ */
+export declare const ProductService: GenService<{
+    /**
+     * ListProducts returns the products the deployment includes, by id, each
+     * with its switch and its features: the entitlement, the workspace's
+     * setting if it has one, the effective value, and who changed the
+     * setting last and when; then the outside products the workspace has
+     * installed, by id, each with its installation.
+     *
+     * @generated from rpc toshi.workspace.v1.ProductService.ListProducts
+     */
+    listProducts: {
+        methodKind: "unary";
+        input: typeof ListProductsRequestSchema;
+        output: typeof ListProductsResponseSchema;
+    };
+    /**
+     * UpdateProduct changes the workspace's settings of one product in one
+     * call: it turns the product on or off, and sets or clears its features.
+     * The caller and the time of the call are recorded with each setting it
+     * sets. A setting only narrows the workspace's entitlement: a value wider
+     * than the entitlement, a key the product does not declare or that the
+     * workspace cannot narrow, or a value of another type than the key's is
+     * INVALID_ARGUMENT naming the key, and nothing is changed. A product the
+     * deployment does not include, built in or offered by a catalog source,
+     * is NOT_FOUND.
+     *
+     * An outside product, one a catalog source offers, has no settings but
+     * enabled: turning it on installs it (accepted_access) or resumes its
+     * installation, and turning it off suspends it.
+     *
+     * The product's calls follow the change from the next call on.
+     *
+     * @generated from rpc toshi.workspace.v1.ProductService.UpdateProduct
+     */
+    updateProduct: {
+        methodKind: "unary";
+        input: typeof UpdateProductRequestSchema;
+        output: typeof UpdateProductResponseSchema;
+    };
+    /**
+     * RemoveProduct removes the workspace's installation of an outside
+     * product: it revokes the installation's token, deletes the role that
+     * held its access and stops its webhook endpoints. The data the product
+     * stored in the workspace stays. A product that is not installed, or not
+     * an outside product, is NOT_FOUND.
+     *
+     * @generated from rpc toshi.workspace.v1.ProductService.RemoveProduct
+     */
+    removeProduct: {
+        methodKind: "unary";
+        input: typeof RemoveProductRequestSchema;
+        output: typeof RemoveProductResponseSchema;
+    };
+}>;