[trafficcontrol-trafficops-types] 04/10: Add ACME generation request structure, deprecate LetsEncrypt

[oc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ocket8888 pushed a commit to branch 4.x
in repository https://gitbox.apache.org/repos/asf/trafficcontrol-trafficops-types.git

commit 1644fc327debc227068b5083e038e824be2bfb47
Author: ocket8888 <oc...@apache.org>
AuthorDate: Wed Nov 23 19:47:59 2022 -0700

    Add ACME generation request structure, deprecate LetsEncrypt
---
 src/ssl.ts | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/src/ssl.ts b/src/ssl.ts
index 2cc9717..ce287ac 100644
--- a/src/ssl.ts
+++ b/src/ssl.ts
@@ -75,6 +75,9 @@ export interface DeliveryServiceSSLKeyGenerationRequest {
  * Represents a request to have Traffic Ops generate an SSL Key/Certificate pair
  * for a Delivery Service using LetsEncrypt (or another configured ACME
  * service).
+ *
+ * @deprecated This has been superseded by the more general
+ * {@link ACMEDeliveryServiceSSLKeyGenerationRequest}.
  */
 export interface LetsEncryptDeliveryServiceSSLKeyGenerationRequest {
 	cdn: string;
@@ -84,6 +87,40 @@ export interface LetsEncryptDeliveryServiceSSLKeyGenerationRequest {
 	version: string;
 }
 
+/**
+ * Represents a request to have Traffic Ops request an SSL Key/Certificate pair
+ * for a Delivery Service from an ACME provider.
+ */
+export interface ACMEDeliveryServiceSSLKeyGenerationRequest{
+	/**
+	 * The certificate provider correlating to an ACME account in cdn.conf or
+	 * Let’s Encrypt.
+	 */
+	authType: string;
+	/**
+	 * The XMLID of the Delivery Service for which keys will be generated.
+	 *
+	 * Either the `key` or the `deliveryservice` field must be provided. If both
+	 * are provided, then they must match.
+	 */
+	key?: string | null | undefined;
+	/**
+	 * The XMLID of the Delivery Service for which keys will be generated.
+	 *
+	 * Either the `key` or the `deliveryservice` field must be provided. If both
+	 * are provided, then they must match.
+	 */
+	deliveryservice?: string | null | undefined;
+	/**
+	 * An integer that defines the "version" of the key - which may be thought
+	 * of as the sequential generation; that is, the higher the number the more
+	 * recent the key.
+	 */
+	version: string;
+	/** The desired hostname of the Delivery Service. */
+	hostname: string;
+}
+
 /**
  * Represents a Delivery Service's SSL Key/Certificate pair as presented by
  * Traffic Ops in responses.