cloudflare 4.0.0 → 4.1.0

package/src/resources/network-interconnects/interconnects.ts

@@ -0,0 +1,400 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Interconnects extends APIResource {
+  /**
+   * Create a new interconnect
+   */
+  create(
+    params: InterconnectCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InterconnectCreateResponse> {
+    const { account_id, ...body } = params;
+    return this._client.post(`/accounts/${account_id}/cni/interconnects`, { body, ...options });
+  }
+
+  /**
+   * List existing interconnects
+   */
+  list(
+    params: InterconnectListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InterconnectListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(`/accounts/${account_id}/cni/interconnects`, { query, ...options });
+  }
+
+  /**
+   * Delete an interconnect object
+   */
+  delete(
+    icon: string,
+    params: InterconnectDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    const { account_id } = params;
+    return this._client.delete(`/accounts/${account_id}/cni/interconnects/${icon}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Get information about an interconnect object
+   */
+  get(
+    icon: string,
+    params: InterconnectGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InterconnectGetResponse> {
+    const { account_id } = params;
+    return this._client.get(`/accounts/${account_id}/cni/interconnects/${icon}`, options);
+  }
+
+  /**
+   * Generate the Letter of Authorization (LOA) for a given interconnect
+   */
+  loa(icon: string, params: InterconnectLOAParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    const { account_id } = params;
+    return this._client.get(`/accounts/${account_id}/cni/interconnects/${icon}/loa`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Get the current status of an interconnect object
+   */
+  status(
+    icon: string,
+    params: InterconnectStatusParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InterconnectStatusResponse> {
+    const { account_id } = params;
+    return this._client.get(`/accounts/${account_id}/cni/interconnects/${icon}/status`, options);
+  }
+}
+
+export type InterconnectCreateResponse =
+  | InterconnectCreateResponse.NscInterconnectPhysicalBody
+  | InterconnectCreateResponse.NscInterconnectGcpPartnerBody;
+
+export namespace InterconnectCreateResponse {
+  export interface NscInterconnectPhysicalBody {
+    account: string;
+
+    facility: NscInterconnectPhysicalBody.Facility;
+
+    name: string;
+
+    /**
+     * A Cloudflare site name.
+     */
+    site: string;
+
+    slot_id: string;
+
+    speed: string;
+
+    type: string;
+
+    owner?: string;
+  }
+
+  export namespace NscInterconnectPhysicalBody {
+    export interface Facility {
+      address: Array<string>;
+
+      name: string;
+    }
+  }
+
+  export interface NscInterconnectGcpPartnerBody {
+    account: string;
+
+    name: string;
+
+    region: string;
+
+    type: string;
+
+    owner?: string;
+  }
+}
+
+export interface InterconnectListResponse {
+  items: Array<
+    | InterconnectListResponse.NscInterconnectPhysicalBody
+    | InterconnectListResponse.NscInterconnectGcpPartnerBody
+  >;
+
+  next?: number | null;
+}
+
+export namespace InterconnectListResponse {
+  export interface NscInterconnectPhysicalBody {
+    account: string;
+
+    facility: NscInterconnectPhysicalBody.Facility;
+
+    name: string;
+
+    /**
+     * A Cloudflare site name.
+     */
+    site: string;
+
+    slot_id: string;
+
+    speed: string;
+
+    type: string;
+
+    owner?: string;
+  }
+
+  export namespace NscInterconnectPhysicalBody {
+    export interface Facility {
+      address: Array<string>;
+
+      name: string;
+    }
+  }
+
+  export interface NscInterconnectGcpPartnerBody {
+    account: string;
+
+    name: string;
+
+    region: string;
+
+    type: string;
+
+    owner?: string;
+  }
+}
+
+export type InterconnectGetResponse =
+  | InterconnectGetResponse.NscInterconnectPhysicalBody
+  | InterconnectGetResponse.NscInterconnectGcpPartnerBody;
+
+export namespace InterconnectGetResponse {
+  export interface NscInterconnectPhysicalBody {
+    account: string;
+
+    facility: NscInterconnectPhysicalBody.Facility;
+
+    name: string;
+
+    /**
+     * A Cloudflare site name.
+     */
+    site: string;
+
+    slot_id: string;
+
+    speed: string;
+
+    type: string;
+
+    owner?: string;
+  }
+
+  export namespace NscInterconnectPhysicalBody {
+    export interface Facility {
+      address: Array<string>;
+
+      name: string;
+    }
+  }
+
+  export interface NscInterconnectGcpPartnerBody {
+    account: string;
+
+    name: string;
+
+    region: string;
+
+    type: string;
+
+    owner?: string;
+  }
+}
+
+export type InterconnectStatusResponse =
+  | InterconnectStatusResponse.Pending
+  | InterconnectStatusResponse.Down
+  | InterconnectStatusResponse.Unhealthy
+  | InterconnectStatusResponse.Healthy;
+
+export namespace InterconnectStatusResponse {
+  export interface Pending {
+    state: 'Pending';
+  }
+
+  export interface Down {
+    state: 'Down';
+
+    /**
+     * Diagnostic information, if available
+     */
+    reason?: string | null;
+  }
+
+  export interface Unhealthy {
+    state: 'Unhealthy';
+
+    /**
+     * Diagnostic information, if available
+     */
+    reason?: string | null;
+  }
+
+  export interface Healthy {
+    state: 'Healthy';
+  }
+}
+
+export type InterconnectCreateParams =
+  | InterconnectCreateParams.NscInterconnectCreatePhysicalBody
+  | InterconnectCreateParams.NscInterconnectCreateGcpPartnerBody;
+
+export declare namespace InterconnectCreateParams {
+  export interface NscInterconnectCreatePhysicalBody {
+    /**
+     * Path param: Customer account tag
+     */
+    account_id: string;
+
+    /**
+     * Body param:
+     */
+    account: string;
+
+    /**
+     * Body param:
+     */
+    slot_id: string;
+
+    /**
+     * Body param:
+     */
+    type: string;
+
+    /**
+     * Body param:
+     */
+    speed?: string | null;
+  }
+
+  export interface NscInterconnectCreateGcpPartnerBody {
+    /**
+     * Path param: Customer account tag
+     */
+    account_id: string;
+
+    /**
+     * Body param:
+     */
+    account: string;
+
+    /**
+     * Body param: Bandwidth structure as visible through the customer-facing API.
+     */
+    bandwidth:
+      | '50M'
+      | '100M'
+      | '200M'
+      | '300M'
+      | '400M'
+      | '500M'
+      | '1G'
+      | '2G'
+      | '5G'
+      | '10G'
+      | '20G'
+      | '50G';
+
+    /**
+     * Body param: Pairing key provided by GCP
+     */
+    pairing_key: string;
+
+    /**
+     * Body param:
+     */
+    type: string;
+  }
+}
+
+export interface InterconnectListParams {
+  /**
+   * Path param: Customer account tag
+   */
+  account_id: string;
+
+  /**
+   * Query param:
+   */
+  cursor?: number | null;
+
+  /**
+   * Query param:
+   */
+  limit?: number | null;
+
+  /**
+   * Query param: If specified, only show interconnects located at the given site
+   */
+  site?: string | null;
+
+  /**
+   * Query param: If specified, only show interconnects of the given type
+   */
+  type?: string | null;
+}
+
+export interface InterconnectDeleteParams {
+  /**
+   * Customer account tag
+   */
+  account_id: string;
+}
+
+export interface InterconnectGetParams {
+  /**
+   * Customer account tag
+   */
+  account_id: string;
+}
+
+export interface InterconnectLOAParams {
+  /**
+   * Customer account tag
+   */
+  account_id: string;
+}
+
+export interface InterconnectStatusParams {
+  /**
+   * Customer account tag
+   */
+  account_id: string;
+}
+
+export declare namespace Interconnects {
+  export {
+    type InterconnectCreateResponse as InterconnectCreateResponse,
+    type InterconnectListResponse as InterconnectListResponse,
+    type InterconnectGetResponse as InterconnectGetResponse,
+    type InterconnectStatusResponse as InterconnectStatusResponse,
+    type InterconnectCreateParams as InterconnectCreateParams,
+    type InterconnectListParams as InterconnectListParams,
+    type InterconnectDeleteParams as InterconnectDeleteParams,
+    type InterconnectGetParams as InterconnectGetParams,
+    type InterconnectLOAParams as InterconnectLOAParams,
+    type InterconnectStatusParams as InterconnectStatusParams,
+  };
+}

package/src/resources/network-interconnects/network-interconnects.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as CNIsAPI from './cnis';
+import {
+  CNICreateParams,
+  CNICreateResponse,
+  CNIDeleteParams,
+  CNIGetParams,
+  CNIGetResponse,
+  CNIListParams,
+  CNIListResponse,
+  CNIUpdateParams,
+  CNIUpdateResponse,
+  CNIs,
+} from './cnis';
+import * as InterconnectsAPI from './interconnects';
+import {
+  InterconnectCreateParams,
+  InterconnectCreateResponse,
+  InterconnectDeleteParams,
+  InterconnectGetParams,
+  InterconnectGetResponse,
+  InterconnectLOAParams,
+  InterconnectListParams,
+  InterconnectListResponse,
+  InterconnectStatusParams,
+  InterconnectStatusResponse,
+  Interconnects,
+} from './interconnects';
+import * as SettingsAPI from './settings';
+import {
+  SettingGetParams,
+  SettingGetResponse,
+  SettingUpdateParams,
+  SettingUpdateResponse,
+  Settings,
+} from './settings';
+import * as SlotsAPI from './slots';
+import { SlotGetParams, SlotGetResponse, SlotListParams, SlotListResponse, Slots } from './slots';
+
+export class NetworkInterconnects extends APIResource {
+  cnis: CNIsAPI.CNIs = new CNIsAPI.CNIs(this._client);
+  interconnects: InterconnectsAPI.Interconnects = new InterconnectsAPI.Interconnects(this._client);
+  settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
+  slots: SlotsAPI.Slots = new SlotsAPI.Slots(this._client);
+}
+
+NetworkInterconnects.CNIs = CNIs;
+NetworkInterconnects.Interconnects = Interconnects;
+NetworkInterconnects.Settings = Settings;
+NetworkInterconnects.Slots = Slots;
+
+export declare namespace NetworkInterconnects {
+  export {
+    CNIs as CNIs,
+    type CNICreateResponse as CNICreateResponse,
+    type CNIUpdateResponse as CNIUpdateResponse,
+    type CNIListResponse as CNIListResponse,
+    type CNIGetResponse as CNIGetResponse,
+    type CNICreateParams as CNICreateParams,
+    type CNIUpdateParams as CNIUpdateParams,
+    type CNIListParams as CNIListParams,
+    type CNIDeleteParams as CNIDeleteParams,
+    type CNIGetParams as CNIGetParams,
+  };
+
+  export {
+    Interconnects as Interconnects,
+    type InterconnectCreateResponse as InterconnectCreateResponse,
+    type InterconnectListResponse as InterconnectListResponse,
+    type InterconnectGetResponse as InterconnectGetResponse,
+    type InterconnectStatusResponse as InterconnectStatusResponse,
+    type InterconnectCreateParams as InterconnectCreateParams,
+    type InterconnectListParams as InterconnectListParams,
+    type InterconnectDeleteParams as InterconnectDeleteParams,
+    type InterconnectGetParams as InterconnectGetParams,
+    type InterconnectLOAParams as InterconnectLOAParams,
+    type InterconnectStatusParams as InterconnectStatusParams,
+  };
+
+  export {
+    Settings as Settings,
+    type SettingUpdateResponse as SettingUpdateResponse,
+    type SettingGetResponse as SettingGetResponse,
+    type SettingUpdateParams as SettingUpdateParams,
+    type SettingGetParams as SettingGetParams,
+  };
+
+  export {
+    Slots as Slots,
+    type SlotListResponse as SlotListResponse,
+    type SlotGetResponse as SlotGetResponse,
+    type SlotListParams as SlotListParams,
+    type SlotGetParams as SlotGetParams,
+  };
+}

package/src/resources/network-interconnects/settings.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Settings extends APIResource {
+  /**
+   * Update the current settings for the active account
+   */
+  update(params: SettingUpdateParams, options?: Core.RequestOptions): Core.APIPromise<SettingUpdateResponse> {
+    const { account_id, ...body } = params;
+    return this._client.put(`/accounts/${account_id}/cni/settings`, { body, ...options });
+  }
+
+  /**
+   * Get the current settings for the active account
+   */
+  get(params: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse> {
+    const { account_id } = params;
+    return this._client.get(`/accounts/${account_id}/cni/settings`, options);
+  }
+}
+
+export interface SettingUpdateResponse {
+  default_asn?: number | null;
+}
+
+export interface SettingGetResponse {
+  default_asn?: number | null;
+}
+
+export interface SettingUpdateParams {
+  /**
+   * Path param: Account tag to update settings for
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  default_asn?: number | null;
+}
+
+export interface SettingGetParams {
+  /**
+   * Account tag to retrieve settings for
+   */
+  account_id: string;
+}
+
+export declare namespace Settings {
+  export {
+    type SettingUpdateResponse as SettingUpdateResponse,
+    type SettingGetResponse as SettingGetResponse,
+    type SettingUpdateParams as SettingUpdateParams,
+    type SettingGetParams as SettingGetParams,
+  };
+}

package/src/resources/network-interconnects/slots.ts

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Slots extends APIResource {
+  /**
+   * Retrieve a list of all slots matching the specified parameters
+   */
+  list(params: SlotListParams, options?: Core.RequestOptions): Core.APIPromise<SlotListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(`/accounts/${account_id}/cni/slots`, { query, ...options });
+  }
+
+  /**
+   * Get information about the specified slot
+   */
+  get(slot: string, params: SlotGetParams, options?: Core.RequestOptions): Core.APIPromise<SlotGetResponse> {
+    const { account_id } = params;
+    return this._client.get(`/accounts/${account_id}/cni/slots/${slot}`, options);
+  }
+}
+
+export interface SlotListResponse {
+  items: Array<SlotListResponse.Item>;
+
+  next?: number | null;
+}
+
+export namespace SlotListResponse {
+  export interface Item {
+    /**
+     * Slot ID
+     */
+    id: string;
+
+    facility: Item.Facility;
+
+    /**
+     * Whether the slot is occupied or not
+     */
+    occupied: boolean;
+
+    site: string;
+
+    speed: string;
+
+    /**
+     * Customer account tag
+     */
+    account?: string;
+  }
+
+  export namespace Item {
+    export interface Facility {
+      address: Array<string>;
+
+      name: string;
+    }
+  }
+}
+
+export interface SlotGetResponse {
+  /**
+   * Slot ID
+   */
+  id: string;
+
+  facility: SlotGetResponse.Facility;
+
+  /**
+   * Whether the slot is occupied or not
+   */
+  occupied: boolean;
+
+  site: string;
+
+  speed: string;
+
+  /**
+   * Customer account tag
+   */
+  account?: string;
+}
+
+export namespace SlotGetResponse {
+  export interface Facility {
+    address: Array<string>;
+
+    name: string;
+  }
+}
+
+export interface SlotListParams {
+  /**
+   * Path param: Customer account tag
+   */
+  account_id: string;
+
+  /**
+   * Query param: If specified, only show slots with the given text in their address
+   * field
+   */
+  address_contains?: string | null;
+
+  /**
+   * Query param:
+   */
+  cursor?: number | null;
+
+  /**
+   * Query param:
+   */
+  limit?: number | null;
+
+  /**
+   * Query param: If specified, only show slots with a specific occupied/unoccupied
+   * state
+   */
+  occupied?: boolean | null;
+
+  /**
+   * Query param: If specified, only show slots located at the given site
+   */
+  site?: string | null;
+
+  /**
+   * Query param: If specified, only show slots that support the given speed
+   */
+  speed?: string | null;
+}
+
+export interface SlotGetParams {
+  /**
+   * Customer account tag
+   */
+  account_id: string;
+}
+
+export declare namespace Slots {
+  export {
+    type SlotListResponse as SlotListResponse,
+    type SlotGetResponse as SlotGetResponse,
+    type SlotListParams as SlotListParams,
+    type SlotGetParams as SlotGetParams,
+  };
+}