@toshicloud/sdk 0.5.1 → 0.7.0

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

@@ -432,6 +432,274 @@ export type GetWorkspaceStatementResponseJson = {
 export declare const GetWorkspaceStatementResponseSchema: GenMessage<GetWorkspaceStatementResponse, {
     jsonType: GetWorkspaceStatementResponseJson;
 }>;
+/**
+ * @generated from message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceRequest
+ */
+export type GetWorkspaceUpcomingInvoiceRequest = Message<"toshi.workspace.v1.GetWorkspaceUpcomingInvoiceRequest"> & {};
+/**
+ * @generated from message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceRequest
+ */
+export type GetWorkspaceUpcomingInvoiceRequestJson = {};
+/**
+ * Describes the message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceRequest.
+ * Use `create(GetWorkspaceUpcomingInvoiceRequestSchema)` to create a new message.
+ */
+export declare const GetWorkspaceUpcomingInvoiceRequestSchema: GenMessage<GetWorkspaceUpcomingInvoiceRequest, {
+    jsonType: GetWorkspaceUpcomingInvoiceRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceResponse
+ */
+export type GetWorkspaceUpcomingInvoiceResponse = Message<"toshi.workspace.v1.GetWorkspaceUpcomingInvoiceResponse"> & {
+    /**
+     * The billing provider's preview of the next invoice.
+     *
+     * @generated from field: toshi.workspace.v1.UpcomingInvoice invoice = 1;
+     */
+    invoice?: UpcomingInvoice | undefined;
+    /**
+     * The current UTC month's cost per project, highest cost so far first.
+     * The row with an empty project_id holds what no project accounts for.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProjectCost projects = 2;
+     */
+    projects: ProjectCost[];
+    /**
+     * The sums of the projects' month_so_far_cents and estimated_month_cents.
+     * month_so_far_cents equals the current month's statement estimated_cents.
+     *
+     * @generated from field: int64 month_so_far_cents = 3;
+     */
+    monthSoFarCents: bigint;
+    /**
+     * @generated from field: int64 estimated_month_cents = 4;
+     */
+    estimatedMonthCents: bigint;
+    /**
+     * The currency of the project costs, as the statement gives it; empty
+     * while no price is known.
+     *
+     * @generated from field: string currency = 5;
+     */
+    currency: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceResponse
+ */
+export type GetWorkspaceUpcomingInvoiceResponseJson = {
+    /**
+     * The billing provider's preview of the next invoice.
+     *
+     * @generated from field: toshi.workspace.v1.UpcomingInvoice invoice = 1;
+     */
+    invoice?: UpcomingInvoiceJson;
+    /**
+     * The current UTC month's cost per project, highest cost so far first.
+     * The row with an empty project_id holds what no project accounts for.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProjectCost projects = 2;
+     */
+    projects?: ProjectCostJson[];
+    /**
+     * The sums of the projects' month_so_far_cents and estimated_month_cents.
+     * month_so_far_cents equals the current month's statement estimated_cents.
+     *
+     * @generated from field: int64 month_so_far_cents = 3;
+     */
+    monthSoFarCents?: string;
+    /**
+     * @generated from field: int64 estimated_month_cents = 4;
+     */
+    estimatedMonthCents?: string;
+    /**
+     * The currency of the project costs, as the statement gives it; empty
+     * while no price is known.
+     *
+     * @generated from field: string currency = 5;
+     */
+    currency?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetWorkspaceUpcomingInvoiceResponse.
+ * Use `create(GetWorkspaceUpcomingInvoiceResponseSchema)` to create a new message.
+ */
+export declare const GetWorkspaceUpcomingInvoiceResponseSchema: GenMessage<GetWorkspaceUpcomingInvoiceResponse, {
+    jsonType: GetWorkspaceUpcomingInvoiceResponseJson;
+}>;
+/**
+ * UpcomingInvoice is the billing provider's preview of a workspace's next
+ * invoice.
+ *
+ * @generated from message toshi.workspace.v1.UpcomingInvoice
+ */
+export type UpcomingInvoice = Message<"toshi.workspace.v1.UpcomingInvoice"> & {
+    /**
+     * The amount due, in the currency's minor unit, after the customer
+     * balance (such as a starter credit) is applied.
+     *
+     * @generated from field: int64 amount_cents = 1;
+     */
+    amountCents: bigint;
+    /**
+     * The ISO currency code in lower case, such as "usd".
+     *
+     * @generated from field: string currency = 2;
+     */
+    currency: string;
+    /**
+     * The period the invoice covers.
+     *
+     * @generated from field: google.protobuf.Timestamp period_start = 3;
+     */
+    periodStart?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp period_end = 4;
+     */
+    periodEnd?: Timestamp | undefined;
+    /**
+     * When the usage behind this answer was read. Meter events reach the
+     * provider asynchronously, so the preview may not yet include usage
+     * read at this time.
+     *
+     * @generated from field: google.protobuf.Timestamp meters_read_at = 5;
+     */
+    metersReadAt?: Timestamp | undefined;
+    /**
+     * False when the workspace has no billing customer, or the provider has
+     * no upcoming invoice for it: the other fields are then empty.
+     *
+     * @generated from field: bool available = 6;
+     */
+    available: boolean;
+};
+/**
+ * UpcomingInvoice is the billing provider's preview of a workspace's next
+ * invoice.
+ *
+ * @generated from message toshi.workspace.v1.UpcomingInvoice
+ */
+export type UpcomingInvoiceJson = {
+    /**
+     * The amount due, in the currency's minor unit, after the customer
+     * balance (such as a starter credit) is applied.
+     *
+     * @generated from field: int64 amount_cents = 1;
+     */
+    amountCents?: string;
+    /**
+     * The ISO currency code in lower case, such as "usd".
+     *
+     * @generated from field: string currency = 2;
+     */
+    currency?: string;
+    /**
+     * The period the invoice covers.
+     *
+     * @generated from field: google.protobuf.Timestamp period_start = 3;
+     */
+    periodStart?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp period_end = 4;
+     */
+    periodEnd?: TimestampJson;
+    /**
+     * When the usage behind this answer was read. Meter events reach the
+     * provider asynchronously, so the preview may not yet include usage
+     * read at this time.
+     *
+     * @generated from field: google.protobuf.Timestamp meters_read_at = 5;
+     */
+    metersReadAt?: TimestampJson;
+    /**
+     * False when the workspace has no billing customer, or the provider has
+     * no upcoming invoice for it: the other fields are then empty.
+     *
+     * @generated from field: bool available = 6;
+     */
+    available?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpcomingInvoice.
+ * Use `create(UpcomingInvoiceSchema)` to create a new message.
+ */
+export declare const UpcomingInvoiceSchema: GenMessage<UpcomingInvoice, {
+    jsonType: UpcomingInvoiceJson;
+}>;
+/**
+ * ProjectCost is one project's cost in the current UTC month.
+ *
+ * @generated from message toshi.workspace.v1.ProjectCost
+ */
+export type ProjectCost = Message<"toshi.workspace.v1.ProjectCost"> & {
+    /**
+     * The project's id and name. An empty project_id is the cost no project
+     * accounts for: the own-host fee, storage, desktop seats, and minutes of
+     * jobs with no project, a deleted project, or that history retention
+     * already removed.
+     *
+     * @generated from field: string project_id = 1;
+     */
+    projectId: string;
+    /**
+     * @generated from field: string project_name = 2;
+     */
+    projectName: string;
+    /**
+     * The cost of the month so far, in the currency's minor unit.
+     *
+     * @generated from field: int64 month_so_far_cents = 3;
+     */
+    monthSoFarCents: bigint;
+    /**
+     * month_so_far_cents carried in a straight line to the month's end: so
+     * far times the month's length over the time elapsed. Desktop seats are
+     * a whole-month charge and are not carried forward.
+     *
+     * @generated from field: int64 estimated_month_cents = 4;
+     */
+    estimatedMonthCents: bigint;
+};
+/**
+ * ProjectCost is one project's cost in the current UTC month.
+ *
+ * @generated from message toshi.workspace.v1.ProjectCost
+ */
+export type ProjectCostJson = {
+    /**
+     * The project's id and name. An empty project_id is the cost no project
+     * accounts for: the own-host fee, storage, desktop seats, and minutes of
+     * jobs with no project, a deleted project, or that history retention
+     * already removed.
+     *
+     * @generated from field: string project_id = 1;
+     */
+    projectId?: string;
+    /**
+     * @generated from field: string project_name = 2;
+     */
+    projectName?: string;
+    /**
+     * The cost of the month so far, in the currency's minor unit.
+     *
+     * @generated from field: int64 month_so_far_cents = 3;
+     */
+    monthSoFarCents?: string;
+    /**
+     * month_so_far_cents carried in a straight line to the month's end: so
+     * far times the month's length over the time elapsed. Desktop seats are
+     * a whole-month charge and are not carried forward.
+     *
+     * @generated from field: int64 estimated_month_cents = 4;
+     */
+    estimatedMonthCents?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ProjectCost.
+ * Use `create(ProjectCostSchema)` to create a new message.
+ */
+export declare const ProjectCostSchema: GenMessage<ProjectCost, {
+    jsonType: ProjectCostJson;
+}>;
 /**
  * Seat is one assignment of a desktop seat to a person.
  *
@@ -1923,7 +2191,7 @@ export declare const WorkspaceSchema: GenMessage<Workspace, {
 /**
  * HostingCertificate is a workspace's wildcard certificate for its
  * services' provided names. Toshi orders it when the workspace first
- * hosts a service with an http channel and renews it before it expires.
+ * hosts a service with an http endpoint and renews it before it expires.
  *
  * @generated from message toshi.workspace.v1.HostingCertificate
  */
@@ -1968,7 +2236,7 @@ export type HostingCertificate = Message<"toshi.workspace.v1.HostingCertificate"
 /**
  * HostingCertificate is a workspace's wildcard certificate for its
  * services' provided names. Toshi orders it when the workspace first
- * hosts a service with an http channel and renews it before it expires.
+ * hosts a service with an http endpoint and renews it before it expires.
  *
  * @generated from message toshi.workspace.v1.HostingCertificate
  */
@@ -2796,6 +3064,13 @@ export type WorkspaceBilling_HeldJobs = Message<"toshi.workspace.v1.WorkspaceBil
      * @generated from field: google.protobuf.Timestamp since = 25;
      */
     since?: Timestamp | undefined;
+    /**
+     * For reason start_rate: the earliest time every start window of the
+     * workspace has room again. Unset otherwise.
+     *
+     * @generated from field: google.protobuf.Timestamp next_start_at = 26;
+     */
+    nextStartAt?: Timestamp | undefined;
 };
 /**
  * HeldJobs counts the jobs held now for one reason.
@@ -2819,6 +3094,13 @@ export type WorkspaceBilling_HeldJobsJson = {
      * @generated from field: google.protobuf.Timestamp since = 25;
      */
     since?: TimestampJson;
+    /**
+     * For reason start_rate: the earliest time every start window of the
+     * workspace has room again. Unset otherwise.
+     *
+     * @generated from field: google.protobuf.Timestamp next_start_at = 26;
+     */
+    nextStartAt?: TimestampJson;
 };
 /**
  * Describes the message toshi.workspace.v1.WorkspaceBilling.HeldJobs.
@@ -3163,6 +3445,13 @@ export type WorkspaceStatement = Message<"toshi.workspace.v1.WorkspaceStatement"
      * @generated from field: toshi.workspace.v1.DesktopSeats desktop_seats = 23;
      */
     desktopSeats?: DesktopSeats | undefined;
+    /**
+     * The month's paid starts; unset when there were none. Their cost is
+     * included in estimated_cents.
+     *
+     * @generated from field: toshi.workspace.v1.PaidStarts paid_starts = 24;
+     */
+    paidStarts?: PaidStarts | undefined;
 };
 /**
  * @generated from message toshi.workspace.v1.WorkspaceStatement
@@ -3316,6 +3605,13 @@ export type WorkspaceStatementJson = {
      * @generated from field: toshi.workspace.v1.DesktopSeats desktop_seats = 23;
      */
     desktopSeats?: DesktopSeatsJson;
+    /**
+     * The month's paid starts; unset when there were none. Their cost is
+     * included in estimated_cents.
+     *
+     * @generated from field: toshi.workspace.v1.PaidStarts paid_starts = 24;
+     */
+    paidStarts?: PaidStartsJson;
 };
 /**
  * Describes the message toshi.workspace.v1.WorkspaceStatement.
@@ -3415,6 +3711,55 @@ export type DesktopSeatsJson = {
 export declare const DesktopSeatsSchema: GenMessage<DesktopSeats, {
     jsonType: DesktopSeatsJson;
 }>;
+/**
+ * PaidStarts is the month's paid starts: the starts past the plan's included
+ * starts, within its ceiling, and what they cost.
+ *
+ * @generated from message toshi.workspace.v1.PaidStarts
+ */
+export type PaidStarts = Message<"toshi.workspace.v1.PaidStarts"> & {
+    /**
+     * The starts billed for the month.
+     *
+     * @generated from field: int64 count = 1;
+     */
+    count: bigint;
+    /**
+     * count at the plan's price today, in the smallest unit of currency;
+     * included in estimated_cents.
+     *
+     * @generated from field: int64 estimated_cents = 2;
+     */
+    estimatedCents: bigint;
+};
+/**
+ * PaidStarts is the month's paid starts: the starts past the plan's included
+ * starts, within its ceiling, and what they cost.
+ *
+ * @generated from message toshi.workspace.v1.PaidStarts
+ */
+export type PaidStartsJson = {
+    /**
+     * The starts billed for the month.
+     *
+     * @generated from field: int64 count = 1;
+     */
+    count?: string;
+    /**
+     * count at the plan's price today, in the smallest unit of currency;
+     * included in estimated_cents.
+     *
+     * @generated from field: int64 estimated_cents = 2;
+     */
+    estimatedCents?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.PaidStarts.
+ * Use `create(PaidStartsSchema)` to create a new message.
+ */
+export declare const PaidStartsSchema: GenMessage<PaidStarts, {
+    jsonType: PaidStartsJson;
+}>;
 /**
  * StatementSeat is one desktop seat on a statement.
  *
@@ -3782,8 +4127,8 @@ export declare const StorageSchema: GenMessage<Storage, {
     jsonType: StorageJson;
 }>;
 /**
- * StoredKind is one kind of stored data in a month: image, volume_version,
- * artifact or recording.
+ * StoredKind is one kind of stored data in a month: images, volume_versions,
+ * artifacts, recordings or held_disks.
  *
  * @generated from message toshi.workspace.v1.StoredKind
  */
@@ -3806,8 +4151,8 @@ export type StoredKind = Message<"toshi.workspace.v1.StoredKind"> & {
     gbHours: number;
 };
 /**
- * StoredKind is one kind of stored data in a month: image, volume_version,
- * artifact or recording.
+ * StoredKind is one kind of stored data in a month: images, volume_versions,
+ * artifacts, recordings or held_disks.
  *
  * @generated from message toshi.workspace.v1.StoredKind
  */
@@ -4054,16 +4399,26 @@ export type StatementCharge = Message<"toshi.workspace.v1.StatementCharge"> & {
      */
     size: string;
     /**
+     * The metered minutes of a size billed by the minute; 0 on a line of
+     * seconds.
+     *
      * @generated from field: int64 minutes = 2;
      */
     minutes: bigint;
     /**
      * The minutes at their recorded prices, or today's for minutes with none,
-     * rounded up.
+     * or the seconds at today's per-second price, rounded up.
      *
      * @generated from field: int64 estimated_cents = 3;
      */
     estimatedCents: bigint;
+    /**
+     * The billed running seconds of a size billed by the second, its
+     * month's seconds summed and rounded up once; 0 on a line of minutes.
+     *
+     * @generated from field: int64 seconds = 4;
+     */
+    seconds: bigint;
 };
 /**
  * @generated from message toshi.workspace.v1.StatementCharge
@@ -4077,16 +4432,26 @@ export type StatementChargeJson = {
      */
     size?: string;
     /**
+     * The metered minutes of a size billed by the minute; 0 on a line of
+     * seconds.
+     *
      * @generated from field: int64 minutes = 2;
      */
     minutes?: string;
     /**
      * The minutes at their recorded prices, or today's for minutes with none,
-     * rounded up.
+     * or the seconds at today's per-second price, rounded up.
      *
      * @generated from field: int64 estimated_cents = 3;
      */
     estimatedCents?: string;
+    /**
+     * The billed running seconds of a size billed by the second, its
+     * month's seconds summed and rounded up once; 0 on a line of minutes.
+     *
+     * @generated from field: int64 seconds = 4;
+     */
+    seconds?: string;
 };
 /**
  * Describes the message toshi.workspace.v1.StatementCharge.
@@ -5075,6 +5440,23 @@ export declare const WorkspaceService: GenService<{
         input: typeof GetWorkspaceStatementRequestSchema;
         output: typeof GetWorkspaceStatementResponseSchema;
     };
+    /**
+     * GetWorkspaceUpcomingInvoice returns the billing provider's preview of
+     * the workspace's next invoice, and the current UTC month's cost so far
+     * per project with a straight-line estimate to the month's end. The cost
+     * comes from the same usage and prices as GetWorkspaceStatement, and the
+     * projects' cost so far sums to its estimated_cents. Meter events reach
+     * the provider asynchronously, so the preview can lag the usage; the
+     * invoice is what is billed, and no estimate here changes it. A workspace
+     * with no billing customer gets a preview with available false.
+     *
+     * @generated from rpc toshi.workspace.v1.WorkspaceService.GetWorkspaceUpcomingInvoice
+     */
+    getWorkspaceUpcomingInvoice: {
+        methodKind: "unary";
+        input: typeof GetWorkspaceUpcomingInvoiceRequestSchema;
+        output: typeof GetWorkspaceUpcomingInvoiceResponseSchema;
+    };
     /**
      * ListSeats returns the desktop seats the workspace held in one UTC
      * month, oldest assigned first: the seats live at some time in it,