@origincloud/billing 0.26.0 → 0.28.0

package/src/v1beta1/legal_document.ts

@@ -0,0 +1,325 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/billing/v1beta1/legal_document.proto
+
+import {
+  type CalendarDate,
+  type CallOptions,
+  type Client,
+  type HttpBody,
+  type Service,
+  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.
+   */
+  readonly service: Service;
+
+  /** A client of LegalDocumentService that sends its calls through `client`. */
+  constructor(client: 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: ListLegalDocumentsRequest, options?: CallOptions): Promise<ListLegalDocumentsResponse> {
+    return this.service.call<ListLegalDocumentsResponse>(
+      {
+        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: ListLegalDocumentsRequest, options?: CallOptions): AsyncGenerator<LegalDocument, void, undefined> {
+    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: GetLegalDocumentRequest, options?: CallOptions): Promise<LegalDocument> {
+    const p0 = pathValue("name", request.name, "legalDocuments/*");
+    return this.service.call<LegalDocument>(
+      {
+        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: ListLegalDocumentVersionsRequest, options?: CallOptions): Promise<ListLegalDocumentVersionsResponse> {
+    const p0 = pathValue("parent", request.parent, "legalDocuments/*");
+    return this.service.call<ListLegalDocumentVersionsResponse>(
+      {
+        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: ListLegalDocumentVersionsRequest, options?: CallOptions): AsyncGenerator<LegalDocumentVersion, void, undefined> {
+    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: GetLegalDocumentVersionRequest, options?: CallOptions): Promise<LegalDocumentVersion> {
+    const p0 = pathValue("name", request.name, "legalDocuments/*/versions/*");
+    return this.service.call<LegalDocumentVersion>(
+      {
+        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: DownloadLegalDocumentVersionRequest, options?: CallOptions): Promise<HttpBody> {
+    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,
+    );
+  }
+}
+
+/**
+ * A legal document: every version of one kind of document, such as the Terms
+ * of Service.
+ */
+export interface LegalDocument {
+  /**
+   * The document's resource name, `legalDocuments/{legal_document}`, where
+   * `{legal_document}` is one of `terms`, `dpa`, `sla`, `aup`,
+   * `subprocessors`, `toms`, `privacy`, `switching` and
+   * `shared-responsibility`.
+   */
+  name?: string;
+  /**
+   * The document's title, as its latest version names it, such as `Terms of
+   * Service`.
+   */
+  displayName?: string;
+  /**
+   * Whether a customer accepts this document. A `MATERIAL` version of one
+   * that is accepted needs a new acceptance; the other documents are
+   * published only.
+   */
+  acceptanceRequired?: boolean;
+  /**
+   * The version in force today, by its resource name. Empty while the first
+   * version has not taken effect yet.
+   */
+  currentVersion?: string;
+  /**
+   * The latest version published, by its resource name: `currentVersion`,
+   * or a version announced to take effect later.
+   */
+  latestVersion?: string;
+}
+
+/**
+ * One published version of a legal document. It never changes once
+ * published.
+ */
+export interface LegalDocumentVersion {
+  /**
+   * The version's resource name,
+   * `legalDocuments/{legal_document}/versions/{version}`, where `{version}`
+   * is `YYYY-MM`, or `YYYY-MM-2`, `YYYY-MM-3` and so on for another version
+   * in the same month.
+   */
+  name?: string;
+  /** The version's title, such as `Terms of Service`. */
+  displayName?: string;
+  /**
+   * The day the version takes effect. It applies from that day until the
+   * next version of the document takes effect.
+   */
+  effectiveDate?: CalendarDate;
+  /** What the version changes. */
+  changeClass?: LegalDocumentVersion_ChangeClass;
+  /**
+   * A plain-language summary of what changed, as the acceptance dialog and
+   * the announcement show it.
+   */
+  changeSummary?: string;
+  /**
+   * The SHA-256 of `markdown`, in lowercase hexadecimal: what identifies the
+   * version, and what an acceptance of it records.
+   */
+  sha256?: string;
+  /**
+   * The version's source, Markdown with its YAML front matter, exactly as
+   * `sha256` is computed over it.
+   */
+  markdown?: string;
+  /**
+   * The version's text as an HTML fragment, without its title: safe to embed
+   * as it is. A reference to another legal document links the version of it
+   * in force on `effectiveDate`.
+   */
+  html?: string;
+  /**
+   * Where the version is published on the web, under a URL that never
+   * changes, such as `https://origincloud.eu/legal/terms/2026-12`.
+   */
+  uri?: string;
+  /** Where the version's PDF is downloaded from (DownloadLegalDocumentVersion). */
+  pdfUri?: string;
+}
+
+/** 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",
+} as const;
+
+/** What a version changes, and so what publishing it asks of a customer. */
+export type LegalDocumentVersion_ChangeClass = (typeof LegalDocumentVersion_ChangeClass)[keyof typeof LegalDocumentVersion_ChangeClass];
+
+/** The request for ListLegalDocuments. */
+export interface ListLegalDocumentsRequest {
+  /**
+   * The most documents 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 ListLegalDocuments. */
+export interface ListLegalDocumentsResponse {
+  /** The documents on this page. */
+  legalDocuments?: LegalDocument[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for GetLegalDocument. */
+export interface GetLegalDocumentRequest {
+  /** The document to return, `legalDocuments/{legal_document}`. */
+  name?: string;
+}
+
+/** The request for ListLegalDocumentVersions. */
+export interface ListLegalDocumentVersionsRequest {
+  /** The document whose versions to list, `legalDocuments/{legal_document}`. */
+  parent?: string;
+  /**
+   * The most versions 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 ListLegalDocumentVersions. */
+export interface ListLegalDocumentVersionsResponse {
+  /** The versions on this page. */
+  legalDocumentVersions?: LegalDocumentVersion[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for GetLegalDocumentVersion. */
+export interface GetLegalDocumentVersionRequest {
+  /**
+   * The version to return,
+   * `legalDocuments/{legal_document}/versions/{version}`.
+   */
+  name?: string;
+}
+
+/** The request for DownloadLegalDocumentVersion. */
+export interface DownloadLegalDocumentVersionRequest {
+  /**
+   * The version to download,
+   * `legalDocuments/{legal_document}/versions/{version}`.
+   */
+  name?: string;
+}