@toshicloud/sdk 0.6.0 → 0.7.0

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

@@ -0,0 +1,654 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { FieldMask, FieldMaskJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/model_credentials.proto.
+ */
+export declare const file_toshi_workspace_v1_model_credentials: GenFile;
+/**
+ * ModelCredential is a credential as anyone may see it: never its value.
+ *
+ * @generated from message toshi.workspace.v1.ModelCredential
+ */
+export type ModelCredential = Message<"toshi.workspace.v1.ModelCredential"> & {
+    /**
+     * "mcr-" and 26 characters, given by the control plane.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * 1 to 64 characters: lowercase letters, digits and "-", starting with
+     * a letter. Unique among the workspace's credentials, and among each
+     * person's own.
+     *
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * The model provider: "anthropic" or "openai".
+     *
+     * @generated from field: string provider = 3;
+     */
+    provider: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredentialKind kind = 4;
+     */
+    kind: ModelCredentialKind;
+    /**
+     * The user id of the person whose own credential it is; empty for the
+     * workspace's.
+     *
+     * @generated from field: string owner = 5;
+     */
+    owner: string;
+    /**
+     * The credential is the caller's own.
+     *
+     * @generated from field: bool mine = 6;
+     */
+    mine: boolean;
+    /**
+     * The credential's owner holds no role in the workspace any more: no
+     * workload receives it, and it stays until it is deleted.
+     *
+     * @generated from field: bool owner_left = 7;
+     */
+    ownerLeft: boolean;
+    /**
+     * The key's place: its project and either its environment or shared.
+     *
+     * @generated from field: string project = 8;
+     */
+    project: string;
+    /**
+     * Empty for the shared set.
+     *
+     * @generated from field: string environment = 9;
+     */
+    environment: string;
+    /**
+     * @generated from field: bool shared = 10;
+     */
+    shared: boolean;
+    /**
+     * The key's name in that place.
+     *
+     * @generated from field: string secret = 11;
+     */
+    secret: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 12;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * The user id of the person who added it.
+     *
+     * @generated from field: string created_by = 13;
+     */
+    createdBy: string;
+};
+/**
+ * ModelCredential is a credential as anyone may see it: never its value.
+ *
+ * @generated from message toshi.workspace.v1.ModelCredential
+ */
+export type ModelCredentialJson = {
+    /**
+     * "mcr-" and 26 characters, given by the control plane.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * 1 to 64 characters: lowercase letters, digits and "-", starting with
+     * a letter. Unique among the workspace's credentials, and among each
+     * person's own.
+     *
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+    /**
+     * The model provider: "anthropic" or "openai".
+     *
+     * @generated from field: string provider = 3;
+     */
+    provider?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredentialKind kind = 4;
+     */
+    kind?: ModelCredentialKindJson;
+    /**
+     * The user id of the person whose own credential it is; empty for the
+     * workspace's.
+     *
+     * @generated from field: string owner = 5;
+     */
+    owner?: string;
+    /**
+     * The credential is the caller's own.
+     *
+     * @generated from field: bool mine = 6;
+     */
+    mine?: boolean;
+    /**
+     * The credential's owner holds no role in the workspace any more: no
+     * workload receives it, and it stays until it is deleted.
+     *
+     * @generated from field: bool owner_left = 7;
+     */
+    ownerLeft?: boolean;
+    /**
+     * The key's place: its project and either its environment or shared.
+     *
+     * @generated from field: string project = 8;
+     */
+    project?: string;
+    /**
+     * Empty for the shared set.
+     *
+     * @generated from field: string environment = 9;
+     */
+    environment?: string;
+    /**
+     * @generated from field: bool shared = 10;
+     */
+    shared?: boolean;
+    /**
+     * The key's name in that place.
+     *
+     * @generated from field: string secret = 11;
+     */
+    secret?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 12;
+     */
+    createdAt?: TimestampJson;
+    /**
+     * The user id of the person who added it.
+     *
+     * @generated from field: string created_by = 13;
+     */
+    createdBy?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ModelCredential.
+ * Use `create(ModelCredentialSchema)` to create a new message.
+ */
+export declare const ModelCredentialSchema: GenMessage<ModelCredential, {
+    jsonType: ModelCredentialJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CreateModelCredentialRequest
+ */
+export type CreateModelCredentialRequest = Message<"toshi.workspace.v1.CreateModelCredentialRequest"> & {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * @generated from field: string provider = 2;
+     */
+    provider: string;
+    /**
+     * The key's place: the project and either environment or shared. A
+     * request that names both, or neither, is INVALID_ARGUMENT.
+     *
+     * @generated from field: string project = 3;
+     */
+    project: string;
+    /**
+     * @generated from field: string environment = 4;
+     */
+    environment: string;
+    /**
+     * @generated from field: bool shared = 5;
+     */
+    shared: boolean;
+    /**
+     * The key's name, as PutSecret takes it.
+     *
+     * @generated from field: string secret = 6;
+     */
+    secret: string;
+    /**
+     * When set, the key's next version; never returned.
+     *
+     * @generated from field: bytes value = 7;
+     */
+    value: Uint8Array;
+    /**
+     * The credential is the caller's own; a call that acts for no person
+     * fails with FAILED_PRECONDITION.
+     *
+     * @generated from field: bool own = 8;
+     */
+    own: boolean;
+};
+/**
+ * @generated from message toshi.workspace.v1.CreateModelCredentialRequest
+ */
+export type CreateModelCredentialRequestJson = {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name?: string;
+    /**
+     * @generated from field: string provider = 2;
+     */
+    provider?: string;
+    /**
+     * The key's place: the project and either environment or shared. A
+     * request that names both, or neither, is INVALID_ARGUMENT.
+     *
+     * @generated from field: string project = 3;
+     */
+    project?: string;
+    /**
+     * @generated from field: string environment = 4;
+     */
+    environment?: string;
+    /**
+     * @generated from field: bool shared = 5;
+     */
+    shared?: boolean;
+    /**
+     * The key's name, as PutSecret takes it.
+     *
+     * @generated from field: string secret = 6;
+     */
+    secret?: string;
+    /**
+     * When set, the key's next version; never returned.
+     *
+     * @generated from field: bytes value = 7;
+     */
+    value?: string;
+    /**
+     * The credential is the caller's own; a call that acts for no person
+     * fails with FAILED_PRECONDITION.
+     *
+     * @generated from field: bool own = 8;
+     */
+    own?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateModelCredentialRequest.
+ * Use `create(CreateModelCredentialRequestSchema)` to create a new message.
+ */
+export declare const CreateModelCredentialRequestSchema: GenMessage<CreateModelCredentialRequest, {
+    jsonType: CreateModelCredentialRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CreateModelCredentialResponse
+ */
+export type CreateModelCredentialResponse = Message<"toshi.workspace.v1.CreateModelCredentialResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredential | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.CreateModelCredentialResponse
+ */
+export type CreateModelCredentialResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredentialJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateModelCredentialResponse.
+ * Use `create(CreateModelCredentialResponseSchema)` to create a new message.
+ */
+export declare const CreateModelCredentialResponseSchema: GenMessage<CreateModelCredentialResponse, {
+    jsonType: CreateModelCredentialResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetModelCredentialRequest
+ */
+export type GetModelCredentialRequest = Message<"toshi.workspace.v1.GetModelCredentialRequest"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetModelCredentialRequest
+ */
+export type GetModelCredentialRequestJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetModelCredentialRequest.
+ * Use `create(GetModelCredentialRequestSchema)` to create a new message.
+ */
+export declare const GetModelCredentialRequestSchema: GenMessage<GetModelCredentialRequest, {
+    jsonType: GetModelCredentialRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetModelCredentialResponse
+ */
+export type GetModelCredentialResponse = Message<"toshi.workspace.v1.GetModelCredentialResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredential | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetModelCredentialResponse
+ */
+export type GetModelCredentialResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredentialJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetModelCredentialResponse.
+ * Use `create(GetModelCredentialResponseSchema)` to create a new message.
+ */
+export declare const GetModelCredentialResponseSchema: GenMessage<GetModelCredentialResponse, {
+    jsonType: GetModelCredentialResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListModelCredentialsRequest
+ */
+export type ListModelCredentialsRequest = Message<"toshi.workspace.v1.ListModelCredentialsRequest"> & {
+    /**
+     * Only this provider's credentials when set.
+     *
+     * @generated from field: string provider = 1;
+     */
+    provider: string;
+    /**
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize: number;
+    /**
+     * @generated from field: string page_token = 3;
+     */
+    pageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListModelCredentialsRequest
+ */
+export type ListModelCredentialsRequestJson = {
+    /**
+     * Only this provider's credentials when set.
+     *
+     * @generated from field: string provider = 1;
+     */
+    provider?: string;
+    /**
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize?: number;
+    /**
+     * @generated from field: string page_token = 3;
+     */
+    pageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListModelCredentialsRequest.
+ * Use `create(ListModelCredentialsRequestSchema)` to create a new message.
+ */
+export declare const ListModelCredentialsRequestSchema: GenMessage<ListModelCredentialsRequest, {
+    jsonType: ListModelCredentialsRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListModelCredentialsResponse
+ */
+export type ListModelCredentialsResponse = Message<"toshi.workspace.v1.ListModelCredentialsResponse"> & {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.ModelCredential model_credentials = 1;
+     */
+    modelCredentials: ModelCredential[];
+    /**
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListModelCredentialsResponse
+ */
+export type ListModelCredentialsResponseJson = {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.ModelCredential model_credentials = 1;
+     */
+    modelCredentials?: ModelCredentialJson[];
+    /**
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListModelCredentialsResponse.
+ * Use `create(ListModelCredentialsResponseSchema)` to create a new message.
+ */
+export declare const ListModelCredentialsResponseSchema: GenMessage<ListModelCredentialsResponse, {
+    jsonType: ListModelCredentialsResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateModelCredentialRequest
+ */
+export type UpdateModelCredentialRequest = Message<"toshi.workspace.v1.UpdateModelCredentialRequest"> & {
+    /**
+     * id names the credential; the fields update_mask names carry the new
+     * values.
+     *
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredential | undefined;
+    /**
+     * @generated from field: google.protobuf.FieldMask update_mask = 2;
+     */
+    updateMask?: FieldMask | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateModelCredentialRequest
+ */
+export type UpdateModelCredentialRequestJson = {
+    /**
+     * id names the credential; the fields update_mask names carry the new
+     * values.
+     *
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredentialJson;
+    /**
+     * @generated from field: google.protobuf.FieldMask update_mask = 2;
+     */
+    updateMask?: FieldMaskJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateModelCredentialRequest.
+ * Use `create(UpdateModelCredentialRequestSchema)` to create a new message.
+ */
+export declare const UpdateModelCredentialRequestSchema: GenMessage<UpdateModelCredentialRequest, {
+    jsonType: UpdateModelCredentialRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateModelCredentialResponse
+ */
+export type UpdateModelCredentialResponse = Message<"toshi.workspace.v1.UpdateModelCredentialResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredential | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateModelCredentialResponse
+ */
+export type UpdateModelCredentialResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.ModelCredential model_credential = 1;
+     */
+    modelCredential?: ModelCredentialJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateModelCredentialResponse.
+ * Use `create(UpdateModelCredentialResponseSchema)` to create a new message.
+ */
+export declare const UpdateModelCredentialResponseSchema: GenMessage<UpdateModelCredentialResponse, {
+    jsonType: UpdateModelCredentialResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteModelCredentialRequest
+ */
+export type DeleteModelCredentialRequest = Message<"toshi.workspace.v1.DeleteModelCredentialRequest"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.DeleteModelCredentialRequest
+ */
+export type DeleteModelCredentialRequestJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.DeleteModelCredentialRequest.
+ * Use `create(DeleteModelCredentialRequestSchema)` to create a new message.
+ */
+export declare const DeleteModelCredentialRequestSchema: GenMessage<DeleteModelCredentialRequest, {
+    jsonType: DeleteModelCredentialRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteModelCredentialResponse
+ */
+export type DeleteModelCredentialResponse = Message<"toshi.workspace.v1.DeleteModelCredentialResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.DeleteModelCredentialResponse
+ */
+export type DeleteModelCredentialResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.DeleteModelCredentialResponse.
+ * Use `create(DeleteModelCredentialResponseSchema)` to create a new message.
+ */
+export declare const DeleteModelCredentialResponseSchema: GenMessage<DeleteModelCredentialResponse, {
+    jsonType: DeleteModelCredentialResponseJson;
+}>;
+/**
+ * ModelCredentialKind is what a model credential holds.
+ *
+ * @generated from enum toshi.workspace.v1.ModelCredentialKind
+ */
+export declare enum ModelCredentialKind {
+    /**
+     * @generated from enum value: MODEL_CREDENTIAL_KIND_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * A provider's API key, kept as a key of a project's secrets.
+     *
+     * @generated from enum value: MODEL_CREDENTIAL_KIND_KEY = 1;
+     */
+    KEY = 1
+}
+/**
+ * ModelCredentialKind is what a model credential holds.
+ *
+ * @generated from enum toshi.workspace.v1.ModelCredentialKind
+ */
+export type ModelCredentialKindJson = "MODEL_CREDENTIAL_KIND_UNSPECIFIED" | "MODEL_CREDENTIAL_KIND_KEY";
+/**
+ * Describes the enum toshi.workspace.v1.ModelCredentialKind.
+ */
+export declare const ModelCredentialKindSchema: GenEnum<ModelCredentialKind, ModelCredentialKindJson>;
+/**
+ * ModelCredentialService keeps the workspace's model credentials: the keys
+ * its workloads use to reach a model provider. A key credential is a key
+ * of a project's secrets, an environment's or the shared set's, marked
+ * with its provider. A marked key never enters a guest: no workload
+ * receives it in its environment, and no call returns its value.
+ *
+ * A credential is the workspace's or one person's own. The workspace's
+ * serve every workload its key's place reaches; a person's own serve only
+ * the workloads that person starts, while the person holds a role in the
+ * workspace, as a person's own secret does. A key credential is the
+ * workspace's unless the request asks for the caller's own.
+ *
+ * A member makes these calls for their own credentials with membership
+ * alone. A workspace credential needs model_credentials.read to be seen
+ * and model_credentials.write to be created, changed or deleted; without
+ * the permission, a call on a workspace credential fails with
+ * PERMISSION_DENIED and the reason PERMISSION_MISSING. No caller sees
+ * another person's own credential: it is NOT_FOUND.
+ *
+ * @generated from service toshi.workspace.v1.ModelCredentialService
+ */
+export declare const ModelCredentialService: GenService<{
+    /**
+     * CreateModelCredential adds a key credential for one provider. The
+     * request names the key's place, its project and either its environment
+     * or shared, and the key's name. With value, the call writes the value
+     * as the key's next version first, as PutSecret does; without it, the
+     * key must exist. A key that already serves a credential fails with
+     * ALREADY_EXISTS, and so does a second credential of the same name and
+     * owner.
+     *
+     * @generated from rpc toshi.workspace.v1.ModelCredentialService.CreateModelCredential
+     */
+    createModelCredential: {
+        methodKind: "unary";
+        input: typeof CreateModelCredentialRequestSchema;
+        output: typeof CreateModelCredentialResponseSchema;
+    };
+    /**
+     * GetModelCredential returns one credential, never its value.
+     *
+     * @generated from rpc toshi.workspace.v1.ModelCredentialService.GetModelCredential
+     */
+    getModelCredential: {
+        methodKind: "unary";
+        input: typeof GetModelCredentialRequestSchema;
+        output: typeof GetModelCredentialResponseSchema;
+    };
+    /**
+     * ListModelCredentials returns the caller's own credentials and, with
+     * model_credentials.read, the workspace's, by name.
+     *
+     * A page holds 100 credentials when page_size is zero, and 1000 at most.
+     *
+     * @generated from rpc toshi.workspace.v1.ModelCredentialService.ListModelCredentials
+     */
+    listModelCredentials: {
+        methodKind: "unary";
+        input: typeof ListModelCredentialsRequestSchema;
+        output: typeof ListModelCredentialsResponseSchema;
+    };
+    /**
+     * UpdateModelCredential sets the fields update_mask names: name, owner,
+     * or both. owner is the caller's user id, to make the credential the
+     * caller's own, or empty, to make it the workspace's; any other person
+     * is INVALID_ARGUMENT. Changing the owner moves the key to the matching
+     * keys of the same place, in one write. "*" and a path of any other
+     * field are INVALID_ARGUMENT.
+     *
+     * @generated from rpc toshi.workspace.v1.ModelCredentialService.UpdateModelCredential
+     */
+    updateModelCredential: {
+        methodKind: "unary";
+        input: typeof UpdateModelCredentialRequestSchema;
+        output: typeof UpdateModelCredentialResponseSchema;
+    };
+    /**
+     * DeleteModelCredential signs the credential out: it removes the
+     * credential and its key, with every version, in one write.
+     *
+     * @generated from rpc toshi.workspace.v1.ModelCredentialService.DeleteModelCredential
+     */
+    deleteModelCredential: {
+        methodKind: "unary";
+        input: typeof DeleteModelCredentialRequestSchema;
+        output: typeof DeleteModelCredentialResponseSchema;
+    };
+}>;