cloudflare 3.1.0 → 3.2.0

package/src/resources/shared.ts

@@ -5,6 +5,8 @@ import { SinglePage, V4PagePaginationArray } from "../pagination";
 
 export type ASN = number;
 
+export type ASNParam = number;
+
 export interface AuditLog {
   /**
    * A string that uniquely identifies the audit log.
@@ -102,6 +104,28 @@ export namespace AuditLog {
   }
 }
 
+/**
+ * The Certificate Authority that will issue the certificate
+ */
+export type CertificateCA = 'digicert' | 'google' | 'lets_encrypt';
+
+/**
+ * The Certificate Authority that will issue the certificate
+ */
+export type CertificateCAParam = 'digicert' | 'google' | 'lets_encrypt';
+
+/**
+ * Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
+ * or "keyless-certificate" (for Keyless SSL servers).
+ */
+export type CertificateRequestType = 'origin-rsa' | 'origin-ecc' | 'keyless-certificate';
+
+/**
+ * Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
+ * or "keyless-certificate" (for Keyless SSL servers).
+ */
+export type CertificateRequestTypeParam = 'origin-rsa' | 'origin-ecc' | 'keyless-certificate';
+
 /**
  * A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
  */
@@ -366,6 +390,12 @@ export interface PermissionGrant {
   write?: boolean;
 }
 
+export interface PermissionGrantParam {
+  read?: boolean;
+
+  write?: boolean;
+}
+
 export interface ResponseInfo {
   code: number;
 
@@ -421,6 +451,16 @@ export interface Role {
   permissions: Array<Permission>;
 }
 
+/**
+ * Direction to order DNS records in.
+ */
+export type SortDirection = 'asc' | 'desc';
+
+/**
+ * Direction to order DNS records in.
+ */
+export type SortDirectionParam = 'asc' | 'desc';
+
 export class RolesSinglePage extends SinglePage<Role> {}
 
 export class AuditLogsV4PagePaginationArray extends V4PagePaginationArray<AuditLog> {}

package/src/resources/snippets/content.ts

@@ -3,15 +3,32 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import { type Response } from "../../_shims/index";
+import * as ContentAPI from "./content";
 
 export class Content extends APIResource {
   /**
    * Snippet Content
    */
-  get(zoneIdentifier: string, snippetName: string, options?: Core.RequestOptions): Core.APIPromise<Response> {
-    return this._client.get(`/zones/${zoneIdentifier}/snippets/${snippetName}/content`, {
+  get(
+    snippetName: string,
+    params: ContentGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Response> {
+    const { zone_id } = params;
+    return this._client.get(`/zones/${zone_id}/snippets/${snippetName}/content`, {
       ...options,
       __binaryResponse: true,
     });
   }
 }
+
+export interface ContentGetParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
+export namespace Content {
+  export import ContentGetParams = ContentAPI.ContentGetParams;
+}

package/src/resources/snippets/index.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Content } from './content';
+export { ContentGetParams, Content } from './content';
 export {
   RuleUpdateResponse,
   RuleListResponse,
   RuleUpdateParams,
+  RuleListParams,
   RuleListResponsesSinglePage,
   Rules,
 } from './rules';

package/src/resources/snippets/rules.ts

@@ -2,7 +2,6 @@
 
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
 import * as RulesAPI from "./rules";
 import { SinglePage } from "../../pagination";
 
@@ -10,25 +9,12 @@ export class Rules extends APIResource {
   /**
    * Put Rules
    */
-  update(
-    zoneIdentifier: string,
-    body?: RuleUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleUpdateResponse>;
-  update(zoneIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
-  update(
-    zoneIdentifier: string,
-    body: RuleUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleUpdateResponse> {
-    if (isRequestOptions(body)) {
-      return this.update(zoneIdentifier, {}, body);
-    }
+  update(params: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse> {
+    const { zone_id, ...body } = params;
     return (
-      this._client.put(`/zones/${zoneIdentifier}/snippets/snippet_rules`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: RuleUpdateResponse }>
+      this._client.put(`/zones/${zone_id}/snippets/snippet_rules`, { body, ...options }) as Core.APIPromise<{
+        result: RuleUpdateResponse;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -36,11 +22,12 @@ export class Rules extends APIResource {
    * Rules
    */
   list(
-    zoneIdentifier: string,
+    params: RuleListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<RuleListResponsesSinglePage, RuleListResponse> {
+    const { zone_id } = params;
     return this._client.getAPIList(
-      `/zones/${zoneIdentifier}/snippets/snippet_rules`,
+      `/zones/${zone_id}/snippets/snippet_rules`,
       RuleListResponsesSinglePage,
       options,
     );
@@ -84,7 +71,12 @@ export interface RuleListResponse {
 
 export interface RuleUpdateParams {
   /**
-   * List of snippet rules
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Body param: List of snippet rules
    */
   rules?: Array<RuleUpdateParams.Rule>;
 }
@@ -104,9 +96,17 @@ export namespace RuleUpdateParams {
   }
 }
 
+export interface RuleListParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
 export namespace Rules {
   export import RuleUpdateResponse = RulesAPI.RuleUpdateResponse;
   export import RuleListResponse = RulesAPI.RuleListResponse;
   export import RuleListResponsesSinglePage = RulesAPI.RuleListResponsesSinglePage;
   export import RuleUpdateParams = RulesAPI.RuleUpdateParams;
+  export import RuleListParams = RulesAPI.RuleListParams;
 }

package/src/resources/snippets/snippets.ts

@@ -2,7 +2,7 @@
 
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
+import * as Shared from "../shared";
 import * as ContentAPI from "./content";
 import * as RulesAPI from "./rules";
 import { multipartFormRequestOptions } from "../../core";
@@ -16,28 +16,14 @@ export class Snippets extends APIResource {
    * Put Snippet
    */
   update(
-    zoneIdentifier: string,
     snippetName: string,
-    body?: SnippetUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Snippet>;
-  update(
-    zoneIdentifier: string,
-    snippetName: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Snippet>;
-  update(
-    zoneIdentifier: string,
-    snippetName: string,
-    body: SnippetUpdateParams | Core.RequestOptions = {},
+    params: SnippetUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Snippet> {
-    if (isRequestOptions(body)) {
-      return this.update(zoneIdentifier, snippetName, {}, body);
-    }
+    const { zone_id, ...body } = params;
     return (
       this._client.put(
-        `/zones/${zoneIdentifier}/snippets/${snippetName}`,
+        `/zones/${zone_id}/snippets/${snippetName}`,
         multipartFormRequestOptions({ body, ...options }),
       ) as Core.APIPromise<{ result: Snippet }>
     )._thenUnwrap((obj) => obj.result);
@@ -46,31 +32,37 @@ export class Snippets extends APIResource {
   /**
    * All Snippets
    */
-  list(zoneIdentifier: string, options?: Core.RequestOptions): Core.PagePromise<SnippetsSinglePage, Snippet> {
-    return this._client.getAPIList(`/zones/${zoneIdentifier}/snippets`, SnippetsSinglePage, options);
+  list(
+    params: SnippetListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SnippetsSinglePage, Snippet> {
+    const { zone_id } = params;
+    return this._client.getAPIList(`/zones/${zone_id}/snippets`, SnippetsSinglePage, options);
   }
 
   /**
    * Delete Snippet
    */
   delete(
-    zoneIdentifier: string,
     snippetName: string,
+    params: SnippetDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<SnippetDeleteResponse> {
-    return (
-      this._client.delete(`/zones/${zoneIdentifier}/snippets/${snippetName}`, options) as Core.APIPromise<{
-        result: SnippetDeleteResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    const { zone_id } = params;
+    return this._client.delete(`/zones/${zone_id}/snippets/${snippetName}`, options);
   }
 
   /**
    * Snippet
    */
-  get(zoneIdentifier: string, snippetName: string, options?: Core.RequestOptions): Core.APIPromise<Snippet> {
+  get(
+    snippetName: string,
+    params: SnippetGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Snippet> {
+    const { zone_id } = params;
     return (
-      this._client.get(`/zones/${zoneIdentifier}/snippets/${snippetName}`, options) as Core.APIPromise<{
+      this._client.get(`/zones/${zone_id}/snippets/${snippetName}`, options) as Core.APIPromise<{
         result: Snippet;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -99,14 +91,31 @@ export interface Snippet {
   snippet_name?: string;
 }
 
-export type SnippetDeleteResponse = unknown | Array<unknown> | string;
+export interface SnippetDeleteResponse {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<Shared.ResponseInfo>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
 
 export interface SnippetUpdateParams {
   /**
-   * Content files of uploaded snippet
+   * Path param: Identifier
+   */
+  zone_id: string;
+
+  /**
+   * Body param: Content files of uploaded snippet
    */
   files?: string;
 
+  /**
+   * Body param:
+   */
   metadata?: SnippetUpdateParams.Metadata;
 }
 
@@ -119,11 +128,34 @@ export namespace SnippetUpdateParams {
   }
 }
 
+export interface SnippetListParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
+export interface SnippetDeleteParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
+export interface SnippetGetParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
 export namespace Snippets {
   export import Content = ContentAPI.Content;
+  export import ContentGetParams = ContentAPI.ContentGetParams;
   export import Rules = RulesAPI.Rules;
   export import RuleUpdateResponse = RulesAPI.RuleUpdateResponse;
   export import RuleListResponse = RulesAPI.RuleListResponse;
   export import RuleListResponsesSinglePage = RulesAPI.RuleListResponsesSinglePage;
   export import RuleUpdateParams = RulesAPI.RuleUpdateParams;
+  export import RuleListParams = RulesAPI.RuleListParams;
 }

package/src/resources/spectrum/analytics/events/bytimes.ts

@@ -46,7 +46,7 @@ export interface BytimeGetParams {
    * | coloName  | Colo Name                     | SFO                                                        |
    * | ipVersion | IP version used by the client | 4, 6.                                                      |
    */
-  dimensions?: Array<EventsAPI.Dimension>;
+  dimensions?: Array<EventsAPI.DimensionParam>;
 
   /**
    * Used to filter rows by one or more dimensions. Filters can be combined using OR

package/src/resources/spectrum/analytics/events/events.ts

@@ -12,6 +12,8 @@ export class Events extends APIResource {
 
 export type Dimension = 'event' | 'appID' | 'coloName' | 'ipVersion';
 
+export type DimensionParam = 'event' | 'appID' | 'coloName' | 'ipVersion';
+
 export namespace Events {
   export import Dimension = EventsAPI.Dimension;
   export import Bytimes = BytimesAPI.Bytimes;

package/src/resources/spectrum/analytics/events/summaries.ts

@@ -46,7 +46,7 @@ export interface SummaryGetParams {
    * | coloName  | Colo Name                     | SFO                                                        |
    * | ipVersion | IP version used by the client | 4, 6.                                                      |
    */
-  dimensions?: Array<EventsAPI.Dimension>;
+  dimensions?: Array<EventsAPI.DimensionParam>;
 
   /**
    * Used to filter rows by one or more dimensions. Filters can be combined using OR

package/src/resources/spectrum/apps.ts

@@ -73,11 +73,10 @@ export class Apps extends APIResource {
   delete(
     zone: string,
     appId: string,
-    body: AppDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<AppDeleteResponse | null> {
     return (
-      this._client.delete(`/zones/${zone}/spectrum/apps/${appId}`, { body, ...options }) as Core.APIPromise<{
+      this._client.delete(`/zones/${zone}/spectrum/apps/${appId}`, options) as Core.APIPromise<{
         result: AppDeleteResponse | null;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -274,12 +273,12 @@ export interface AppCreateParams {
   /**
    * The name and type of DNS record for the Spectrum application.
    */
-  dns: SpectrumAPI.DNS;
+  dns: SpectrumAPI.DNSParam;
 
   /**
    * The name and type of DNS record for the Spectrum application.
    */
-  origin_dns: SpectrumAPI.OriginDNS;
+  origin_dns: SpectrumAPI.OriginDNSParam;
 
   /**
    * The destination port at the origin. Only specified in conjunction with
@@ -288,7 +287,7 @@ export interface AppCreateParams {
    * `"1000-2000"`. Notes: If specifying a port range, the number of ports in the
    * range must match the number of ports specified in the "protocol" field.
    */
-  origin_port: SpectrumAPI.OriginPort;
+  origin_port: SpectrumAPI.OriginPortParam;
 
   /**
    * The port configuration at Cloudflare’s edge. May specify a single port, for
@@ -305,7 +304,7 @@ export interface AppCreateParams {
   /**
    * The anycast edge IP configuration for the hostname of this application.
    */
-  edge_ips?: SpectrumAPI.EdgeIPs;
+  edge_ips?: SpectrumAPI.EdgeIPsParam;
 
   /**
    * Enables IP Access Rules for this application. Notes: Only available for TCP
@@ -340,12 +339,12 @@ export interface AppUpdateParams {
   /**
    * The name and type of DNS record for the Spectrum application.
    */
-  dns: SpectrumAPI.DNS;
+  dns: SpectrumAPI.DNSParam;
 
   /**
    * The name and type of DNS record for the Spectrum application.
    */
-  origin_dns: SpectrumAPI.OriginDNS;
+  origin_dns: SpectrumAPI.OriginDNSParam;
 
   /**
    * The destination port at the origin. Only specified in conjunction with
@@ -354,7 +353,7 @@ export interface AppUpdateParams {
    * `"1000-2000"`. Notes: If specifying a port range, the number of ports in the
    * range must match the number of ports specified in the "protocol" field.
    */
-  origin_port: SpectrumAPI.OriginPort;
+  origin_port: SpectrumAPI.OriginPortParam;
 
   /**
    * The port configuration at Cloudflare’s edge. May specify a single port, for
@@ -371,7 +370,7 @@ export interface AppUpdateParams {
   /**
    * The anycast edge IP configuration for the hostname of this application.
    */
-  edge_ips?: SpectrumAPI.EdgeIPs;
+  edge_ips?: SpectrumAPI.EdgeIPsParam;
 
   /**
    * Enables IP Access Rules for this application. Notes: Only available for TCP
@@ -414,8 +413,6 @@ export interface AppListParams extends V4PagePaginationArrayParams {
   order?: 'protocol' | 'app_id' | 'created_on' | 'modified_on' | 'dns';
 }
 
-export type AppDeleteParams = unknown;
-
 export namespace Apps {
   export import AppCreateResponse = AppsAPI.AppCreateResponse;
   export import AppUpdateResponse = AppsAPI.AppUpdateResponse;
@@ -426,5 +423,4 @@ export namespace Apps {
   export import AppCreateParams = AppsAPI.AppCreateParams;
   export import AppUpdateParams = AppsAPI.AppUpdateParams;
   export import AppListParams = AppsAPI.AppListParams;
-  export import AppDeleteParams = AppsAPI.AppDeleteParams;
 }

package/src/resources/spectrum/index.ts

@@ -10,7 +10,6 @@ export {
   AppCreateParams,
   AppUpdateParams,
   AppListParams,
-  AppDeleteParams,
   AppListResponsesV4PagePaginationArray,
   Apps,
 } from './apps';

package/src/resources/spectrum/spectrum.ts

@@ -24,6 +24,21 @@ export interface DNS {
   type?: 'CNAME' | 'ADDRESS';
 }
 
+/**
+ * The name and type of DNS record for the Spectrum application.
+ */
+export interface DNSParam {
+  /**
+   * The name of the DNS record associated with the application.
+   */
+  name?: string;
+
+  /**
+   * The type of DNS record associated with the application.
+   */
+  type?: 'CNAME' | 'ADDRESS';
+}
+
 /**
  * The anycast edge IP configuration for the hostname of this application.
  */
@@ -60,6 +75,42 @@ export namespace EdgeIPs {
   }
 }
 
+/**
+ * The anycast edge IP configuration for the hostname of this application.
+ */
+export type EdgeIPsParam = EdgeIPsParam.EyeballIPs | EdgeIPsParam.CustomerOwnedIPs;
+
+export namespace EdgeIPsParam {
+  export interface EyeballIPs {
+    /**
+     * The IP versions supported for inbound connections on Spectrum anycast IPs.
+     */
+    connectivity?: 'all' | 'ipv4' | 'ipv6';
+
+    /**
+     * The type of edge IP configuration specified. Dynamically allocated edge IPs use
+     * Spectrum anycast IPs in accordance with the connectivity you specify. Only valid
+     * with CNAME DNS names.
+     */
+    type?: 'dynamic';
+  }
+
+  export interface CustomerOwnedIPs {
+    /**
+     * The array of customer owned IPs we broadcast via anycast for this hostname and
+     * application.
+     */
+    ips?: Array<string>;
+
+    /**
+     * The type of edge IP configuration specified. Statically allocated edge IPs use
+     * customer IPs in accordance with the ips array you specify. Only valid with
+     * ADDRESS DNS names.
+     */
+    type?: 'static';
+  }
+}
+
 /**
  * The name and type of DNS record for the Spectrum application.
  */
@@ -81,6 +132,27 @@ export interface OriginDNS {
   type?: '' | 'A' | 'AAAA' | 'SRV';
 }
 
+/**
+ * The name and type of DNS record for the Spectrum application.
+ */
+export interface OriginDNSParam {
+  /**
+   * The name of the DNS record associated with the origin.
+   */
+  name?: string;
+
+  /**
+   * The TTL of our resolution of your DNS record in seconds.
+   */
+  ttl?: number;
+
+  /**
+   * The type of DNS record associated with the origin. "" is used to specify a
+   * combination of A/AAAA records.
+   */
+  type?: '' | 'A' | 'AAAA' | 'SRV';
+}
+
 /**
  * The destination port at the origin. Only specified in conjunction with
  * origin_dns. May use an integer to specify a single origin port, for example
@@ -90,6 +162,15 @@ export interface OriginDNS {
  */
 export type OriginPort = number | string;
 
+/**
+ * The destination port at the origin. Only specified in conjunction with
+ * origin_dns. May use an integer to specify a single origin port, for example
+ * `1000`, or a string to specify a range of origin ports, for example
+ * `"1000-2000"`. Notes: If specifying a port range, the number of ports in the
+ * range must match the number of ports specified in the "protocol" field.
+ */
+export type OriginPortParam = number | string;
+
 export namespace Spectrum {
   export import Analytics = AnalyticsAPI.Analytics;
   export import Apps = AppsAPI.Apps;
@@ -102,5 +183,4 @@ export namespace Spectrum {
   export import AppCreateParams = AppsAPI.AppCreateParams;
   export import AppUpdateParams = AppsAPI.AppUpdateParams;
   export import AppListParams = AppsAPI.AppListParams;
-  export import AppDeleteParams = AppsAPI.AppDeleteParams;
 }

package/src/resources/speed/index.ts

@@ -1,16 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Availability, AvailabilityListParams, Availabilities } from './availabilities';
-export { PageListResponse, PageListParams, PageListResponsesSinglePage, Pages } from './pages';
-export { Schedule, ScheduleCreateResponse, ScheduleCreateParams, ScheduleResource } from './schedule';
-export { Speed } from './speed';
 export {
-  Test,
-  TestListResponse,
-  TestDeleteResponse,
-  TestCreateParams,
-  TestListParams,
-  TestDeleteParams,
-  TestGetParams,
-  Tests,
-} from './tests';
+  PageListResponse,
+  PageListParams,
+  PageTrendParams,
+  PageListResponsesSinglePage,
+  Pages,
+} from './pages/index';
+export {
+  Schedule,
+  ScheduleCreateResponse,
+  ScheduleDeleteResponse,
+  ScheduleCreateParams,
+  ScheduleDeleteParams,
+  ScheduleGetParams,
+  ScheduleResource,
+} from './schedule';
+export { Speed } from './speed';

package/src/resources/speed/pages/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  PageListResponse,
+  PageListParams,
+  PageTrendParams,
+  PageListResponsesSinglePage,
+  Pages,
+} from './pages';
+export {
+  Test,
+  TestListResponse,
+  TestDeleteResponse,
+  TestCreateParams,
+  TestListParams,
+  TestDeleteParams,
+  TestGetParams,
+  Tests,
+} from './tests';