@metronome/sdk 0.2.0 → 1.0.0

package/resources/v1/alerts.mjs

@@ -1,8 +1,52 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
+import { APIResource } from "../../core/resource.mjs";
 export class Alerts extends APIResource {
     /**
-     * Create a new alert
+     * Create a new alert to monitor customer spending, balances, and billing metrics
+     * in real-time. Metronome's alert system provides industry-leading speed with
+     * immediate evaluation capabilities, enabling you to proactively manage customer
+     * accounts and prevent revenue leakage.
+     *
+     * This endpoint creates configurable alerts that continuously monitor various
+     * billing thresholds including spend limits, credit balances, commitment
+     * utilization, and invoice totals. Alerts can be configured globally for all
+     * customers or targeted to specific customer accounts. Custom fields can be used
+     * on certain alert types to further target alerts to groups of customers.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Proactively monitor customer spending patterns to prevent unexpected overages
+     *   or credit exhaustion
+     * - Automate notifications when customers approach commitment limits or credit
+     *   thresholds
+     * - Enable real-time intervention for accounts at risk of churn or payment issues
+     * - Scale billing operations by automating threshold-based workflows and
+     *   notifications
+     *
+     * ### Key response fields:
+     *
+     * A successful response returns a CustomerAlert object containing:
+     *
+     * - The alert configuration with its unique ID and current status
+     * - The customer's evaluation status (ok, in_alarm, or evaluating)
+     * - Alert metadata including type, threshold values, and update timestamps
+     *
+     * ### Usage guidelines:
+     *
+     * - Immediate evaluation: Set `evaluate_on_create` : `true` (default) for instant
+     *   evaluation against existing customers
+     * - Uniqueness constraints: Each alert must have a unique `uniqueness_key` within
+     *   your organization. Use `release_uniqueness_key` : `true` when archiving to
+     *   reuse keys
+     * - Alert type requirements: Different alert types require specific fields (e.g.,
+     *   `billable_metric_id` for usage alerts, `credit_type_id` for credit-based
+     *   alerts)
+     * - Webhook delivery: Alerts trigger webhook notifications for real-time
+     *   integration with your systems. Configure webhook endpoints before creating
+     *   alerts
+     * - Performance at scale: Metronome's event-driven architecture processes alert
+     *   evaluations in real-time as usage events stream in, unlike competitors who
+     *   rely on periodic polling or batch evaluation cycles
      *
      * @example
      * ```ts
@@ -20,7 +64,33 @@ export class Alerts extends APIResource {
         return this._client.post('/v1/alerts/create', { body, ...options });
     }
     /**
-     * Archive an existing alert
+     * Permanently disable an alert and remove it from active monitoring across all
+     * customers. Archived alerts stop evaluating immediately and can optionally
+     * release their uniqueness key for reuse in future alert configurations.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Decommission alerts that are no longer needed
+     * - Clean up test or deprecated alert configurations
+     * - Free up uniqueness keys for reuse with new alerts
+     * - Stop alert evaluations without losing historical configuration data
+     * - Disable outdated monitoring rules during pricing model transitions
+     *
+     * ### Key response fields:
+     *
+     * - data: Object containing the archived alert's ID
+     * - Alert evaluation stops immediately for all affected customers
+     * - Historical alert data and configurations remain accessible for audit purposes
+     *
+     * ### Usage guidelines:
+     *
+     * - Irreversible for evaluation: Archived alerts cannot be re-enabled; create a
+     *   new alert to resume monitoring
+     * - Uniqueness key handling: Set `release_uniqueness_key` : `true` to reuse the
+     *   key in future alerts
+     * - Immediate effect: Alert evaluation stops instantly across all customers
+     * - Historical preservation: Archive operation maintains alert history and
+     *   configuration for compliance and auditing
      *
      * @example
      * ```ts

package/resources/v1/alerts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../../src/resources/v1/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,IAAwB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF"}
+{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../../src/resources/v1/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF"}

package/resources/v1/audit-logs.d.mts

@@ -0,0 +1,108 @@
+import { APIResource } from "../../core/resource.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class AuditLogs extends APIResource {
+    /**
+     * Get a comprehensive audit trail of all operations performed in your Metronome
+     * account, whether initiated through the API, web interface, or automated
+     * processes. This endpoint provides detailed logs of who did what and when,
+     * enabling compliance reporting, security monitoring, and operational
+     * troubleshooting across all interaction channels.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Monitor all account activity for security and compliance purposes
+     * - Track configuration changes regardless of source (API, UI, or system)
+     * - Investigate issues by reviewing historical operations
+     *
+     * ### Key response fields:
+     *
+     * An array of AuditLog objects containing:
+     *
+     * - id: Unique identifier for the audit log entry
+     * - timestamp: When the action occurred (RFC 3339 format)
+     * - actor: Information about who performed the action
+     * - request: Details including request ID, IP address, and user agent
+     * - `resource_type`: The type of resource affected (e.g., customer, contract,
+     *   invoice)
+     * - `resource_id`: The specific resource identifier
+     * - `action`: The operation performed
+     * - `next_page`: Cursor for continuous log retrieval
+     *
+     * ### Usage guidelines:
+     *
+     * - Continuous retrieval: The next_page token enables uninterrupted log
+     *   streaming—save it between requests to ensure no logs are missed
+     * - Empty responses: An empty data array means no new logs yet; continue polling
+     *   with the same next_page token
+     * - Date filtering:
+     *   - `starting_on`: Earliest logs to return (inclusive)
+     *   - `ending_before`: Latest logs to return (exclusive)
+     *   - Cannot be used with `next_page`
+     * - Resource filtering: Must specify both `resource_type` and `resource_id`
+     *   together
+     * - Sort order: Default is `date_asc`; use `date_desc` for newest first
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const auditLogListResponse of client.v1.auditLogs.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: AuditLogListParams | null | undefined, options?: RequestOptions): PagePromise<AuditLogListResponsesCursorPage, AuditLogListResponse>;
+}
+export type AuditLogListResponsesCursorPage = CursorPage<AuditLogListResponse>;
+export interface AuditLogListResponse {
+    id: string;
+    request: AuditLogListResponse.Request;
+    timestamp: string;
+    action?: string;
+    actor?: AuditLogListResponse.Actor;
+    description?: string;
+    resource_id?: string;
+    resource_type?: string;
+    status?: 'success' | 'failure' | 'pending';
+}
+export declare namespace AuditLogListResponse {
+    interface Request {
+        id: string;
+        ip?: string;
+        user_agent?: string;
+    }
+    interface Actor {
+        id: string;
+        name: string;
+        email?: string;
+    }
+}
+export interface AuditLogListParams extends CursorPageParams {
+    /**
+     * RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
+     */
+    ending_before?: string;
+    /**
+     * Optional parameter that can be used to filter which audit logs are returned. If
+     * you specify resource_id, you must also specify resource_type.
+     */
+    resource_id?: string;
+    /**
+     * Optional parameter that can be used to filter which audit logs are returned. If
+     * you specify resource_type, you must also specify resource_id.
+     */
+    resource_type?: string;
+    /**
+     * Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
+     */
+    sort?: 'date_asc' | 'date_desc';
+    /**
+     * RFC 3339 timestamp of the earliest audit log to return. Cannot be used with
+     * 'next_page'.
+     */
+    starting_on?: string;
+}
+export declare namespace AuditLogs {
+    export { type AuditLogListResponse as AuditLogListResponse, type AuditLogListResponsesCursorPage as AuditLogListResponsesCursorPage, type AuditLogListParams as AuditLogListParams, };
+}
+//# sourceMappingURL=audit-logs.d.mts.map

package/resources/v1/audit-logs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.d.mts","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEtC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC5C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/v1/audit-logs.d.ts

@@ -1,12 +1,47 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import { CursorPage, type CursorPageParams } from "../../pagination.js";
+import { APIResource } from "../../core/resource.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class AuditLogs extends APIResource {
     /**
-     * Retrieves a range of audit logs. If no further audit logs are currently
-     * available, the data array will be empty. As new audit logs are created,
-     * subsequent requests using the same next_page value will be in the returned data
-     * array, ensuring a continuous and uninterrupted reading of audit logs.
+     * Get a comprehensive audit trail of all operations performed in your Metronome
+     * account, whether initiated through the API, web interface, or automated
+     * processes. This endpoint provides detailed logs of who did what and when,
+     * enabling compliance reporting, security monitoring, and operational
+     * troubleshooting across all interaction channels.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Monitor all account activity for security and compliance purposes
+     * - Track configuration changes regardless of source (API, UI, or system)
+     * - Investigate issues by reviewing historical operations
+     *
+     * ### Key response fields:
+     *
+     * An array of AuditLog objects containing:
+     *
+     * - id: Unique identifier for the audit log entry
+     * - timestamp: When the action occurred (RFC 3339 format)
+     * - actor: Information about who performed the action
+     * - request: Details including request ID, IP address, and user agent
+     * - `resource_type`: The type of resource affected (e.g., customer, contract,
+     *   invoice)
+     * - `resource_id`: The specific resource identifier
+     * - `action`: The operation performed
+     * - `next_page`: Cursor for continuous log retrieval
+     *
+     * ### Usage guidelines:
+     *
+     * - Continuous retrieval: The next_page token enables uninterrupted log
+     *   streaming—save it between requests to ensure no logs are missed
+     * - Empty responses: An empty data array means no new logs yet; continue polling
+     *   with the same next_page token
+     * - Date filtering:
+     *   - `starting_on`: Earliest logs to return (inclusive)
+     *   - `ending_before`: Latest logs to return (exclusive)
+     *   - Cannot be used with `next_page`
+     * - Resource filtering: Must specify both `resource_type` and `resource_id`
+     *   together
+     * - Sort order: Default is `date_asc`; use `date_desc` for newest first
      *
      * @example
      * ```ts
@@ -16,11 +51,9 @@ export declare class AuditLogs extends APIResource {
      * }
      * ```
      */
-    list(query?: AuditLogListParams, options?: Core.RequestOptions): Core.PagePromise<AuditLogListResponsesCursorPage, AuditLogListResponse>;
-    list(options?: Core.RequestOptions): Core.PagePromise<AuditLogListResponsesCursorPage, AuditLogListResponse>;
-}
-export declare class AuditLogListResponsesCursorPage extends CursorPage<AuditLogListResponse> {
+    list(query?: AuditLogListParams | null | undefined, options?: RequestOptions): PagePromise<AuditLogListResponsesCursorPage, AuditLogListResponse>;
 }
+export type AuditLogListResponsesCursorPage = CursorPage<AuditLogListResponse>;
 export interface AuditLogListResponse {
     id: string;
     request: AuditLogListResponse.Request;
@@ -70,6 +103,6 @@ export interface AuditLogListParams extends CursorPageParams {
     starting_on?: string;
 }
 export declare namespace AuditLogs {
-    export { type AuditLogListResponse as AuditLogListResponse, AuditLogListResponsesCursorPage as AuditLogListResponsesCursorPage, type AuditLogListParams as AuditLogListParams, };
+    export { type AuditLogListResponse as AuditLogListResponse, type AuditLogListResponsesCursorPage as AuditLogListResponsesCursorPage, type AuditLogListParams as AuditLogListParams, };
 }
 //# sourceMappingURL=audit-logs.d.ts.map

package/resources/v1/audit-logs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"audit-logs.d.ts","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAC1E,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAU3E;AAED,qBAAa,+BAAgC,SAAQ,UAAU,CAAC,oBAAoB,CAAC;CAAG;AAExF,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEtC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC5C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,+BAA+B,IAAI,+BAA+B,EAClE,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"audit-logs.d.ts","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEtC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC5C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/v1/audit-logs.js

@@ -1,21 +1,62 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuditLogListResponsesCursorPage = exports.AuditLogs = void 0;
-const resource_1 = require("../../resource.js");
-const core_1 = require("../../core.js");
-const pagination_1 = require("../../pagination.js");
+exports.AuditLogs = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
 class AuditLogs extends resource_1.APIResource {
+    /**
+     * Get a comprehensive audit trail of all operations performed in your Metronome
+     * account, whether initiated through the API, web interface, or automated
+     * processes. This endpoint provides detailed logs of who did what and when,
+     * enabling compliance reporting, security monitoring, and operational
+     * troubleshooting across all interaction channels.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Monitor all account activity for security and compliance purposes
+     * - Track configuration changes regardless of source (API, UI, or system)
+     * - Investigate issues by reviewing historical operations
+     *
+     * ### Key response fields:
+     *
+     * An array of AuditLog objects containing:
+     *
+     * - id: Unique identifier for the audit log entry
+     * - timestamp: When the action occurred (RFC 3339 format)
+     * - actor: Information about who performed the action
+     * - request: Details including request ID, IP address, and user agent
+     * - `resource_type`: The type of resource affected (e.g., customer, contract,
+     *   invoice)
+     * - `resource_id`: The specific resource identifier
+     * - `action`: The operation performed
+     * - `next_page`: Cursor for continuous log retrieval
+     *
+     * ### Usage guidelines:
+     *
+     * - Continuous retrieval: The next_page token enables uninterrupted log
+     *   streaming—save it between requests to ensure no logs are missed
+     * - Empty responses: An empty data array means no new logs yet; continue polling
+     *   with the same next_page token
+     * - Date filtering:
+     *   - `starting_on`: Earliest logs to return (inclusive)
+     *   - `ending_before`: Latest logs to return (exclusive)
+     *   - Cannot be used with `next_page`
+     * - Resource filtering: Must specify both `resource_type` and `resource_id`
+     *   together
+     * - Sort order: Default is `date_asc`; use `date_desc` for newest first
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const auditLogListResponse of client.v1.auditLogs.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if ((0, core_1.isRequestOptions)(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/v1/auditLogs', AuditLogListResponsesCursorPage, { query, ...options });
+        return this._client.getAPIList('/v1/auditLogs', (pagination_1.CursorPage), { query, ...options });
     }
 }
 exports.AuditLogs = AuditLogs;
-class AuditLogListResponsesCursorPage extends pagination_1.CursorPage {
-}
-exports.AuditLogListResponsesCursorPage = AuditLogListResponsesCursorPage;
-AuditLogs.AuditLogListResponsesCursorPage = AuditLogListResponsesCursorPage;
 //# sourceMappingURL=audit-logs.js.map

package/resources/v1/audit-logs.js.map

@@ -1 +1 @@
-{"version":3,"file":"audit-logs.js","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAqE;AAErE,MAAa,SAAU,SAAQ,sBAAW;IAsBxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;CACF;AA/BD,8BA+BC;AAED,MAAa,+BAAgC,SAAQ,uBAAgC;CAAG;AAAxF,0EAAwF;AAsExF,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC"}
+{"version":3,"file":"audit-logs.js","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAClD,yDAAuF;AAGvF,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,uBAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AAxDD,8BAwDC"}

package/resources/v1/audit-logs.mjs

@@ -1,16 +1,58 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
-import { isRequestOptions } from "../../core.mjs";
-import { CursorPage } from "../../pagination.mjs";
+import { APIResource } from "../../core/resource.mjs";
+import { CursorPage } from "../../core/pagination.mjs";
 export class AuditLogs extends APIResource {
+    /**
+     * Get a comprehensive audit trail of all operations performed in your Metronome
+     * account, whether initiated through the API, web interface, or automated
+     * processes. This endpoint provides detailed logs of who did what and when,
+     * enabling compliance reporting, security monitoring, and operational
+     * troubleshooting across all interaction channels.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Monitor all account activity for security and compliance purposes
+     * - Track configuration changes regardless of source (API, UI, or system)
+     * - Investigate issues by reviewing historical operations
+     *
+     * ### Key response fields:
+     *
+     * An array of AuditLog objects containing:
+     *
+     * - id: Unique identifier for the audit log entry
+     * - timestamp: When the action occurred (RFC 3339 format)
+     * - actor: Information about who performed the action
+     * - request: Details including request ID, IP address, and user agent
+     * - `resource_type`: The type of resource affected (e.g., customer, contract,
+     *   invoice)
+     * - `resource_id`: The specific resource identifier
+     * - `action`: The operation performed
+     * - `next_page`: Cursor for continuous log retrieval
+     *
+     * ### Usage guidelines:
+     *
+     * - Continuous retrieval: The next_page token enables uninterrupted log
+     *   streaming—save it between requests to ensure no logs are missed
+     * - Empty responses: An empty data array means no new logs yet; continue polling
+     *   with the same next_page token
+     * - Date filtering:
+     *   - `starting_on`: Earliest logs to return (inclusive)
+     *   - `ending_before`: Latest logs to return (exclusive)
+     *   - Cannot be used with `next_page`
+     * - Resource filtering: Must specify both `resource_type` and `resource_id`
+     *   together
+     * - Sort order: Default is `date_asc`; use `date_desc` for newest first
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const auditLogListResponse of client.v1.auditLogs.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/v1/auditLogs', AuditLogListResponsesCursorPage, { query, ...options });
+        return this._client.getAPIList('/v1/auditLogs', (CursorPage), { query, ...options });
     }
 }
-export class AuditLogListResponsesCursorPage extends CursorPage {
-}
-AuditLogs.AuditLogListResponsesCursorPage = AuditLogListResponsesCursorPage;
 //# sourceMappingURL=audit-logs.mjs.map

package/resources/v1/audit-logs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"audit-logs.mjs","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,SAAU,SAAQ,WAAW;IAsBxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,UAAgC;CAAG;AAsExF,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC"}
+{"version":3,"file":"audit-logs.mjs","sourceRoot":"","sources":["../../src/resources/v1/audit-logs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAsC;AAGzD,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,UAAgC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}