@distilled.cloud/stackit 0.0.0-placeholder → 1.0.0-rc.13

package/src/services/cost.ts

@@ -0,0 +1,484 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-stackit). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as C from "@distilled.cloud/core/category";
+import * as T from "../traits.ts";
+import {
+  StackitProtocol,
+  type StackitOpError,
+  type StackitOpContext,
+} from "../protocol.ts";
+import { UnknownStackitError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { StackitOpError, StackitOpContext };
+
+export class BadRequest
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<BadRequest>()("BadRequest", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 400 }],
+  ) {}
+
+export class Forbidden
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<Forbidden>()("Forbidden", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withAuthError),
+    [{ status: 403 }],
+  ) {}
+
+export class NotFound
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<NotFound>()("NotFound", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 404 }],
+  ) {}
+
+export type GetCostsForProjectRequestDepth = "project" | "service" | "auto";
+export const GetCostsForProjectRequestDepth = /*@__PURE__*/ S.String;
+
+export type GetCostsForProjectRequestGranularity =
+  | "daily"
+  | "weekly"
+  | "monthly"
+  | "yearly"
+  | "none";
+export const GetCostsForProjectRequestGranularity = /*@__PURE__*/ S.String;
+
+export interface GetCostsForProjectRequest {
+  /** ID of a customer account */
+  customerAccountId: string;
+  /** ID of a project */
+  projectId: string;
+  /** Inclusive start date of the selection range. Internally, usages are recorded in UTC. This means all usages starting on and after 00:00:00 UTC on the specified date are included. */
+  from: string;
+  /** Inclusive end date of the selection range. Internally, usages are recorded in UTC. This means all usages starting up to and including 23:59:59 UTC on the specified date are included. */
+  to: string;
+  /** Depth of desired cost information. "project" provides costs grouped by project, without services. "service" provides costs separated on service level. */
+  depth?: GetCostsForProjectRequestDepth | (string & {});
+  /** Define granularity of costs – Default is "none" which does NOT include detailed report data. If "monthly", "weekly" or "yearly" is requested, the "from" parameter SHOULD be the first day and the "to" parameter SHOULD be the last day of that time period. If not, they are normalized accordingly. If "daily" is requested, the date range defined by "from" and "to" MUST NOT be longer than 92 days. */
+  granularity?: GetCostsForProjectRequestGranularity | (string & {});
+  /** Whether costs of 0 should be included in the response */
+  includeZeroCosts?: boolean;
+}
+export const GetCostsForProjectRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String.pipe(T.Label()),
+    projectId: S.String.pipe(T.Label()),
+    from: S.String.pipe(T.Query()),
+    to: S.String.pipe(T.Query()),
+    depth: S.optional(GetCostsForProjectRequestDepth.pipe(T.Query())),
+    granularity: S.optional(
+      GetCostsForProjectRequestGranularity.pipe(T.Query()),
+    ),
+    includeZeroCosts: S.optional(S.Boolean.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v3/costs/{customerAccountId}/projects/{projectId}",
+      code: 200,
+      baseUrl: "https://cost.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetCostsForProjectRequest",
+}) as any as S.Schema<GetCostsForProjectRequest>;
+
+/** Summarized costs for a project */
+export interface SummarizedProjectCost {
+  customerAccountId: string;
+  projectId: string;
+  projectName: string;
+  /** Total charge (including discounts) for all services and the whole requested date range (value in cents) */
+  totalCharge: number;
+  /** Total discount for all services and the whole requested date range (value in cents) */
+  totalDiscount: number;
+}
+export const SummarizedProjectCost = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String,
+    projectId: S.String,
+    projectName: S.String,
+    totalCharge: S.Number,
+    totalDiscount: S.Number,
+  }),
+).annotate({
+  identifier: "SummarizedProjectCost",
+}) as any as S.Schema<SummarizedProjectCost>;
+
+/** Time period according to desired granularity */
+export interface ReportDataTimePeriod {
+  end?: string;
+  start?: string;
+}
+export const ReportDataTimePeriod = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    end: S.optional(S.String),
+    start: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ReportDataTimePeriod",
+}) as any as S.Schema<ReportDataTimePeriod>;
+
+/** Costs report for a certain period of time */
+export interface ReportData {
+  /** Charge, value in cents */
+  charge: number;
+  /** Discount, value in cents */
+  discount: number;
+  /** Quantity */
+  quantity: number;
+  /** Quantity in decimal format, returned as string to preserve precision. NOTE: This field will be removed in future versions and `totalQuantity` will become a decimal. */
+  quantityDecimal: string;
+  /** Time period according to desired granularity */
+  timePeriod: ReportDataTimePeriod;
+}
+export const ReportData = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    charge: S.Number,
+    discount: S.Number,
+    quantity: S.Number,
+    quantityDecimal: S.String,
+    timePeriod: ReportDataTimePeriod,
+  }),
+).annotate({ identifier: "ReportData" }) as any as S.Schema<ReportData>;
+
+/** Detailed project costs which are ONLY included if granularity is provided AND depth is "project" */
+export type ProjectCostWithReportsReportDataList = Array<ReportData>;
+export const ProjectCostWithReportsReportDataList = /*@__PURE__*/ S.Array(
+  ReportData,
+) as any as S.Schema<ProjectCostWithReportsReportDataList>;
+
+/** Detailed costs for a project */
+export interface ProjectCostWithReports {
+  customerAccountId: string;
+  projectId: string;
+  projectName: string;
+  /** Detailed project costs which are ONLY included if granularity is provided AND depth is "project" */
+  reportData?: ProjectCostWithReportsReportDataList;
+  /** Total charge (including discounts) for all services and the whole requested date range (value in cents) */
+  totalCharge: number;
+  /** Total discount for all services and the whole requested date range (value in cents) */
+  totalDiscount: number;
+}
+export const ProjectCostWithReports = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String,
+    projectId: S.String,
+    projectName: S.String,
+    reportData: S.optional(ProjectCostWithReportsReportDataList),
+    totalCharge: S.Number,
+    totalDiscount: S.Number,
+  }),
+).annotate({
+  identifier: "ProjectCostWithReports",
+}) as any as S.Schema<ProjectCostWithReports>;
+
+/** Summarized costs for a project */
+export type SummarizedServiceCost = SummarizedProjectCost;
+export const SummarizedServiceCost = SummarizedProjectCost;
+
+/** Summarized service costs */
+export type ProjectCostWithSummarizedServicesServicesList =
+  Array<SummarizedProjectCost>;
+export const ProjectCostWithSummarizedServicesServicesList =
+  /*@__PURE__*/ S.Array(
+    SummarizedProjectCost,
+  ) as any as S.Schema<ProjectCostWithSummarizedServicesServicesList>;
+
+/** Costs for a project including summarized service costs */
+export interface ProjectCostWithSummarizedServices {
+  customerAccountId: string;
+  projectId: string;
+  projectName: string;
+  /** Summarized service costs */
+  services?: ProjectCostWithSummarizedServicesServicesList;
+  /** Total charge (including discounts) for all services and the whole requested date range (value in cents) */
+  totalCharge: number;
+  /** Total discount for all services and the whole requested date range (value in cents) */
+  totalDiscount: number;
+}
+export const ProjectCostWithSummarizedServices = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String,
+    projectId: S.String,
+    projectName: S.String,
+    services: S.optional(ProjectCostWithSummarizedServicesServicesList),
+    totalCharge: S.Number,
+    totalDiscount: S.Number,
+  }),
+).annotate({
+  identifier: "ProjectCostWithSummarizedServices",
+}) as any as S.Schema<ProjectCostWithSummarizedServices>;
+
+/** Detailed service costs which are ONLY included if granularity is provided */
+export type DetailedServiceCostReportDataList = Array<ReportData>;
+export const DetailedServiceCostReportDataList = /*@__PURE__*/ S.Array(
+  ReportData,
+) as any as S.Schema<DetailedServiceCostReportDataList>;
+
+/** Costs for a single service */
+export interface DetailedServiceCost {
+  /** Detailed service costs which are ONLY included if granularity is provided */
+  reportData?: DetailedServiceCostReportDataList;
+  /** Service category name */
+  serviceCategoryName: string;
+  /** Name of the service */
+  serviceName: string;
+  /** Service key */
+  sku: string;
+  /** Total charge (including discounts) for all services and the whole requested date range (value in cents) */
+  totalCharge: number;
+  /** Total discount for all services and the whole requested date range (value in cents) */
+  totalDiscount: number;
+  /** Total quantity */
+  totalQuantity: number;
+  /** Total quantity in decimal format, returned as string to preserve precision. NOTE: This field will be removed in future versions and `totalQuantity` will become a decimal. */
+  totalQuantityDecimal: string;
+  /** Label for unit */
+  unitLabel: string;
+}
+export const DetailedServiceCost = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    reportData: S.optional(DetailedServiceCostReportDataList),
+    serviceCategoryName: S.String,
+    serviceName: S.String,
+    sku: S.String,
+    totalCharge: S.Number,
+    totalDiscount: S.Number,
+    totalQuantity: S.Number,
+    totalQuantityDecimal: S.String,
+    unitLabel: S.String,
+  }),
+).annotate({
+  identifier: "DetailedServiceCost",
+}) as any as S.Schema<DetailedServiceCost>;
+
+/** Total discount for all services and the whole requested date range (value in cents). Please see "depth" parameter for more details. */
+export type ProjectCostWithDetailedServicesServicesList =
+  Array<DetailedServiceCost>;
+export const ProjectCostWithDetailedServicesServicesList =
+  /*@__PURE__*/ S.Array(
+    DetailedServiceCost,
+  ) as any as S.Schema<ProjectCostWithDetailedServicesServicesList>;
+
+/** Detailed costs for a project including service costs */
+export interface ProjectCostWithDetailedServices {
+  customerAccountId: string;
+  projectId: string;
+  projectName: string;
+  /** Total discount for all services and the whole requested date range (value in cents). Please see "depth" parameter for more details. */
+  services?: ProjectCostWithDetailedServicesServicesList;
+  /** Total charge (including discounts) for all services and the whole requested date range (value in cents) */
+  totalCharge: number;
+  /** Total discount for all services and the whole requested date range (value in cents) */
+  totalDiscount: number;
+}
+export const ProjectCostWithDetailedServices = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String,
+    projectId: S.String,
+    projectName: S.String,
+    services: S.optional(ProjectCostWithDetailedServicesServicesList),
+    totalCharge: S.Number,
+    totalDiscount: S.Number,
+  }),
+).annotate({
+  identifier: "ProjectCostWithDetailedServices",
+}) as any as S.Schema<ProjectCostWithDetailedServices>;
+
+export type ProjectCost =
+  | SummarizedProjectCost
+  | ProjectCostWithReports
+  | ProjectCostWithSummarizedServices
+  | ProjectCostWithDetailedServices;
+export const ProjectCost =
+  /*@__PURE__*/ S.Unknown as any as S.Schema<ProjectCost>;
+
+export type GetCostsForProjectResponse = ProjectCost;
+export const GetCostsForProjectResponse = /*@__PURE__*/ S.suspend(() =>
+  ProjectCost.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "GetCostsForProjectResponse",
+}) as any as S.Schema<GetCostsForProjectResponse>;
+
+export type ListCostsForCustomerRequestDepth = "project" | "service" | "auto";
+export const ListCostsForCustomerRequestDepth = /*@__PURE__*/ S.String;
+
+export type ListCostsForCustomerRequestGranularity =
+  | "daily"
+  | "weekly"
+  | "monthly"
+  | "yearly"
+  | "none";
+export const ListCostsForCustomerRequestGranularity = /*@__PURE__*/ S.String;
+
+export interface ListCostsForCustomerRequest {
+  /** ID of a customer account */
+  customerAccountId: string;
+  /** Inclusive start date of the selection range. Internally, usages are recorded in UTC. This means all usages starting on and after 00:00:00 UTC on the specified date are included. */
+  from: string;
+  /** Inclusive end date of the selection range. Internally, usages are recorded in UTC. This means all usages starting up to and including 23:59:59 UTC on the specified date are included. */
+  to: string;
+  /** Depth of desired cost information. "project" provides costs grouped by project, without services. "service" provides costs separated on service level. */
+  depth?: ListCostsForCustomerRequestDepth | (string & {});
+  /** Define granularity of costs – Default is "none" which does NOT include detailed report data. If "monthly", "weekly" or "yearly" is requested, the "from" parameter SHOULD be the first day and the "to" parameter SHOULD be the last day of that time period. If not, they are normalized accordingly. If "daily" is requested, the date range defined by "from" and "to" MUST NOT be longer than 92 days. */
+  granularity?: ListCostsForCustomerRequestGranularity | (string & {});
+  /** Whether costs of 0 should be included in the response */
+  includeZeroCosts?: boolean;
+}
+export const ListCostsForCustomerRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String.pipe(T.Label()),
+    from: S.String.pipe(T.Query()),
+    to: S.String.pipe(T.Query()),
+    depth: S.optional(ListCostsForCustomerRequestDepth.pipe(T.Query())),
+    granularity: S.optional(
+      ListCostsForCustomerRequestGranularity.pipe(T.Query()),
+    ),
+    includeZeroCosts: S.optional(S.Boolean.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v3/costs/{customerAccountId}",
+      code: 200,
+      baseUrl: "https://cost.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "ListCostsForCustomerRequest",
+}) as any as S.Schema<ListCostsForCustomerRequest>;
+
+export type ListCostsForCustomerResponseBodyList = Array<ProjectCost>;
+export const ListCostsForCustomerResponseBodyList = /*@__PURE__*/ S.Array(
+  ProjectCost,
+) as any as S.Schema<ListCostsForCustomerResponseBodyList>;
+
+export type ListCostsForCustomerResponse = ListCostsForCustomerResponseBodyList;
+export const ListCostsForCustomerResponse = /*@__PURE__*/ S.suspend(() =>
+  ListCostsForCustomerResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListCostsForCustomerResponse",
+}) as any as S.Schema<ListCostsForCustomerResponse>;
+
+export type ListCostsForResellerRequestDepth = "project" | "service" | "auto";
+export const ListCostsForResellerRequestDepth = /*@__PURE__*/ S.String;
+
+export type ListCostsForResellerRequestGranularity =
+  | "daily"
+  | "weekly"
+  | "monthly"
+  | "yearly"
+  | "none";
+export const ListCostsForResellerRequestGranularity = /*@__PURE__*/ S.String;
+
+export interface ListCostsForResellerRequest {
+  /** ID of a customer account */
+  customerAccountId: string;
+  /** Inclusive start date of the selection range. Internally, usages are recorded in UTC. This means all usages starting on and after 00:00:00 UTC on the specified date are included. */
+  from: string;
+  /** Inclusive end date of the selection range. Internally, usages are recorded in UTC. This means all usages starting up to and including 23:59:59 UTC on the specified date are included. */
+  to: string;
+  /** Depth of desired cost information. "project" provides costs grouped by project, without services. "service" provides costs separated on service level. */
+  depth?: ListCostsForResellerRequestDepth | (string & {});
+  /** Define granularity of costs – Default is "none" which does NOT include detailed report data. If "monthly", "weekly" or "yearly" is requested, the "from" parameter SHOULD be the first day and the "to" parameter SHOULD be the last day of that time period. If not, they are normalized accordingly. If "daily" is requested, the date range defined by "from" and "to" MUST NOT be longer than 92 days. */
+  granularity?: ListCostsForResellerRequestGranularity | (string & {});
+  /** Whether costs of 0 should be included in the response */
+  includeZeroCosts?: boolean;
+}
+export const ListCostsForResellerRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    customerAccountId: S.String.pipe(T.Label()),
+    from: S.String.pipe(T.Query()),
+    to: S.String.pipe(T.Query()),
+    depth: S.optional(ListCostsForResellerRequestDepth.pipe(T.Query())),
+    granularity: S.optional(
+      ListCostsForResellerRequestGranularity.pipe(T.Query()),
+    ),
+    includeZeroCosts: S.optional(S.Boolean.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v3/costs/{customerAccountId}/customers",
+      code: 200,
+      baseUrl: "https://cost.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "ListCostsForResellerRequest",
+}) as any as S.Schema<ListCostsForResellerRequest>;
+
+export type ListCostsForResellerResponseBodyList = Array<ProjectCost>;
+export const ListCostsForResellerResponseBodyList = /*@__PURE__*/ S.Array(
+  ProjectCost,
+) as any as S.Schema<ListCostsForResellerResponseBodyList>;
+
+export type ListCostsForResellerResponse = ListCostsForResellerResponseBodyList;
+export const ListCostsForResellerResponse = /*@__PURE__*/ S.suspend(() =>
+  ListCostsForResellerResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListCostsForResellerResponse",
+}) as any as S.Schema<ListCostsForResellerResponse>;
+
+export type GetCostsForProjectError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** V3 Costs for a certain project Get costs for a certain project in a customer account */
+export const getCostsForProject: API.OperationMethod<
+  GetCostsForProjectRequest,
+  GetCostsForProjectResponse,
+  GetCostsForProjectError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetCostsForProjectRequest,
+  output: GetCostsForProjectResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListCostsForCustomerError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** V3 Costs for all projects Get costs for all projects in a customer account */
+export const listCostsForCustomer: API.OperationMethod<
+  ListCostsForCustomerRequest,
+  ListCostsForCustomerResponse,
+  ListCostsForCustomerError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListCostsForCustomerRequest,
+  output: ListCostsForCustomerResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListCostsForResellerError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** V3 Costs for all projects of all related sub-customers Get costs for all projects of all related sub-customer accounts */
+export const listCostsForReseller: API.OperationMethod<
+  ListCostsForResellerRequest,
+  ListCostsForResellerResponse,
+  ListCostsForResellerError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListCostsForResellerRequest,
+  output: ListCostsForResellerResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));