feat(api): Add PATCH zone hold update method (#2240)

api.md

@@ -376,8 +376,8 @@ Types:
 Methods:
 
 - <code title="post /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">create</a>({ ...params }) -> ZoneHold</code>
+- <code title="patch /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">update</a>({ ...params }) -> ZoneHold</code>
 - <code title="delete /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">delete</a>({ ...params }) -> ZoneHold</code>
-- <code title="patch /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">edit</a>({ ...params }) -> ZoneHold</code>
 - <code title="get /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">get</a>({ ...params }) -> ZoneHold</code>
 
 ## Subscriptions

src/resources/zones/holds.ts

@@ -18,6 +18,19 @@ export class Holds extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Update the `hold_after` and/or `include_subdomains` values on an existing zone
+   * hold. The hold is enabled if the `hold_after` date-time value is in the past.
+   */
+  update(params: HoldUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ZoneHold> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.patch(`/zones/${zone_id}/hold`, { body, ...options }) as Core.APIPromise<{
+        result: ZoneHold;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Stop enforcement of a zone hold on the zone, permanently or temporarily,
    * allowing the creation and activation of zones with this zone's hostname.
@@ -32,19 +45,6 @@ export class Holds extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
-  /**
-   * Update the `hold_after` and/or `include_subdomains` values on an existing zone
-   * hold. The hold is enabled if the `hold_after` date-time value is in the past.
-   */
-  edit(params: HoldEditParams, options?: Core.RequestOptions): Core.APIPromise<ZoneHold> {
-    const { zone_id, ...body } = params;
-    return (
-      this._client.patch(`/zones/${zone_id}/hold`, { body, ...options }) as Core.APIPromise<{
-        result: ZoneHold;
-      }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-
   /**
    * Retrieve whether the zone is subject to a zone hold, and metadata about the
    * hold.
@@ -80,21 +80,7 @@ export interface HoldCreateParams {
   include_subdomains?: boolean;
 }
 
-export interface HoldDeleteParams {
-  /**
-   * Path param: Identifier
-   */
-  zone_id: string;
-
-  /**
-   * Query param: If `hold_after` is provided, the hold will be temporarily disabled,
-   * then automatically re-enabled by the system at the time specified in this
-   * RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely.
-   */
-  hold_after?: string;
-}
-
-export interface HoldEditParams {
+export interface HoldUpdateParams {
   /**
    * Path param: Identifier
    */
@@ -118,6 +104,20 @@ export interface HoldEditParams {
   include_subdomains?: boolean;
 }
 
+export interface HoldDeleteParams {
+  /**
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Query param: If `hold_after` is provided, the hold will be temporarily disabled,
+   * then automatically re-enabled by the system at the time specified in this
+   * RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely.
+   */
+  hold_after?: string;
+}
+
 export interface HoldGetParams {
   /**
    * Identifier
@@ -129,8 +129,8 @@ export declare namespace Holds {
   export {
     type ZoneHold as ZoneHold,
     type HoldCreateParams as HoldCreateParams,
+    type HoldUpdateParams as HoldUpdateParams,
     type HoldDeleteParams as HoldDeleteParams,
-    type HoldEditParams as HoldEditParams,
     type HoldGetParams as HoldGetParams,
   };
 }

src/resources/zones/index.ts

@@ -23,8 +23,8 @@ export {
   Holds,
   type ZoneHold,
   type HoldCreateParams,
+  type HoldUpdateParams,
   type HoldDeleteParams,
-  type HoldEditParams,
   type HoldGetParams,
 } from './holds';
 export { RatePlans, type RatePlanGetResponse, type RatePlanGetParams } from './rate-plans';

src/resources/zones/zones.ts

@@ -18,7 +18,14 @@ import {
   CustomNameservers,
 } from './custom-nameservers';
 import * as HoldsAPI from './holds';
-import { HoldCreateParams, HoldDeleteParams, HoldEditParams, HoldGetParams, Holds, ZoneHold } from './holds';
+import {
+  HoldCreateParams,
+  HoldDeleteParams,
+  HoldGetParams,
+  HoldUpdateParams,
+  Holds,
+  ZoneHold,
+} from './holds';
 import * as PlansAPI from './plans';
 import {
   AvailableRatePlan,
@@ -566,8 +573,8 @@ export declare namespace Zones {
     Holds as Holds,
     type ZoneHold as ZoneHold,
     type HoldCreateParams as HoldCreateParams,
+    type HoldUpdateParams as HoldUpdateParams,
     type HoldDeleteParams as HoldDeleteParams,
-    type HoldEditParams as HoldEditParams,
     type HoldGetParams as HoldGetParams,
   };
 

tests/api-resources/zones/holds.test.ts

@@ -28,8 +28,8 @@ describe('resource holds', () => {
     });
   });
 
-  test('delete: only required params', async () => {
-    const responsePromise = client.zones.holds.delete({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });
+  test('update: only required params', async () => {
+    const responsePromise = client.zones.holds.update({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -39,15 +39,16 @@ describe('resource holds', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('delete: required and optional params', async () => {
-    const response = await client.zones.holds.delete({
+  test('update: required and optional params', async () => {
+    const response = await client.zones.holds.update({
       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-      hold_after: 'hold_after',
+      hold_after: '2023-01-31T15:56:36+00:00',
+      include_subdomains: true,
     });
   });
 
-  test('edit: only required params', async () => {
-    const responsePromise = client.zones.holds.edit({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });
+  test('delete: only required params', async () => {
+    const responsePromise = client.zones.holds.delete({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -57,11 +58,10 @@ describe('resource holds', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('edit: required and optional params', async () => {
-    const response = await client.zones.holds.edit({
+  test('delete: required and optional params', async () => {
+    const response = await client.zones.holds.delete({
       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-      hold_after: '2023-01-31T15:56:36+00:00',
-      include_subdomains: true,
+      hold_after: 'hold_after',
     });
   });