cloudflare 4.2.0 → 4.4.0

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

@@ -9,6 +9,15 @@ export class CfInterconnects extends APIResource {
    * Updates a specific interconnect associated with an account. Use
    * `?validate_only=true` as an optional query parameter to only run validation
    * without persisting changes.
+   *
+   * @example
+   * ```ts
+   * const cfInterconnect =
+   *   await client.magicTransit.cfInterconnects.update(
+   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
    */
   update(
     cfInterconnectId: string,
@@ -32,6 +41,14 @@ export class CfInterconnects extends APIResource {
 
   /**
    * Lists interconnects associated with an account.
+   *
+   * @example
+   * ```ts
+   * const cfInterconnects =
+   *   await client.magicTransit.cfInterconnects.list({
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   });
+   * ```
    */
   list(
     params: CfInterconnectListParams,
@@ -55,6 +72,15 @@ export class CfInterconnects extends APIResource {
    * Updates multiple interconnects associated with an account. Use
    * `?validate_only=true` as an optional query parameter to only run validation
    * without persisting changes.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.magicTransit.cfInterconnects.bulkUpdate({
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     body: {},
+   *   });
+   * ```
    */
   bulkUpdate(
     params: CfInterconnectBulkUpdateParams,
@@ -77,6 +103,15 @@ export class CfInterconnects extends APIResource {
 
   /**
    * Lists details for a specific interconnect.
+   *
+   * @example
+   * ```ts
+   * const cfInterconnect =
+   *   await client.magicTransit.cfInterconnects.get(
+   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
    */
   get(
     cfInterconnectId: string,
@@ -107,7 +142,7 @@ export interface CfInterconnectUpdateResponse {
 export namespace CfInterconnectUpdateResponse {
   export interface ModifiedInterconnect {
     /**
-     * Tunnel identifier tag.
+     * Identifier
      */
     id?: string;
 
@@ -178,7 +213,7 @@ export interface CfInterconnectListResponse {
 export namespace CfInterconnectListResponse {
   export interface Interconnect {
     /**
-     * Tunnel identifier tag.
+     * Identifier
      */
     id?: string;
 
@@ -251,7 +286,7 @@ export interface CfInterconnectBulkUpdateResponse {
 export namespace CfInterconnectBulkUpdateResponse {
   export interface ModifiedInterconnect {
     /**
-     * Tunnel identifier tag.
+     * Identifier
      */
     id?: string;
 
@@ -322,7 +357,7 @@ export interface CfInterconnectGetResponse {
 export namespace CfInterconnectGetResponse {
   export interface Interconnect {
     /**
-     * Tunnel identifier tag.
+     * Identifier
      */
     id?: string;
 

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

@@ -2,16 +2,22 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import * as EventsAPI from './events';
-import { EventGetParams, EventGetResponse, EventListParams, EventListResponse, Events } from './events';
-import * as SnapshotsAPI from './snapshots';
+import * as EventsAPI from './events/events';
+import {
+  EventGetParams,
+  EventGetResponse,
+  EventListParams,
+  EventListResponse,
+  Events,
+} from './events/events';
+import * as SnapshotsAPI from './snapshots/snapshots';
 import {
   SnapshotGetParams,
   SnapshotGetResponse,
   SnapshotListParams,
   SnapshotListResponse,
   Snapshots,
-} from './snapshots';
+} from './snapshots/snapshots';
 import { SinglePage } from '../../../pagination';
 
 export class Connectors extends APIResource {
@@ -20,6 +26,15 @@ export class Connectors extends APIResource {
 
   /**
    * Replace Connector
+   *
+   * @example
+   * ```ts
+   * const connector =
+   *   await client.magicTransit.connectors.update(
+   *     'connector_id',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
    */
   update(
     connectorId: string,
@@ -37,6 +52,16 @@ export class Connectors extends APIResource {
 
   /**
    * List Connectors
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const connectorListResponse of client.magicTransit.connectors.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ConnectorListParams,
@@ -52,6 +77,14 @@ export class Connectors extends APIResource {
 
   /**
    * Update Connector
+   *
+   * @example
+   * ```ts
+   * const response = await client.magicTransit.connectors.edit(
+   *   'connector_id',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   edit(
     connectorId: string,
@@ -69,6 +102,14 @@ export class Connectors extends APIResource {
 
   /**
    * Fetch Connector
+   *
+   * @example
+   * ```ts
+   * const connector = await client.magicTransit.connectors.get(
+   *   'connector_id',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   get(
     connectorId: string,
@@ -209,7 +250,7 @@ export namespace ConnectorGetResponse {
 
 export interface ConnectorUpdateParams {
   /**
-   * Path param:
+   * Path param: Account identifier
    */
   account_id: string;
 
@@ -240,12 +281,15 @@ export interface ConnectorUpdateParams {
 }
 
 export interface ConnectorListParams {
+  /**
+   * Account identifier
+   */
   account_id: string;
 }
 
 export interface ConnectorEditParams {
   /**
-   * Path param:
+   * Path param: Account identifier
    */
   account_id: string;
 
@@ -276,6 +320,9 @@ export interface ConnectorEditParams {
 }
 
 export interface ConnectorGetParams {
+  /**
+   * Account identifier
+   */
   account_id: string;
 }
 

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

@@ -0,0 +1,305 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+import * as LatestAPI from './latest';
+import { Latest, LatestListParams, LatestListResponse } from './latest';
+
+export class Events extends APIResource {
+  latest: LatestAPI.Latest = new LatestAPI.Latest(this._client);
+
+  /**
+   * List Events
+   *
+   * @example
+   * ```ts
+   * const events =
+   *   await client.magicTransit.connectors.events.list(
+   *     'connector_id',
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       from: 0,
+   *       to: 0,
+   *     },
+   *   );
+   * ```
+   */
+  list(
+    connectorId: string,
+    params: EventListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EventListResponse> {
+    const { account_id, ...query } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/magic/connectors/${connectorId}/telemetry/events`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: EventListResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Get Event
+   *
+   * @example
+   * ```ts
+   * const event =
+   *   await client.magicTransit.connectors.events.get(
+   *     'connector_id',
+   *     0,
+   *     0,
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    connectorId: string,
+    eventT: number,
+    eventN: number,
+    params: EventGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EventGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/magic/connectors/${connectorId}/telemetry/events/${eventT}.${eventN}`,
+        options,
+      ) as Core.APIPromise<{ result: EventGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface EventListResponse {
+  count: number;
+
+  items: Array<EventListResponse.Item>;
+
+  cursor?: string;
+}
+
+export namespace EventListResponse {
+  export interface Item {
+    /**
+     * Time the Event was collected (seconds since the Unix epoch)
+     */
+    a: number;
+
+    /**
+     * Kind
+     */
+    k: string;
+
+    /**
+     * Sequence number, used to order events with the same timestamp
+     */
+    n: number;
+
+    /**
+     * Time the Event was recorded (seconds since the Unix epoch)
+     */
+    t: number;
+  }
+}
+
+/**
+ * Recorded Event
+ */
+export interface EventGetResponse {
+  e:
+    | EventGetResponse.Init
+    | EventGetResponse.Leave
+    | EventGetResponse.StartAttestation
+    | EventGetResponse.FinishAttestationSuccess
+    | EventGetResponse.FinishAttestationFailure
+    | EventGetResponse.StartRotateCryptKey
+    | EventGetResponse.FinishRotateCryptKeySuccess
+    | EventGetResponse.FinishRotateCryptKeyFailure
+    | EventGetResponse.StartRotatePki
+    | EventGetResponse.FinishRotatePkiSuccess
+    | EventGetResponse.FinishRotatePkiFailure
+    | EventGetResponse.StartUpgrade
+    | EventGetResponse.FinishUpgradeSuccess
+    | EventGetResponse.FinishUpgradeFailure
+    | EventGetResponse.Reconcile
+    | EventGetResponse.ConfigureCloudflaredTunnel;
+
+  /**
+   * Sequence number, used to order events with the same timestamp
+   */
+  n: number;
+
+  /**
+   * Time the Event was recorded (seconds since the Unix epoch)
+   */
+  t: number;
+}
+
+export namespace EventGetResponse {
+  export interface Init {
+    /**
+     * Initialized process
+     */
+    k: 'Init';
+  }
+
+  export interface Leave {
+    /**
+     * Stopped process
+     */
+    k: 'Leave';
+  }
+
+  export interface StartAttestation {
+    /**
+     * Started attestation
+     */
+    k: 'StartAttestation';
+  }
+
+  export interface FinishAttestationSuccess {
+    /**
+     * Finished attestation
+     */
+    k: 'FinishAttestationSuccess';
+  }
+
+  export interface FinishAttestationFailure {
+    /**
+     * Failed attestation
+     */
+    k: 'FinishAttestationFailure';
+  }
+
+  export interface StartRotateCryptKey {
+    /**
+     * Started crypt key rotation
+     */
+    k: 'StartRotateCryptKey';
+  }
+
+  export interface FinishRotateCryptKeySuccess {
+    /**
+     * Finished crypt key rotation
+     */
+    k: 'FinishRotateCryptKeySuccess';
+  }
+
+  export interface FinishRotateCryptKeyFailure {
+    /**
+     * Failed crypt key rotation
+     */
+    k: 'FinishRotateCryptKeyFailure';
+  }
+
+  export interface StartRotatePki {
+    /**
+     * Started PKI rotation
+     */
+    k: 'StartRotatePki';
+  }
+
+  export interface FinishRotatePkiSuccess {
+    /**
+     * Finished PKI rotation
+     */
+    k: 'FinishRotatePkiSuccess';
+  }
+
+  export interface FinishRotatePkiFailure {
+    /**
+     * Failed PKI rotation
+     */
+    k: 'FinishRotatePkiFailure';
+  }
+
+  export interface StartUpgrade {
+    /**
+     * Started upgrade
+     */
+    k: 'StartUpgrade';
+
+    /**
+     * Location of upgrade bundle
+     */
+    url: string;
+  }
+
+  export interface FinishUpgradeSuccess {
+    /**
+     * Finished upgrade
+     */
+    k: 'FinishUpgradeSuccess';
+  }
+
+  export interface FinishUpgradeFailure {
+    /**
+     * Failed upgrade
+     */
+    k: 'FinishUpgradeFailure';
+  }
+
+  export interface Reconcile {
+    /**
+     * Reconciled
+     */
+    k: 'Reconcile';
+  }
+
+  export interface ConfigureCloudflaredTunnel {
+    /**
+     * Configured Cloudflared tunnel
+     */
+    k: 'ConfigureCloudflaredTunnel';
+  }
+}
+
+export interface EventListParams {
+  /**
+   * Path param: Account identifier
+   */
+  account_id: string;
+
+  /**
+   * Query param:
+   */
+  from: number;
+
+  /**
+   * Query param:
+   */
+  to: number;
+
+  /**
+   * Query param:
+   */
+  cursor?: string;
+
+  /**
+   * Query param:
+   */
+  limit?: number;
+}
+
+export interface EventGetParams {
+  /**
+   * Account identifier
+   */
+  account_id: string;
+}
+
+Events.Latest = Latest;
+
+export declare namespace Events {
+  export {
+    type EventListResponse as EventListResponse,
+    type EventGetResponse as EventGetResponse,
+    type EventListParams as EventListParams,
+    type EventGetParams as EventGetParams,
+  };
+
+  export {
+    Latest as Latest,
+    type LatestListResponse as LatestListResponse,
+    type LatestListParams as LatestListParams,
+  };
+}

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

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Events,
+  type EventListResponse,
+  type EventGetResponse,
+  type EventListParams,
+  type EventGetParams,
+} from './events';
+export { Latest, type LatestListResponse, type LatestListParams } from './latest';