@origincloud/billing 0.0.0-stage → 0.12.0

package/dist/v1beta1/price_list.d.ts

@@ -0,0 +1,93 @@
+import { type CallOptions, type Client, type Service } from "@origincloud/core";
+/**
+ * Calls PriceListService.
+ *
+ * The public price list: the list price of every billable product, for
+ * anyone to read, websites included. It needs no access token.
+ *
+ * Unlike the rest of this API, its path has been `/v1/pricing` since before
+ * the API was published, and its fields are written in snake case, as
+ * websites read them.
+ */
+export declare class PriceListClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    readonly service: Service;
+    /** A client of PriceListService that sends its calls through `client`. */
+    constructor(client: Client);
+    /**
+     * Returns the prices in effect now. The answer carries an `ETag`; a
+     * request that sends it back in `If-None-Match` is answered
+     * `304 Not Modified`, without a body, while the list is unchanged.
+     */
+    getPriceList(request: GetPriceListRequest, options?: CallOptions): Promise<PriceList>;
+}
+/**
+ * The price list. Every amount is in EUR, before VAT, which depends on the
+ * customer's country and is added on the invoice.
+ */
+export interface PriceList {
+    /** Always `EUR`. */
+    currency?: string;
+    /** Always true: every amount is net, before VAT. */
+    amounts_exclude_vat?: boolean;
+    /**
+     * When a list price was last set, changed, took effect or ended: what a
+     * "prices last updated" line shows. Unset only while nothing is priced.
+     */
+    last_changed?: string;
+    /**
+     * One entry per product family with a price in effect, in the platform's
+     * catalog order: `compute_instance`, `network_floating_ip`,
+     * `network_nat_gateway`, `network_vpc_egress`, `network_vpc_ingress`,
+     * `network_vpc_internal`, `storage_volume`, `storage_snapshot`,
+     * `observability_custom_metric`, `observability_api_request`,
+     * `observability_ingested_sample`.
+     */
+    families?: PriceFamily[];
+}
+/** One product family's prices. */
+export interface PriceFamily {
+    /** The family, such as `compute_instance`. */
+    family?: string;
+    /**
+     * The family's prices in effect, by product key, numbers compared as
+     * numbers: a class's instance types run from smallest to largest.
+     */
+    prices?: Price[];
+}
+/** The list price of one product. */
+export interface Price {
+    /**
+     * The product the price bills, as usage and cost reports name it, such
+     * as `compute.gp1.core.2`, `storage.gp1` or `network.vpc_egress`.
+     */
+    product_key?: string;
+    /**
+     * The parts of the product key, split out: `instanceType` for an instance,
+     * `storageClass` for a volume. Empty for a product that has none.
+     */
+    dimensions?: Record<string, string>;
+    /**
+     * What is counted: `seconds`, `gib_hours`, `gb` (decimal, 10^9 bytes),
+     * `metric_months`, `requests` or `samples`.
+     */
+    unit_type?: string;
+    /**
+     * How many of the unit the amount pays for: `3600` seconds is an
+     * hourly rate, `1000` requests a rate per thousand.
+     */
+    unit_count?: number;
+    /** The price of that many units, as a decimal string. */
+    amount?: string;
+    /** When the price took effect. */
+    valid_from?: string;
+    /** When the price is to end; unset while no end is scheduled. */
+    valid_until?: string;
+}
+/** The request for GetPriceList, which takes nothing. */
+export interface GetPriceListRequest {
+}
+//# sourceMappingURL=price_list.d.ts.map

package/dist/v1beta1/price_list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_list.d.ts","sourceRoot":"","sources":["../../src/v1beta1/price_list.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAS,MAAM,mBAAmB,CAAC;AAEvF;;;;;;;;;GASG;AACH,qBAAa,eAAe;IAC1B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,0EAA0E;gBAC9D,MAAM,EAAE,MAAM;IAI1B;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAW5F;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED,mCAAmC;AACnC,MAAM,WAAW,WAAW;IAC1B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,KAAK;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yDAAyD;AACzD,MAAM,WAAW,mBAAmB;CAAG"}

package/dist/v1beta1/price_list.js

@@ -0,0 +1,38 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/billing/v1beta1/price_list.proto
+import { query } from "@origincloud/core";
+/**
+ * Calls PriceListService.
+ *
+ * The public price list: the list price of every billable product, for
+ * anyone to read, websites included. It needs no access token.
+ *
+ * Unlike the rest of this API, its path has been `/v1/pricing` since before
+ * the API was published, and its fields are written in snake case, as
+ * websites read them.
+ */
+export class PriceListClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    service;
+    /** A client of PriceListService that sends its calls through `client`. */
+    constructor(client) {
+        this.service = client.service("billing", false);
+    }
+    /**
+     * Returns the prices in effect now. The answer carries an `ETag`; a
+     * request that sends it back in `If-None-Match` is answered
+     * `304 Not Modified`, without a body, while the list is unchanged.
+     */
+    async getPriceList(request, options) {
+        return this.service.call({
+            method: "GET",
+            path: `/v1/pricing`,
+            query: query(request, []),
+            idempotent: true,
+        }, options);
+    }
+}
+//# sourceMappingURL=price_list.js.map

package/dist/v1beta1/price_list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_list.js","sourceRoot":"","sources":["../../src/v1beta1/price_list.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,uDAAuD;AAEvD,OAAO,EAA+C,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAEvF;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAe;IAC1B;;;OAGG;IACM,OAAO,CAAU;IAE1B,0EAA0E;IAC1E,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAA4B,EAAE,OAAqB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACzB,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/dist/v1beta1/spend_limit.d.ts

@@ -0,0 +1,78 @@
+import { type CallOptions, type Client, type Service } from "@origincloud/core";
+/**
+ * Calls SpendLimitService.
+ *
+ * Spend limits: an amount per calendar month for a billing account, and the
+ * shares of it at which an alert is emailed. A spend limit only alerts: it
+ * never stops or refuses anything.
+ *
+ * Access to spend limits is granted apart from access to billing accounts:
+ * an organization's owner holds it by default.
+ */
+export declare class SpendLimitClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    readonly service: Service;
+    /** A client of SpendLimitService that sends its calls through `client`. */
+    constructor(client: Client);
+    /**
+     * Returns a billing account's spend limit; one that has none has no
+     * `limit`. Needs `admin.spend_limit.get` on the organization.
+     */
+    getSpendLimit(request: GetSpendLimitRequest, options?: CallOptions): Promise<SpendLimit>;
+    /**
+     * Sets or removes a billing account's spend limit. The fields named in
+     * `updateMask` are replaced and the others kept. A spend limit left
+     * without a `limit` is removed, with its thresholds and recipients. Needs
+     * `admin.spend_limit.update` on the organization.
+     */
+    updateSpendLimit(request: UpdateSpendLimitRequest, options?: CallOptions): Promise<SpendLimit>;
+}
+/**
+ * A billing account's spend limit: the most it means to spend in a calendar
+ * month, and when to be told. Each threshold alerts once a month, the first
+ * time the month's spend crosses it.
+ */
+export interface SpendLimit {
+    /**
+     * The spend limit's resource name,
+     * `organizations/{organization}/billingAccounts/{billing_account}/spendLimit`.
+     */
+    name?: string;
+    /**
+     * The amount per calendar month in EUR, before VAT, as a decimal string
+     * such as `500.00`; more than zero. Unset means no spend limit.
+     */
+    limit?: string;
+    /**
+     * The percentages of `limit` whose crossing emails an alert, such as `80`
+     * and `100`; each from 1 to 32767, so a threshold can lie beyond the
+     * limit. Empty while there is no `limit`.
+     */
+    alertThresholdsPercent?: number[];
+    /**
+     * Where alerts are sent. Empty while there is no `limit`, and an alert
+     * with no recipient is sent to nobody.
+     */
+    notificationEmails?: string[];
+    /** When the spend limit was last set; unset while there is none. */
+    updateTime?: string;
+}
+/** The request for GetSpendLimit. */
+export interface GetSpendLimitRequest {
+    /** The spend limit to return. */
+    name?: string;
+}
+/** The request for UpdateSpendLimit. */
+export interface UpdateSpendLimitRequest {
+    /** The spend limit, by its name, with the fields to change. */
+    spendLimit?: SpendLimit;
+    /**
+     * The fields to change: `limit`, `alertThresholdsPercent` and
+     * `notificationEmails`. `*` is every one of them.
+     */
+    updateMask?: string;
+}
+//# sourceMappingURL=spend_limit.d.ts.map

package/dist/v1beta1/spend_limit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend_limit.d.ts","sourceRoot":"","sources":["../../src/v1beta1/spend_limit.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAoB,MAAM,mBAAmB,CAAC;AAElG;;;;;;;;;GASG;AACH,qBAAa,gBAAgB;IAC3B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,2EAA2E;gBAC/D,MAAM,EAAE,MAAM;IAI1B;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAa9F;;;;;OAKG;IACG,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;CAYrG;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qCAAqC;AACrC,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wCAAwC;AACxC,MAAM,WAAW,uBAAuB;IACtC,+DAA+D;IAC/D,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/v1beta1/spend_limit.js

@@ -0,0 +1,53 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/billing/v1beta1/spend_limit.proto
+import { pathValue, query } from "@origincloud/core";
+/**
+ * Calls SpendLimitService.
+ *
+ * Spend limits: an amount per calendar month for a billing account, and the
+ * shares of it at which an alert is emailed. A spend limit only alerts: it
+ * never stops or refuses anything.
+ *
+ * Access to spend limits is granted apart from access to billing accounts:
+ * an organization's owner holds it by default.
+ */
+export class SpendLimitClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    service;
+    /** A client of SpendLimitService that sends its calls through `client`. */
+    constructor(client) {
+        this.service = client.service("billing", false);
+    }
+    /**
+     * Returns a billing account's spend limit; one that has none has no
+     * `limit`. Needs `admin.spend_limit.get` on the organization.
+     */
+    async getSpendLimit(request, options) {
+        const p0 = pathValue("name", request.name, "organizations/*/billingAccounts/*/spendLimit");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+        }, options);
+    }
+    /**
+     * Sets or removes a billing account's spend limit. The fields named in
+     * `updateMask` are replaced and the others kept. A spend limit left
+     * without a `limit` is removed, with its thresholds and recipients. Needs
+     * `admin.spend_limit.update` on the organization.
+     */
+    async updateSpendLimit(request, options) {
+        const p0 = pathValue("spendLimit.name", request.spendLimit?.name, "organizations/*/billingAccounts/*/spendLimit");
+        return this.service.call({
+            method: "PATCH",
+            path: `/v1beta1/${p0}`,
+            body: request.spendLimit,
+            query: query(request, ["spendLimit.name", "spendLimit"]),
+        }, options);
+    }
+}
+//# sourceMappingURL=spend_limit.js.map

package/dist/v1beta1/spend_limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend_limit.js","sourceRoot":"","sources":["../../src/v1beta1/spend_limit.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,wDAAwD;AAExD,OAAO,EAA+C,SAAS,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAElG;;;;;;;;;GASG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;;OAGG;IACM,OAAO,CAAU;IAE1B,2EAA2E;IAC3E,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,OAA6B,EAAE,OAAqB;QACtE,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,8CAA8C,CAAC,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAgC,EAAE,OAAqB;QAC5E,MAAM,EAAE,GAAG,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,8CAA8C,CAAC,CAAC;QAClH,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,IAAI,EAAE,OAAO,CAAC,UAAU;YACxB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;SACzD,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@origincloud/billing",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.12.0",
+  "description": "Origin Cloud's billing service: billing accounts and the projects they pay for, payment methods, cost and usage, spend limits and the price list.",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/origincloudhq/sdk-typescript#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/origincloudhq/sdk-typescript.git",
+    "directory": "packages/billing"
+  },
+  "bugs": "https://github.com/origincloudhq/sdk-typescript/issues",
+  "keywords": [
+    "origincloud",
+    "origin-cloud",
+    "sdk",
+    "billing"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    "./*": {
+      "types": "./dist/*/index.d.ts",
+      "default": "./dist/*/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "@origincloud/core": "^0.12.0"
+  },
+  "devDependencies": {
+    "@origincloud/core": "^0.12.0"
+  }
+}