cloudflare 3.1.0 → 3.2.0

package/src/resources/magic-transit/index.ts

@@ -9,24 +9,6 @@ export {
   CfInterconnectGetParams,
   CfInterconnects,
 } from './cf-interconnects';
-export {
-  ColoName,
-  ColoRegion,
-  Scope,
-  RouteCreateResponse,
-  RouteUpdateResponse,
-  RouteListResponse,
-  RouteDeleteResponse,
-  RouteEmptyResponse,
-  RouteGetResponse,
-  RouteCreateParams,
-  RouteUpdateParams,
-  RouteListParams,
-  RouteDeleteParams,
-  RouteEmptyParams,
-  RouteGetParams,
-  Routes,
-} from './routes';
 export {
   GRETunnelCreateResponse,
   GRETunnelUpdateResponse,
@@ -57,6 +39,22 @@ export {
   IPSECTunnelPSKGenerateParams,
   IPSECTunnels,
 } from './ipsec-tunnels';
+export {
+  Scope,
+  RouteCreateResponse,
+  RouteUpdateResponse,
+  RouteListResponse,
+  RouteDeleteResponse,
+  RouteEmptyResponse,
+  RouteGetResponse,
+  RouteCreateParams,
+  RouteUpdateParams,
+  RouteListParams,
+  RouteDeleteParams,
+  RouteEmptyParams,
+  RouteGetParams,
+  Routes,
+} from './routes';
 export {
   Site,
   SiteLocation,

package/src/resources/magic-transit/ipsec-tunnels.ts

@@ -68,12 +68,12 @@ export class IPSECTunnels extends APIResource {
     params: IPSECTunnelDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<IPSECTunnelDeleteResponse> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/ipsec_tunnels/${tunnelIdentifier}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: IPSECTunnelDeleteResponse }>
+      this._client.delete(
+        `/accounts/${account_id}/magic/ipsec_tunnels/${tunnelIdentifier}`,
+        options,
+      ) as Core.APIPromise<{ result: IPSECTunnelDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -389,7 +389,7 @@ export interface IPSECTunnelCreateParams {
   /**
    * Body param:
    */
-  health_check?: MagicTransitAPI.HealthCheck;
+  health_check?: MagicTransitAPI.HealthCheckParam;
 
   /**
    * Body param: A randomly generated or provided string for use in the IPsec tunnel.
@@ -441,7 +441,7 @@ export interface IPSECTunnelUpdateParams {
   /**
    * Body param:
    */
-  health_check?: MagicTransitAPI.HealthCheck;
+  health_check?: MagicTransitAPI.HealthCheckParam;
 
   /**
    * Body param: A randomly generated or provided string for use in the IPsec tunnel.
@@ -464,14 +464,9 @@ export interface IPSECTunnelListParams {
 
 export interface IPSECTunnelDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface IPSECTunnelGetParams {

package/src/resources/magic-transit/magic-transit.ts

@@ -51,16 +51,62 @@ export interface HealthCheck {
   type?: HealthCheckType;
 }
 
+export interface HealthCheckParam {
+  /**
+   * The direction of the flow of the healthcheck. Either unidirectional, where the
+   * probe comes to you via the tunnel and the result comes back to Cloudflare via
+   * the open Internet, or bidirectional where both the probe and result come and go
+   * via the tunnel. Note in the case of bidirecitonal healthchecks, the target field
+   * in health_check is ignored as the interface_address is used to send traffic into
+   * the tunnel.
+   */
+  direction?: 'unidirectional' | 'bidirectional';
+
+  /**
+   * Determines whether to run healthchecks for a tunnel.
+   */
+  enabled?: boolean;
+
+  /**
+   * How frequent the health check is run. The default value is `mid`.
+   */
+  rate?: HealthCheckRateParam;
+
+  /**
+   * The destination address in a request type health check. After the healthcheck is
+   * decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded
+   * to this address. This field defaults to `customer_gre_endpoint address`. This
+   * field is ignored for bidirectional healthchecks as the interface_address (not
+   * assigned to the Cloudflare side of the tunnel) is used as the target.
+   */
+  target?: string;
+
+  /**
+   * The type of healthcheck to run, reply or request. The default value is `reply`.
+   */
+  type?: HealthCheckTypeParam;
+}
+
 /**
  * How frequent the health check is run. The default value is `mid`.
  */
 export type HealthCheckRate = 'low' | 'mid' | 'high';
 
+/**
+ * How frequent the health check is run. The default value is `mid`.
+ */
+export type HealthCheckRateParam = 'low' | 'mid' | 'high';
+
 /**
  * The type of healthcheck to run, reply or request. The default value is `reply`.
  */
 export type HealthCheckType = 'reply' | 'request';
 
+/**
+ * The type of healthcheck to run, reply or request. The default value is `reply`.
+ */
+export type HealthCheckTypeParam = 'reply' | 'request';
+
 export namespace MagicTransit {
   export import CfInterconnects = CfInterconnectsAPI.CfInterconnects;
   export import CfInterconnectUpdateResponse = CfInterconnectsAPI.CfInterconnectUpdateResponse;
@@ -95,8 +141,6 @@ export namespace MagicTransit {
   export import IPSECTunnelGetParams = IPSECTunnelsAPI.IPSECTunnelGetParams;
   export import IPSECTunnelPSKGenerateParams = IPSECTunnelsAPI.IPSECTunnelPSKGenerateParams;
   export import Routes = RoutesAPI.Routes;
-  export import ColoName = RoutesAPI.ColoName;
-  export import ColoRegion = RoutesAPI.ColoRegion;
   export import Scope = RoutesAPI.Scope;
   export import RouteCreateResponse = RoutesAPI.RouteCreateResponse;
   export import RouteUpdateResponse = RoutesAPI.RouteUpdateResponse;

package/src/resources/magic-transit/routes.ts

@@ -57,12 +57,12 @@ export class Routes extends APIResource {
     params: RouteDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RouteDeleteResponse> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/routes/${routeIdentifier}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: RouteDeleteResponse }>
+      this._client.delete(
+        `/accounts/${account_id}/magic/routes/${routeIdentifier}`,
+        options,
+      ) as Core.APIPromise<{ result: RouteDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -70,9 +70,9 @@ export class Routes extends APIResource {
    * Delete multiple Magic static routes.
    */
   empty(params: RouteEmptyParams, options?: Core.RequestOptions): Core.APIPromise<RouteEmptyResponse> {
-    const { account_id, ...body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/routes`, { body, ...options }) as Core.APIPromise<{
+      this._client.delete(`/accounts/${account_id}/magic/routes`, options) as Core.APIPromise<{
         result: RouteEmptyResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -97,28 +97,33 @@ export class Routes extends APIResource {
 }
 
 /**
- * List of colo names for the ECMP scope.
+ * Used only for ECMP routes.
  */
-export type ColoName = Array<string>;
+export interface Scope {
+  /**
+   * List of colo names for the ECMP scope.
+   */
+  colo_names?: Array<string>;
 
-/**
- * List of colo regions for the ECMP scope.
- */
-export type ColoRegion = Array<string>;
+  /**
+   * List of colo regions for the ECMP scope.
+   */
+  colo_regions?: Array<string>;
+}
 
 /**
  * Used only for ECMP routes.
  */
-export interface Scope {
+export interface ScopeParam {
   /**
    * List of colo names for the ECMP scope.
    */
-  colo_names?: ColoName;
+  colo_names?: Array<string>;
 
   /**
    * List of colo regions for the ECMP scope.
    */
-  colo_regions?: ColoRegion;
+  colo_regions?: Array<string>;
 }
 
 export interface RouteCreateResponse {
@@ -290,7 +295,7 @@ export interface RouteUpdateParams {
   /**
    * Body param: Used only for ECMP routes.
    */
-  scope?: Scope;
+  scope?: ScopeParam;
 
   /**
    * Body param: Optional weight of the ECMP scope - if provided.
@@ -307,30 +312,16 @@ export interface RouteListParams {
 
 export interface RouteDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface RouteEmptyParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  routes: Array<RouteEmptyParams.Route>;
-}
-
-export namespace RouteEmptyParams {
-  export interface Route {}
 }
 
 export interface RouteGetParams {
@@ -341,8 +332,6 @@ export interface RouteGetParams {
 }
 
 export namespace Routes {
-  export import ColoName = RoutesAPI.ColoName;
-  export import ColoRegion = RoutesAPI.ColoRegion;
   export import Scope = RoutesAPI.Scope;
   export import RouteCreateResponse = RoutesAPI.RouteCreateResponse;
   export import RouteUpdateResponse = RoutesAPI.RouteUpdateResponse;

package/src/resources/magic-transit/sites/acls.ts

@@ -62,12 +62,12 @@ export class ACLs extends APIResource {
     params: ACLDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ACL> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/sites/${siteId}/acls/${aclIdentifier}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: ACL }>
+      this._client.delete(
+        `/accounts/${account_id}/magic/sites/${siteId}/acls/${aclIdentifier}`,
+        options,
+      ) as Core.APIPromise<{ result: ACL }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -150,17 +150,52 @@ export interface ACLConfiguration {
   subnets?: Array<Subnet>;
 }
 
+export interface ACLConfigurationParam {
+  /**
+   * The identifier for the LAN you want to create an ACL policy with.
+   */
+  lan_id: string;
+
+  /**
+   * The name of the LAN based on the provided lan_id.
+   */
+  lan_name?: string;
+
+  /**
+   * Array of ports on the provided LAN that will be included in the ACL. If no ports
+   * are provided, communication on any port on this LAN is allowed.
+   */
+  ports?: Array<number>;
+
+  /**
+   * Array of subnet IPs within the LAN that will be included in the ACL. If no
+   * subnets are provided, communication on any subnets on this LAN are allowed.
+   */
+  subnets?: Array<SubnetParam>;
+}
+
 /**
  * Array of allowed communication protocols between configured LANs. If no
  * protocols are provided, all protocols are allowed.
  */
 export type AllowedProtocol = 'tcp' | 'udp' | 'icmp';
 
+/**
+ * Array of allowed communication protocols between configured LANs. If no
+ * protocols are provided, all protocols are allowed.
+ */
+export type AllowedProtocolParam = 'tcp' | 'udp' | 'icmp';
+
 /**
  * A valid IPv4 address.
  */
 export type Subnet = string | string;
 
+/**
+ * A valid IPv4 address.
+ */
+export type SubnetParam = string | string;
+
 export interface ACLCreateParams {
   /**
    * Path param: Identifier
@@ -170,12 +205,12 @@ export interface ACLCreateParams {
   /**
    * Body param:
    */
-  lan_1: ACLConfiguration;
+  lan_1: ACLConfigurationParam;
 
   /**
    * Body param:
    */
-  lan_2: ACLConfiguration;
+  lan_2: ACLConfigurationParam;
 
   /**
    * Body param: The name of the ACL.
@@ -198,7 +233,7 @@ export interface ACLCreateParams {
   /**
    * Body param:
    */
-  protocols?: Array<AllowedProtocol>;
+  protocols?: Array<AllowedProtocolParam>;
 }
 
 export interface ACLUpdateParams {
@@ -223,12 +258,12 @@ export interface ACLUpdateParams {
   /**
    * Body param:
    */
-  lan_1?: ACLConfiguration;
+  lan_1?: ACLConfigurationParam;
 
   /**
    * Body param:
    */
-  lan_2?: ACLConfiguration;
+  lan_2?: ACLConfigurationParam;
 
   /**
    * Body param: The name of the ACL.
@@ -238,7 +273,7 @@ export interface ACLUpdateParams {
   /**
    * Body param:
    */
-  protocols?: Array<AllowedProtocol>;
+  protocols?: Array<AllowedProtocolParam>;
 }
 
 export interface ACLListParams {
@@ -250,14 +285,9 @@ export interface ACLListParams {
 
 export interface ACLDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface ACLGetParams {

package/src/resources/magic-transit/sites/lans.ts

@@ -67,12 +67,12 @@ export class LANs extends APIResource {
     params: LANDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LAN> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/sites/${siteId}/lans/${lanId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: LAN }>
+      this._client.delete(
+        `/accounts/${account_id}/magic/sites/${siteId}/lans/${lanId}`,
+        options,
+      ) as Core.APIPromise<{ result: LAN }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -104,6 +104,13 @@ export interface DHCPRelay {
   server_addresses?: Array<string>;
 }
 
+export interface DHCPRelayParam {
+  /**
+   * List of DHCP server IPs.
+   */
+  server_addresses?: Array<string>;
+}
+
 export interface DHCPServer {
   /**
    * A valid IPv4 address.
@@ -126,6 +133,28 @@ export interface DHCPServer {
   reservations?: Record<string, string>;
 }
 
+export interface DHCPServerParam {
+  /**
+   * A valid IPv4 address.
+   */
+  dhcp_pool_end?: string;
+
+  /**
+   * A valid IPv4 address.
+   */
+  dhcp_pool_start?: string;
+
+  /**
+   * A valid IPv4 address.
+   */
+  dns_server?: string;
+
+  /**
+   * Mapping of MAC addresses to IP addresses
+   */
+  reservations?: Record<string, string>;
+}
+
 export interface LAN {
   /**
    * Identifier
@@ -190,6 +219,32 @@ export interface LANStaticAddressing {
   virtual_address?: string;
 }
 
+/**
+ * If the site is not configured in high availability mode, this configuration is
+ * optional (if omitted, use DHCP). However, if in high availability mode,
+ * static_address is required along with secondary and virtual address.
+ */
+export interface LANStaticAddressingParam {
+  /**
+   * A valid CIDR notation representing an IP range.
+   */
+  address: string;
+
+  dhcp_relay?: DHCPRelayParam;
+
+  dhcp_server?: DHCPServerParam;
+
+  /**
+   * A valid CIDR notation representing an IP range.
+   */
+  secondary_address?: string;
+
+  /**
+   * A valid CIDR notation representing an IP range.
+   */
+  virtual_address?: string;
+}
+
 export interface Nat {
   /**
    * A valid CIDR notation representing an IP range.
@@ -197,6 +252,13 @@ export interface Nat {
   static_prefix?: string;
 }
 
+export interface NatParam {
+  /**
+   * A valid CIDR notation representing an IP range.
+   */
+  static_prefix?: string;
+}
+
 export interface RoutedSubnet {
   /**
    * A valid IPv4 address.
@@ -211,6 +273,20 @@ export interface RoutedSubnet {
   nat?: Nat;
 }
 
+export interface RoutedSubnetParam {
+  /**
+   * A valid IPv4 address.
+   */
+  next_hop: string;
+
+  /**
+   * A valid CIDR notation representing an IP range.
+   */
+  prefix: string;
+
+  nat?: NatParam;
+}
+
 export type LANCreateResponse = Array<LAN>;
 
 export interface LANCreateParams {
@@ -243,12 +319,12 @@ export interface LANCreateParams {
   /**
    * Body param:
    */
-  nat?: Nat;
+  nat?: NatParam;
 
   /**
    * Body param:
    */
-  routed_subnets?: Array<RoutedSubnet>;
+  routed_subnets?: Array<RoutedSubnetParam>;
 
   /**
    * Body param: If the site is not configured in high availability mode, this
@@ -256,7 +332,7 @@ export interface LANCreateParams {
    * availability mode, static_address is required along with secondary and virtual
    * address.
    */
-  static_addressing?: LANStaticAddressing;
+  static_addressing?: LANStaticAddressingParam;
 }
 
 export interface LANUpdateParams {
@@ -273,7 +349,7 @@ export interface LANUpdateParams {
   /**
    * Body param:
    */
-  nat?: Nat;
+  nat?: NatParam;
 
   /**
    * Body param:
@@ -283,7 +359,7 @@ export interface LANUpdateParams {
   /**
    * Body param:
    */
-  routed_subnets?: Array<RoutedSubnet>;
+  routed_subnets?: Array<RoutedSubnetParam>;
 
   /**
    * Body param: If the site is not configured in high availability mode, this
@@ -291,7 +367,7 @@ export interface LANUpdateParams {
    * availability mode, static_address is required along with secondary and virtual
    * address.
    */
-  static_addressing?: LANStaticAddressing;
+  static_addressing?: LANStaticAddressingParam;
 
   /**
    * Body param: VLAN port number.
@@ -308,14 +384,9 @@ export interface LANListParams {
 
 export interface LANDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface LANGetParams {

package/src/resources/magic-transit/sites/sites.ts

@@ -55,12 +55,11 @@ export class Sites extends APIResource {
    * Remove a specific Site.
    */
   delete(siteId: string, params: SiteDeleteParams, options?: Core.RequestOptions): Core.APIPromise<Site> {
-    const { account_id, body } = params;
+    const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/magic/sites/${siteId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: Site }>
+      this._client.delete(`/accounts/${account_id}/magic/sites/${siteId}`, options) as Core.APIPromise<{
+        result: Site;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -129,6 +128,21 @@ export interface SiteLocation {
   lon?: string;
 }
 
+/**
+ * Location of site in latitude and longitude.
+ */
+export interface SiteLocationParam {
+  /**
+   * Latitude
+   */
+  lat?: string;
+
+  /**
+   * Longitude
+   */
+  lon?: string;
+}
+
 export interface SiteCreateParams {
   /**
    * Path param: Identifier
@@ -159,7 +173,7 @@ export interface SiteCreateParams {
   /**
    * Body param: Location of site in latitude and longitude.
    */
-  location?: SiteLocation;
+  location?: SiteLocationParam;
 
   /**
    * Body param: Magic WAN Connector identifier tag. Used when high availability mode
@@ -187,7 +201,7 @@ export interface SiteUpdateParams {
   /**
    * Body param: Location of site in latitude and longitude.
    */
-  location?: SiteLocation;
+  location?: SiteLocationParam;
 
   /**
    * Body param: The name of the site.
@@ -215,14 +229,9 @@ export interface SiteListParams {
 
 export interface SiteDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface SiteGetParams {