cloudflare 4.4.0 → 4.4.1

package/src/core.ts

@@ -171,6 +171,7 @@ export class APIPromise<T> extends Promise<T> {
 export abstract class APIClient {
   baseURL: string;
   apiVersion: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -181,6 +182,7 @@ export abstract class APIClient {
   constructor({
     baseURL,
     apiVersion,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
@@ -188,6 +190,7 @@ export abstract class APIClient {
   }: {
     baseURL: string;
     apiVersion: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
@@ -195,6 +198,7 @@ export abstract class APIClient {
   }) {
     this.baseURL = baseURL;
     this.apiVersion = apiVersion;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -305,7 +309,7 @@ export abstract class APIClient {
     { retryCount = 0 }: { retryCount?: number } = {},
   ): { req: RequestInit; url: string; timeout: number } {
     const options = { ...inputOptions };
-    const { method, path, query, headers: headers = {} } = options;
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -315,7 +319,7 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
@@ -508,11 +512,12 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
     if (!isEmptyObj(defaultQuery)) {
@@ -801,6 +806,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -824,6 +830,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,

package/src/index.ts

@@ -246,6 +246,7 @@ export class Cloudflare extends Core.APIClient {
     super({
       baseURL: options.baseURL!,
       apiVersion: options.apiVersion!,
+      baseURLOverridden: baseURL ? baseURL !== 'https://api.cloudflare.com/client/v4' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -356,6 +357,13 @@ export class Cloudflare extends Core.APIClient {
   pipelines: API.Pipelines = new API.Pipelines(this);
   schemaValidation: API.SchemaValidation = new API.SchemaValidation(this);
 
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://api.cloudflare.com/client/v4';
+  }
+
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }

package/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';

package/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,
+  };
+}

package/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,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.4.0'; // x-release-please-version
+export const VERSION = '4.4.1'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.4.0";
+export declare const VERSION = "4.4.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.4.0'; // x-release-please-version
+exports.VERSION = '4.4.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.4.0'; // x-release-please-version
+export const VERSION = '4.4.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map