@origincloud/billing 0.26.0 → 0.28.0

package/dist/v1beta1/legal_document.js

@@ -0,0 +1,141 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/billing/v1beta1/legal_document.proto
+import { pathValue, query, } from "@origincloud/core";
+/**
+ * Calls LegalDocumentService.
+ *
+ * The legal documents Origin Cloud publishes: the Terms of Service, the Data
+ * Processing Agreement, the Service Level Agreement and the Acceptable Use
+ * Policy a customer accepts, and the documents published beside them. Every
+ * version stays readable under its fixed name once it is published, and none
+ * is ever changed: a correction is a new version.
+ *
+ * Every method of this service is answered without an access token.
+ */
+export class LegalDocumentClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    service;
+    /** A client of LegalDocumentService that sends its calls through `client`. */
+    constructor(client) {
+        this.service = client.service("billing", false);
+    }
+    /**
+     * Lists the published legal documents, in a fixed order: `terms`, `dpa`,
+     * `sla`, `aup`, `subprocessors`, `toms`, `privacy`, `switching`,
+     * `shared-responsibility`. A document with no published version yet is
+     * left out.
+     */
+    async listLegalDocuments(request, options) {
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/legalDocuments`,
+            query: query(request, []),
+            idempotent: true,
+            unauthenticated: true,
+        }, options);
+    }
+    /**
+     * Iterates over everything listLegalDocuments lists from the request's page on,
+     * fetching the next page as the loop reaches it. A page that fails ends
+     * the iteration with its error.
+     */
+    async *allLegalDocuments(request, options) {
+        for (let page = request;;) {
+            const response = await this.listLegalDocuments(page, options);
+            yield* response.legalDocuments ?? [];
+            if (!response.nextPageToken)
+                return;
+            page = { ...page, pageToken: response.nextPageToken };
+        }
+    }
+    /**
+     * Returns a legal document, with the version in force now and the latest
+     * one published. Fails with `NOT_FOUND` for a document with no published
+     * version.
+     */
+    async getLegalDocument(request, options) {
+        const p0 = pathValue("name", request.name, "legalDocuments/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+            unauthenticated: true,
+        }, options);
+    }
+    /** Lists a legal document's published versions, the latest first. */
+    async listLegalDocumentVersions(request, options) {
+        const p0 = pathValue("parent", request.parent, "legalDocuments/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}/versions`,
+            query: query(request, ["parent"]),
+            idempotent: true,
+            unauthenticated: true,
+        }, options);
+    }
+    /**
+     * Iterates over everything listLegalDocumentVersions lists from the request's page on,
+     * fetching the next page as the loop reaches it. A page that fails ends
+     * the iteration with its error.
+     */
+    async *allLegalDocumentVersions(request, options) {
+        for (let page = request;;) {
+            const response = await this.listLegalDocumentVersions(page, options);
+            yield* response.legalDocumentVersions ?? [];
+            if (!response.nextPageToken)
+                return;
+            page = { ...page, pageToken: response.nextPageToken };
+        }
+    }
+    /** Returns one published version of a legal document, its text included. */
+    async getLegalDocumentVersion(request, options) {
+        const p0 = pathValue("name", request.name, "legalDocuments/*/versions/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+            unauthenticated: true,
+        }, options);
+    }
+    /**
+     * Returns a published version as a PDF (`application/pdf`), the file
+     * itself rather than JSON. Every page's footer names the document, the
+     * version, the date it takes effect and its `sha256`.
+     *
+     * It answers with the file itself: its bytes, as they came, and their content type.
+     */
+    async downloadLegalDocumentVersion(request, options) {
+        const p0 = pathValue("name", request.name, "legalDocuments/*/versions/*");
+        return this.service.download({
+            method: "GET",
+            path: `/v1beta1/${p0}:download`,
+            query: query(request, ["name"]),
+            idempotent: true,
+            unauthenticated: true,
+        }, options);
+    }
+}
+/** What a version changes, and so what publishing it asks of a customer. */
+export const LegalDocumentVersion_ChangeClass = {
+    /** Not used. */
+    CHANGE_CLASS_UNSPECIFIED: "CHANGE_CLASS_UNSPECIFIED",
+    /**
+     * Changes rights or obligations. For a document customers accept, a
+     * customer accepts this version before it applies to them, and it is
+     * announced at least six weeks before it takes effect.
+     */
+    MATERIAL: "MATERIAL",
+    /**
+     * Announced ahead and never accepted, such as a new sub-processor,
+     * announced at least 30 days before it takes effect.
+     */
+    NOTICE: "NOTICE",
+    /** Wording, corrections and formatting. Asks nothing of anyone. */
+    EDITORIAL: "EDITORIAL",
+};
+//# sourceMappingURL=legal_document.js.map

package/dist/v1beta1/legal_document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legal_document.js","sourceRoot":"","sources":["../../src/v1beta1/legal_document.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,2DAA2D;AAE3D,OAAO,EAML,SAAS,EACT,KAAK,GACN,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;GAUG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;OAGG;IACM,OAAO,CAAU;IAE1B,8EAA8E;IAC9E,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAkC,EAAE,OAAqB;QAChF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB;YAC/B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACzB,UAAU,EAAE,IAAI;YAChB,eAAe,EAAE,IAAI;SACtB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,iBAAiB,CAAC,OAAkC,EAAE,OAAqB;QAChF,KAAK,IAAI,IAAI,GAAG,OAAO,IAAM,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC9D,KAAK,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,aAAa;gBAAE,OAAO;YACpC,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;QACxD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAgC,EAAE,OAAqB;QAC5E,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QAC/D,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;YAChB,eAAe,EAAE,IAAI;SACtB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,yBAAyB,CAAC,OAAyC,EAAE,OAAqB;QAC9F,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,WAAW;YAC/B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;YACjC,UAAU,EAAE,IAAI;YAChB,eAAe,EAAE,IAAI;SACtB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,wBAAwB,CAAC,OAAyC,EAAE,OAAqB;QAC9F,KAAK,IAAI,IAAI,GAAG,OAAO,IAAM,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACrE,KAAK,CAAC,CAAC,QAAQ,CAAC,qBAAqB,IAAI,EAAE,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,aAAa;gBAAE,OAAO;YACpC,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;QACxD,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,KAAK,CAAC,uBAAuB,CAAC,OAAuC,EAAE,OAAqB;QAC1F,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,6BAA6B,CAAC,CAAC;QAC1E,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;YAChB,eAAe,EAAE,IAAI;SACtB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,4BAA4B,CAAC,OAA4C,EAAE,OAAqB;QACpG,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,6BAA6B,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAC1B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,WAAW;YAC/B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;YAChB,eAAe,EAAE,IAAI;SACtB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAwFD,4EAA4E;AAC5E,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,gBAAgB;IAChB,wBAAwB,EAAE,0BAA0B;IACpD;;;;OAIG;IACH,QAAQ,EAAE,UAAU;IACpB;;;OAGG;IACH,MAAM,EAAE,QAAQ;IAChB,mEAAmE;IACnE,SAAS,EAAE,WAAW;CACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@origincloud/billing",
-  "version": "0.26.0",
+  "version": "0.28.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",
@@ -34,9 +34,9 @@
     "!dist/**/*.tsbuildinfo"
   ],
   "peerDependencies": {
-    "@origincloud/core": "^0.26.0"
+    "@origincloud/core": "^0.28.0"
   },
   "devDependencies": {
-    "@origincloud/core": "^0.26.0"
+    "@origincloud/core": "^0.28.0"
   }
 }

package/src/v1beta1/index.ts

@@ -2,5 +2,7 @@
 
 export * from "./billing_account.js";
 export * from "./cost.js";
+export * from "./legal_acceptance.js";
+export * from "./legal_document.js";
 export * from "./price_list.js";
 export * from "./spend_limit.js";

package/src/v1beta1/legal_acceptance.ts

@@ -0,0 +1,274 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/billing/v1beta1/legal_acceptance.proto
+
+import {
+  type CalendarDate,
+  type CallOptions,
+  type Client,
+  type Service,
+  pathValue,
+  query,
+} from "@origincloud/core";
+import type { BillingAddress } from "./billing_account.js";
+
+/**
+ * Calls LegalAcceptanceService.
+ *
+ * A billing account's acceptances of the legal documents customers accept:
+ * the Terms of Service, the Data Processing Agreement, the Service Level
+ * Agreement and the Acceptable Use Policy. The billing account is the legal
+ * entity that accepts. An acceptance is a record that never changes, and it
+ * is kept after the billing account and its organization are deleted.
+ */
+export class LegalAcceptanceClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of LegalAcceptanceService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("billing", false);
+  }
+
+  /**
+   * Lists a billing account's acceptances, the latest first. Needs
+   * `admin.billing_account.get` on the organization.
+   */
+  async listLegalAcceptances(request: ListLegalAcceptancesRequest, options?: CallOptions): Promise<ListLegalAcceptancesResponse> {
+    const p0 = pathValue("parent", request.parent, "organizations/*/billingAccounts/*");
+    return this.service.call<ListLegalAcceptancesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/legalAcceptances`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listLegalAcceptances lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allLegalAcceptances(request: ListLegalAcceptancesRequest, options?: CallOptions): AsyncGenerator<LegalAcceptance, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listLegalAcceptances(page, options);
+      yield* response.legalAcceptances ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Returns one of a billing account's acceptances. Needs
+   * `admin.billing_account.get` on the organization.
+   */
+  async getLegalAcceptance(request: GetLegalAcceptanceRequest, options?: CallOptions): Promise<LegalAcceptance> {
+    const p0 = pathValue("name", request.name, "organizations/*/billingAccounts/*/legalAcceptances/*");
+    return this.service.call<LegalAcceptance>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Accepts versions of legal documents for a billing account, all of them
+   * or none. Each version is named with the `sha256` of the text the caller
+   * showed, and must be the version in force or one published to take effect
+   * later. A version the account accepted before is returned as it was then.
+   * `actsAsBusiness` must be true: the services are offered to businesses
+   * only. Needs `admin.billing_account.update` on the organization.
+   */
+  async acceptLegalDocuments(request: AcceptLegalDocumentsRequest, options?: CallOptions): Promise<ListLegalAcceptancesResponse> {
+    const p0 = pathValue("name", request.name, "organizations/*/billingAccounts/*");
+    return this.service.call<ListLegalAcceptancesResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:acceptLegalDocuments`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Returns the legal document versions a billing account has yet to
+   * accept. A version is `blocking` once it is in force: until the account
+   * accepts it, creating or growing billable resources charged to the
+   * account is refused. Running resources are never affected. Needs
+   * `admin.billing_account.get` on the organization.
+   */
+  async queryLegalRequirements(request: QueryLegalRequirementsRequest, options?: CallOptions): Promise<QueryLegalRequirementsResponse> {
+    const p0 = pathValue("name", request.name, "organizations/*/billingAccounts/*");
+    return this.service.call<QueryLegalRequirementsResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}:queryLegalRequirements`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** A billing account's acceptance of one version of a legal document. */
+export interface LegalAcceptance {
+  /** The acceptance's resource name. */
+  name?: string;
+  /**
+   * The version accepted,
+   * `legalDocuments/{legal_document}/versions/{version}`.
+   */
+  legalDocumentVersion?: string;
+  /** The SHA-256 of the text accepted: the version's `sha256`. */
+  sha256?: string;
+  /**
+   * Who accepted: `user:{id}`, or `service_account:{id}` for a service
+   * account.
+   */
+  accepter?: string;
+  /** When the version was accepted. */
+  acceptTime?: string;
+  /** How the acceptance came about. */
+  method?: LegalAcceptance_Method;
+  /** Whether the accepter confirmed acting as a business. Always true. */
+  actsAsBusiness?: boolean;
+  /**
+   * The legal entity that accepted, as it was at `acceptTime`: the
+   * organization's name.
+   */
+  organizationDisplayName?: string;
+  /**
+   * The billing account's address at `acceptTime`; unset for an account
+   * that had none.
+   */
+  billingAddress?: BillingAddress;
+  /**
+   * The billing account's VAT identification number at `acceptTime`;
+   * empty when it had none.
+   */
+  vatId?: string;
+}
+
+/** How the acceptance came about. */
+export const LegalAcceptance_Method = {
+  /** Not used. */
+  METHOD_UNSPECIFIED: "METHOD_UNSPECIFIED",
+  /** When the organization or the billing account was created. */
+  SIGNUP: "SIGNUP",
+  /** A changed version of a document the account had accepted before. */
+  CHANGE: "CHANGE",
+  /**
+   * The first version of a document, by an account that existed before
+   * the document was published.
+   */
+  MIGRATION: "MIGRATION",
+} as const;
+
+/** How the acceptance came about. */
+export type LegalAcceptance_Method = (typeof LegalAcceptance_Method)[keyof typeof LegalAcceptance_Method];
+
+/** A legal document version a billing account has yet to accept. */
+export interface LegalRequirement {
+  /** The version, `legalDocuments/{legal_document}/versions/{version}`. */
+  legalDocumentVersion?: string;
+  /** The version's title, such as `Terms of Service`. */
+  displayName?: string;
+  /** The day the version takes effect. */
+  effectiveDate?: CalendarDate;
+  /** A plain-language summary of what changed. */
+  changeSummary?: string;
+  /** The version's `sha256`, to accept it by. */
+  sha256?: string;
+  /**
+   * In force already: until it is accepted, creating or growing billable
+   * resources charged to the account is refused.
+   */
+  blocking?: boolean;
+}
+
+/** A version to accept, with the text it was shown as. */
+export interface LegalDocumentVersionToAccept {
+  /** The version, `legalDocuments/{legal_document}/versions/{version}`. */
+  legalDocumentVersion?: string;
+  /**
+   * The version's `sha256`, as read with it: an acceptance is refused when
+   * the text shown isn't the version's.
+   */
+  sha256?: string;
+}
+
+/** The request for ListLegalAcceptances. */
+export interface ListLegalAcceptancesRequest {
+  /**
+   * The billing account,
+   * `organizations/{organization}/billingAccounts/{billing_account}`.
+   */
+  parent?: string;
+  /**
+   * The most acceptances to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+}
+
+/** The response for ListLegalAcceptances and AcceptLegalDocuments. */
+export interface ListLegalAcceptancesResponse {
+  /**
+   * The acceptances on this page; for AcceptLegalDocuments, one per version
+   * accepted, in the order requested.
+   */
+  legalAcceptances?: LegalAcceptance[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for GetLegalAcceptance. */
+export interface GetLegalAcceptanceRequest {
+  /** The acceptance to return. */
+  name?: string;
+}
+
+/** The request for AcceptLegalDocuments. */
+export interface AcceptLegalDocumentsRequest {
+  /**
+   * The billing account that accepts,
+   * `organizations/{organization}/billingAccounts/{billing_account}`.
+   */
+  name?: string;
+  /** The versions to accept. */
+  versions?: LegalDocumentVersionToAccept[];
+  /**
+   * That the caller acts as a business (§ 14 BGB) for the billing account's
+   * legal entity. Must be true.
+   */
+  actsAsBusiness?: boolean;
+}
+
+/** The request for QueryLegalRequirements. */
+export interface QueryLegalRequirementsRequest {
+  /**
+   * The billing account,
+   * `organizations/{organization}/billingAccounts/{billing_account}`.
+   */
+  name?: string;
+}
+
+/** The response for QueryLegalRequirements. */
+export interface QueryLegalRequirementsResponse {
+  /** The versions to accept, by document, then by the day they take effect. */
+  requirements?: LegalRequirement[];
+}