oci-dns 2.95.1 → 2.96.0

package/lib/client.d.ts

@@ -968,6 +968,39 @@ export declare class DnsClient {
        * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dns/PatchZoneRecords.ts.html |here} to see how to use PatchZoneRecords API.
        */
     patchZoneRecords(patchZoneRecordsRequest: requests.PatchZoneRecordsRequest): Promise<responses.PatchZoneRecordsResponse>;
+    /**
+       * Promotes a specified `DnssecKeyVersion` on the zone.
+  * <p>
+  If the `DnssecKeyVersion` identified in the request body is a key signing key (KSK) that is replacing
+  * another `DnssecKeyVersion`, then the old `DnssecKeyVersion` is scheduled for removal from the zone.
+  * <p>
+  For key signing keys (KSKs), you must create the DS record with the new key information **before** promoting
+  * the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon
+  * as its TTL (time to live) expires.
+  * <p>
+  For more information, see [DNSSEC](https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm).
+  *
+       * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+       * @param PromoteZoneDnssecKeyVersionRequest
+       * @return PromoteZoneDnssecKeyVersionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dns/PromoteZoneDnssecKeyVersion.ts.html |here} to see how to use PromoteZoneDnssecKeyVersion API.
+       */
+    promoteZoneDnssecKeyVersion(promoteZoneDnssecKeyVersionRequest: requests.PromoteZoneDnssecKeyVersionRequest): Promise<responses.PromoteZoneDnssecKeyVersionResponse>;
+    /**
+       * Stages a new `DnssecKeyVersion` on the zone. Staging is a process that generates a new \"successor\" key version
+  * that replaces an existing \"predecessor\" key version.
+  * **Note:** A new key-signing key (KSK) version is inert until you update the parent zone DS records.
+  * <p>
+  For more information, see the [DNSSEC](https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm) documentation.
+  *
+       * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+       * @param StageZoneDnssecKeyVersionRequest
+       * @return StageZoneDnssecKeyVersionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dns/StageZoneDnssecKeyVersion.ts.html |here} to see how to use StageZoneDnssecKeyVersion API.
+       */
+    stageZoneDnssecKeyVersion(stageZoneDnssecKeyVersionRequest: requests.StageZoneDnssecKeyVersionRequest): Promise<responses.StageZoneDnssecKeyVersionResponse>;
     /**
        * Replaces records in the specified zone at a domain with the records specified in the request body.
   * <p>

package/lib/client.js

@@ -318,6 +318,11 @@ class DnsClient {
                             value: response.headers.get("opc-request-id"),
                             key: "opcRequestId",
                             dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
                         }
                     ]
                 });
@@ -667,6 +672,11 @@ class DnsClient {
                             value: response.headers.get("opc-request-id"),
                             key: "opcRequestId",
                             dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
                         }
                     ]
                 });
@@ -743,6 +753,11 @@ class DnsClient {
                             value: response.headers.get("opc-request-id"),
                             key: "opcRequestId",
                             dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
                         }
                     ]
                 });
@@ -1315,6 +1330,11 @@ class DnsClient {
                             value: response.headers.get("opc-request-id"),
                             key: "opcRequestId",
                             dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
                         }
                     ]
                 });
@@ -1375,6 +1395,11 @@ class DnsClient {
                             value: response.headers.get("opc-request-id"),
                             key: "opcRequestId",
                             dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
                         }
                     ]
                 });
@@ -3387,7 +3412,8 @@ class DnsClient {
                 "sortOrder": listZonesRequest.sortOrder,
                 "scope": listZonesRequest.scope,
                 "viewId": listZonesRequest.viewId,
-                "tsigKeyId": listZonesRequest.tsigKeyId
+                "tsigKeyId": listZonesRequest.tsigKeyId,
+                "dnssecState": listZonesRequest.dnssecState
             };
             let headerParams = {
                 "Content-Type": common.Constants.APPLICATION_JSON,
@@ -3738,6 +3764,151 @@ class DnsClient {
             }
         });
     }
+    /**
+       * Promotes a specified `DnssecKeyVersion` on the zone.
+  * <p>
+  If the `DnssecKeyVersion` identified in the request body is a key signing key (KSK) that is replacing
+  * another `DnssecKeyVersion`, then the old `DnssecKeyVersion` is scheduled for removal from the zone.
+  * <p>
+  For key signing keys (KSKs), you must create the DS record with the new key information **before** promoting
+  * the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon
+  * as its TTL (time to live) expires.
+  * <p>
+  For more information, see [DNSSEC](https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm).
+  *
+       * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+       * @param PromoteZoneDnssecKeyVersionRequest
+       * @return PromoteZoneDnssecKeyVersionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dns/PromoteZoneDnssecKeyVersion.ts.html |here} to see how to use PromoteZoneDnssecKeyVersion API.
+       */
+    promoteZoneDnssecKeyVersion(promoteZoneDnssecKeyVersionRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DnsClient#promoteZoneDnssecKeyVersion.");
+            const operationName = "promoteZoneDnssecKeyVersion";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/dns/20180115/Zone/PromoteZoneDnssecKeyVersion";
+            const pathParams = {
+                "{zoneId}": promoteZoneDnssecKeyVersionRequest.zoneId
+            };
+            const queryParams = {
+                "scope": promoteZoneDnssecKeyVersionRequest.scope
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "If-Match": promoteZoneDnssecKeyVersionRequest.ifMatch,
+                "If-Unmodified-Since": promoteZoneDnssecKeyVersionRequest.ifUnmodifiedSince,
+                "opc-retry-token": promoteZoneDnssecKeyVersionRequest.opcRetryToken,
+                "opc-request-id": promoteZoneDnssecKeyVersionRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, promoteZoneDnssecKeyVersionRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/zones/{zoneId}/actions/promoteDnssecKeyVersion",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(promoteZoneDnssecKeyVersionRequest.promoteZoneDnssecKeyVersionDetails, "PromoteZoneDnssecKeyVersionDetails", model.PromoteZoneDnssecKeyVersionDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+       * Stages a new `DnssecKeyVersion` on the zone. Staging is a process that generates a new \"successor\" key version
+  * that replaces an existing \"predecessor\" key version.
+  * **Note:** A new key-signing key (KSK) version is inert until you update the parent zone DS records.
+  * <p>
+  For more information, see the [DNSSEC](https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm) documentation.
+  *
+       * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+       * @param StageZoneDnssecKeyVersionRequest
+       * @return StageZoneDnssecKeyVersionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dns/StageZoneDnssecKeyVersion.ts.html |here} to see how to use StageZoneDnssecKeyVersion API.
+       */
+    stageZoneDnssecKeyVersion(stageZoneDnssecKeyVersionRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DnsClient#stageZoneDnssecKeyVersion.");
+            const operationName = "stageZoneDnssecKeyVersion";
+            const apiReferenceLink = "https://docs.oracle.com/iaas/api/#/en/dns/20180115/Zone/StageZoneDnssecKeyVersion";
+            const pathParams = {
+                "{zoneId}": stageZoneDnssecKeyVersionRequest.zoneId
+            };
+            const queryParams = {
+                "scope": stageZoneDnssecKeyVersionRequest.scope
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "If-Match": stageZoneDnssecKeyVersionRequest.ifMatch,
+                "If-Unmodified-Since": stageZoneDnssecKeyVersionRequest.ifUnmodifiedSince,
+                "opc-retry-token": stageZoneDnssecKeyVersionRequest.opcRetryToken,
+                "opc-request-id": stageZoneDnssecKeyVersionRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, stageZoneDnssecKeyVersionRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/zones/{zoneId}/actions/stageDnssecKeyVersion",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(stageZoneDnssecKeyVersionRequest.stageZoneDnssecKeyVersionDetails, "StageZoneDnssecKeyVersionDetails", model.StageZoneDnssecKeyVersionDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
        * Replaces records in the specified zone at a domain with the records specified in the request body.
   * <p>
@@ -4115,6 +4286,11 @@ class DnsClient {
                             key: "opcRequestId",
                             dataType: "string"
                         },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
                         {
                             value: response.headers.get("ETag"),
                             key: "eTag",
@@ -4184,6 +4360,11 @@ class DnsClient {
                             key: "opcRequestId",
                             dataType: "string"
                         },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
                         {
                             value: response.headers.get("ETag"),
                             key: "eTag",