fix(api): Update zone subscription paths

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1749
+configured_endpoints: 1752
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-b15b44e0efd207de48e7e74e742b0b4b190c74f12a941a1a0ef59a51656a5224.yml
 openapi_spec_hash: 83243c9ee06f88d0fa91e9b185d8a42e
-config_hash: f3028048c6dc3559115fdd749755dee2
+config_hash: 8601d43fd5ccaf9e3d08f26748a5a63a

api.md

@@ -392,6 +392,12 @@ Methods:
 
 ## Subscriptions
 
+Methods:
+
+- <code title="post /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">create</a>({ ...params }) -> Subscription</code>
+- <code title="put /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">update</a>({ ...params }) -> Subscription</code>
+- <code title="get /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">get</a>({ ...params }) -> Subscription</code>
+
 ## Plans
 
 Types:

src/resources/zones/index.ts

@@ -91,5 +91,10 @@ export {
   type SettingEditParams,
   type SettingGetParams,
 } from './settings';
-export { Subscriptions } from './subscriptions';
+export {
+  Subscriptions,
+  type SubscriptionCreateParams,
+  type SubscriptionUpdateParams,
+  type SubscriptionGetParams,
+} from './subscriptions';
 export { Zones } from './zones';

src/resources/zones/subscriptions.ts

@@ -1,5 +1,121 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as Shared from '../shared';
 
-export class Subscriptions extends APIResource {}
+export class Subscriptions extends APIResource {
+  /**
+   * Create a zone subscription, either plan or add-ons.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.zones.subscriptions.create({
+   *     zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   *   });
+   * ```
+   */
+  create(
+    params: SubscriptionCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Subscription> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.post(`/zones/${zone_id}/subscription`, { body, ...options }) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Updates zone subscriptions, either plan or add-ons.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.zones.subscriptions.update({
+   *     zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   *   });
+   * ```
+   */
+  update(
+    params: SubscriptionUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Subscription> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.put(`/zones/${zone_id}/subscription`, { body, ...options }) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Lists zone subscription details.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.zones.subscriptions.get({
+   *   zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+   * });
+   * ```
+   */
+  get(params: SubscriptionGetParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Subscription> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/subscription`, options) as Core.APIPromise<{
+        result: Shared.Subscription;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface SubscriptionCreateParams {
+  /**
+   * Path param: Subscription identifier tag.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: How often the subscription is renewed automatically.
+   */
+  frequency?: 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+  /**
+   * Body param: The rate plan applied to the subscription.
+   */
+  rate_plan?: Shared.RatePlanParam;
+}
+
+export interface SubscriptionUpdateParams {
+  /**
+   * Path param: Subscription identifier tag.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: How often the subscription is renewed automatically.
+   */
+  frequency?: 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+  /**
+   * Body param: The rate plan applied to the subscription.
+   */
+  rate_plan?: Shared.RatePlanParam;
+}
+
+export interface SubscriptionGetParams {
+  /**
+   * Subscription identifier tag.
+   */
+  zone_id: string;
+}
+
+export declare namespace Subscriptions {
+  export {
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionUpdateParams as SubscriptionUpdateParams,
+    type SubscriptionGetParams as SubscriptionGetParams,
+  };
+}

src/resources/zones/zones.ts

@@ -94,7 +94,12 @@ import {
   ZeroRTT,
 } from './settings';
 import * as SubscriptionsAPI from './subscriptions';
-import { Subscriptions } from './subscriptions';
+import {
+  SubscriptionCreateParams,
+  SubscriptionGetParams,
+  SubscriptionUpdateParams,
+  Subscriptions,
+} from './subscriptions';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Zones extends APIResource {
@@ -745,7 +750,12 @@ export declare namespace Zones {
     type HoldGetParams as HoldGetParams,
   };
 
-  export { Subscriptions as Subscriptions };
+  export {
+    Subscriptions as Subscriptions,
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionUpdateParams as SubscriptionUpdateParams,
+    type SubscriptionGetParams as SubscriptionGetParams,
+  };
 
   export {
     Plans as Plans,

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

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import Cloudflare from 'cloudflare';
+import { Response } from 'node-fetch';
+
+const client = new Cloudflare({
+  apiKey: '144c9defac04969c7bfad8efaa8ea194',
+  apiEmail: '[email protected]',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource subscriptions', () => {
+  test('create: only required params', async () => {
+    const responsePromise = client.zones.subscriptions.create({
+      zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('create: required and optional params', async () => {
+    const response = await client.zones.subscriptions.create({
+      zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+      frequency: 'monthly',
+      rate_plan: {
+        id: 'free',
+        currency: 'USD',
+        externally_managed: false,
+        is_contract: false,
+        public_name: 'Business Plan',
+        scope: 'zone',
+        sets: ['string'],
+      },
+    });
+  });
+
+  test('update: only required params', async () => {
+    const responsePromise = client.zones.subscriptions.update({
+      zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('update: required and optional params', async () => {
+    const response = await client.zones.subscriptions.update({
+      zone_id: '506e3185e9c882d175a2d0cb0093d9f2',
+      frequency: 'monthly',
+      rate_plan: {
+        id: 'free',
+        currency: 'USD',
+        externally_managed: false,
+        is_contract: false,
+        public_name: 'Business Plan',
+        scope: 'zone',
+        sets: ['string'],
+      },
+    });
+  });
+
+  test('get: only required params', async () => {
+    const responsePromise = client.zones.subscriptions.get({ zone_id: '506e3185e9c882d175a2d0cb0093d9f2' });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('get: required and optional params', async () => {
+    const response = await client.zones.subscriptions.get({ zone_id: '506e3185e9c882d175a2d0cb0093d9f2' });
+  });
+});