featurebase-node 0.13.0 → 0.14.1

package/resources/audit-logs.d.ts

@@ -0,0 +1,233 @@
+import { APIResource } from "../core/resource.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Audit logs provide a chronological record of significant admin actions in your organization. Use them for security auditing, compliance reporting, and tracking workspace changes.
+ */
+export declare class AuditLogs extends APIResource {
+    /**
+     * Returns a list of audit log events in your organization using cursor-based
+     * pagination (newest first).
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of events to return (1-100, default 10)
+     * - `cursor` - Cursor from a previous response for pagination
+     * - `action` - Filter by action type (e.g. `webhook.deleted`,
+     *   `security.sso_enabled`)
+     * - `domain` - Filter by domain/category (e.g. `security`, `messenger`)
+     * - `startDate` - Filter events created on or after this ISO 8601 datetime
+     * - `endDate` - Filter events created on or before this ISO 8601 datetime
+     *
+     * ### Filtering by Action
+     *
+     * The `action` parameter filters by event type. Each action follows the
+     * `{domain}.{verb}` convention. See the `action` enum in this schema for the full
+     * list of supported values.
+     *
+     * **Examples:**
+     *
+     * - `?action=security.sso_enabled` — only SSO enablement events
+     * - `?action=webhook.deleted` — only webhook deletion events
+     *
+     * ### Filtering by Domain
+     *
+     * Use the `domain` parameter to narrow results to one category of audit event.
+     *
+     * **Examples:**
+     *
+     * - `?domain=security` — only security-related audit events
+     * - `?domain=messenger` — only messenger-related audit events
+     *
+     * ### Filtering by Date Range
+     *
+     * Use `startDate` and `endDate` together or individually to narrow results to a
+     * time window.
+     *
+     * **Examples:**
+     *
+     * - `?startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z` — January 2025
+     *   only
+     * - `?startDate=2025-06-01T00:00:00Z` — from June 1st onward
+     *
+     * ### Pagination
+     *
+     * Results are ordered by `createdAt` descending (newest first). Use the
+     * `nextCursor` value from each response as the `cursor` parameter in the next
+     * request to paginate forward.
+     *
+     * ```
+     * GET /v2/audit-logs?limit=20
+     * → { "nextCursor": "eyJ..." }
+     *
+     * GET /v2/audit-logs?limit=20&cursor=eyJ...
+     * → { "nextCursor": null }   ← no more results
+     * ```
+     *
+     * ### Metadata
+     *
+     * The `metadata` field contains event-specific details (e.g. before/after state
+     * for updates). Its shape depends on the `action` type and is not strictly modeled
+     * in the schema — treat it as a free-form object.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always `"list"`
+     * - `data` - Array of audit log objects
+     * - `nextCursor` - Cursor for the next page, or `null` if no more results
+     *
+     * ### Audit Log Object
+     *
+     * Each audit log includes:
+     *
+     * - `id` - Unique event identifier (UUID)
+     * - `correlationId` - Groups related events from a single operation (e.g. bulk
+     *   import)
+     * - `action` - What happened (e.g. `webhook.deleted`)
+     * - `domain` - Category the action belongs to (e.g. `integrations`)
+     * - `description` - Human-readable description
+     * - `actor` - Who performed the action (id, type, email, name, apiKey)
+     * - `resource` - What was affected (type, id, name)
+     * - `request` - Request context (ipAddress, userAgent)
+     * - `metadata` - Event-specific payload
+     * - `createdAt` - When the event occurred
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params?: AuditLogListParams | null | undefined, options?: RequestOptions): PagePromise<AuditLogListResponsesCursorPage, AuditLogListResponse>;
+}
+export type AuditLogListResponsesCursorPage = CursorPage<AuditLogListResponse>;
+export interface AuditLogListResponse {
+    /**
+     * Unique event identifier
+     */
+    id: string;
+    /**
+     * The type of action that was performed
+     */
+    action: 'auth.login' | 'auth.logout' | 'auth.login_failed' | 'auth.password_reset_requested' | 'auth.password_changed' | 'auth.mfa_enabled' | 'auth.mfa_disabled' | 'auth.sso_login' | 'auth.password_reset_completed' | 'auth.unauthorized_method' | 'auth.recovery_code_regenerated' | 'auth.sso_enforcement_blocked' | 'auth.sso_enforcement_session_invalidated' | 'auth.managed_account_link_blocked' | 'auth.cross_org_invite_accepted' | 'auth.sso_enforcement_shadow' | 'teammate.invited' | 'teammate.joined' | 'teammate.removed' | 'teammate.email_changed' | 'teammate.name_changed' | 'teammate.seat_changed' | 'teammate.deactivated' | 'teammate.invite_changed' | 'teammate.invite_deleted' | 'teammate.scim_provisioned' | 'teammate.scim_deprovisioned' | 'teammate.scim_unlinked' | 'teammate.scim_relinked' | 'teammate.scim_operation_blocked' | 'teammate.scim_seat_capacity_blocked' | 'teammate.scim_email_updated' | 'teammate.scim_exclusion_list_updated' | 'teammate.restored' | 'teammate.scim_restored' | 'teammate.scim_auto_claimed' | 'teammate.scim_claim_role_preserved' | 'teammate.permanently_removed' | 'member.role_changed' | 'organization.owner_transferred' | 'article.created' | 'article.updated' | 'article.published' | 'article.unpublished' | 'article.deleted' | 'changelog.created' | 'changelog.published' | 'changelog.deleted' | 'changelog.unpublished' | 'settings.name_changed' | 'settings.branding_updated' | 'settings.custom_domain_changed' | 'settings.language_changed' | 'settings.timezone_changed' | 'settings.email_settings_changed' | 'settings.help_center_updated' | 'settings.moderation_changed' | 'settings.voting_changed' | 'settings.statuses_updated' | 'settings.boards_updated' | 'settings.privacy_changed' | 'settings.subdomain_changed' | 'settings.subdomain_change_requested' | 'settings.grace_period_changed' | 'security.scim_override_blocked' | 'security.sso_enabled' | 'security.sso_disabled' | 'security.sso_configured' | 'security.sso_jit_provisioning_blocked' | 'security.directory_sync_enabled' | 'security.directory_sync_disabled' | 'security.directory_sync_reconciled' | 'security.two_factor_enforced' | 'security.auth_method_changed' | 'security.ip_allowlist_changed' | 'security.ip_allowlist_blocked' | 'security.identity_verification_changed' | 'security.sso_url_changed' | 'security.sso_jit_provisioning_changed' | 'security.sso_enforcement_enabled' | 'security.sso_enforcement_disabled' | 'security.dsync_group_mappings_changed' | 'security.dsync_mapping_priority_changed' | 'security.user_banned' | 'security.user_unbanned' | 'integration.installed' | 'integration.uninstalled' | 'integration.configured' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted' | 'webhook.secret_rotated' | 'api_key.created' | 'api_key.regenerated' | 'api_key.deleted' | 'organization.deletion_scheduled' | 'organization.deletion_cancelled' | 'data.export_initiated' | 'data.import_initiated' | 'data.bulk_delete' | 'data.user_data_deleted' | 'data.csv_exported' | 'billing.plan_changed' | 'billing.plan_cancelled' | 'billing.seat_limit_changed' | 'billing.seat_activated' | 'workflow.created' | 'workflow.activated' | 'workflow.deactivated' | 'workflow.deleted' | 'workflow.updated' | 'messenger.look_and_feel_changed' | 'messenger.spaces_changed' | 'messenger.language_changed' | 'messenger.platform_availability_changed' | 'messenger.search_browse_changed' | 'messenger.email_collection_changed' | 'messenger.welcome_message_changed' | 'messenger.launcher_changed' | 'messenger.inbound_conversations_changed' | 'messenger.office_hours_changed' | 'messenger.identity_verification_changed' | 'messenger.privacy_policy_changed' | 'brand.created' | 'brand.updated' | 'brand.deleted' | 'brand.messenger_look_and_feel_changed' | 'brand.messenger_launcher_changed' | 'brand.messenger_welcome_message_changed' | 'brand.messenger_privacy_policy_changed' | 'brand.default_changed' | 'ai_agent.enabled' | 'ai_agent.disabled' | 'ai_agent.identity_changed' | 'ai_agent.customization_changed' | 'ai_agent.guidance_changed' | 'ai_agent.multilingual_changed' | 'ai_agent.data_context_changed' | 'email.sending_address_created' | 'email.sending_address_updated' | 'email.sending_address_deleted' | 'email.domain_registered' | 'email.domain_deleted' | 'email.reply_to_changed' | 'email.ignored_address_added' | 'email.ignored_address_removed';
+    actor: AuditLogListResponse.Actor;
+    /**
+     * Groups related events from a single operation (e.g. bulk import)
+     */
+    correlationId: string | null;
+    /**
+     * ISO 8601 timestamp of when the event occurred
+     */
+    createdAt: string;
+    /**
+     * Pre-rendered human-readable description of the event
+     */
+    description: string;
+    /**
+     * The domain/category the action belongs to
+     */
+    domain: 'authentication' | 'team_management' | 'permissions' | 'articles' | 'changelog' | 'workspace_settings' | 'security' | 'integrations' | 'data_management' | 'billing' | 'workflows' | 'messenger' | 'brands' | 'ai_agent' | 'email_config';
+    /**
+     * Event-specific payload with before/after state when applicable. The shape of
+     * this object depends on the action type.
+     */
+    metadata: {
+        [key: string]: unknown;
+    };
+    /**
+     * Object type identifier
+     */
+    object: 'audit_log';
+    request: AuditLogListResponse.Request;
+    resource: AuditLogListResponse.Resource;
+}
+export declare namespace AuditLogListResponse {
+    interface Actor {
+        /**
+         * Featurebase user ID of the actor, or null for system actors
+         */
+        id: string | null;
+        /**
+         * API key that authenticated the request, or null for dashboard sessions
+         */
+        apiKey: Actor.APIKey | null;
+        /**
+         * Email address of the actor
+         */
+        email: string;
+        /**
+         * Display name of the actor
+         */
+        name: string | null;
+        /**
+         * The type of actor that performed the action
+         */
+        type: 'admin' | 'system' | 'api_key' | 'integration';
+    }
+    namespace Actor {
+        /**
+         * API key that authenticated the request, or null for dashboard sessions
+         */
+        interface APIKey {
+            /**
+             * API key ID
+             */
+            id: string;
+            /**
+             * API key name
+             */
+            name: string;
+        }
+    }
+    interface Request {
+        /**
+         * IP address the request originated from
+         */
+        ipAddress: string | null;
+        /**
+         * User-Agent header from the request
+         */
+        userAgent: string | null;
+    }
+    interface Resource {
+        /**
+         * ID of the affected resource, or null for organization-level events
+         */
+        id: string | null;
+        /**
+         * Display name of the affected resource
+         */
+        name: string | null;
+        /**
+         * Type of the affected resource
+         */
+        type: string;
+    }
+}
+export interface AuditLogListParams extends CursorPageParams {
+    /**
+     * Query param: Filter audit logs by action type
+     */
+    action?: 'auth.login' | 'auth.logout' | 'auth.login_failed' | 'auth.password_reset_requested' | 'auth.password_changed' | 'auth.mfa_enabled' | 'auth.mfa_disabled' | 'auth.sso_login' | 'auth.password_reset_completed' | 'auth.unauthorized_method' | 'auth.recovery_code_regenerated' | 'auth.sso_enforcement_blocked' | 'auth.sso_enforcement_session_invalidated' | 'auth.managed_account_link_blocked' | 'auth.cross_org_invite_accepted' | 'auth.sso_enforcement_shadow' | 'teammate.invited' | 'teammate.joined' | 'teammate.removed' | 'teammate.email_changed' | 'teammate.name_changed' | 'teammate.seat_changed' | 'teammate.deactivated' | 'teammate.invite_changed' | 'teammate.invite_deleted' | 'teammate.scim_provisioned' | 'teammate.scim_deprovisioned' | 'teammate.scim_unlinked' | 'teammate.scim_relinked' | 'teammate.scim_operation_blocked' | 'teammate.scim_seat_capacity_blocked' | 'teammate.scim_email_updated' | 'teammate.scim_exclusion_list_updated' | 'teammate.restored' | 'teammate.scim_restored' | 'teammate.scim_auto_claimed' | 'teammate.scim_claim_role_preserved' | 'teammate.permanently_removed' | 'member.role_changed' | 'organization.owner_transferred' | 'article.created' | 'article.updated' | 'article.published' | 'article.unpublished' | 'article.deleted' | 'changelog.created' | 'changelog.published' | 'changelog.deleted' | 'changelog.unpublished' | 'settings.name_changed' | 'settings.branding_updated' | 'settings.custom_domain_changed' | 'settings.language_changed' | 'settings.timezone_changed' | 'settings.email_settings_changed' | 'settings.help_center_updated' | 'settings.moderation_changed' | 'settings.voting_changed' | 'settings.statuses_updated' | 'settings.boards_updated' | 'settings.privacy_changed' | 'settings.subdomain_changed' | 'settings.subdomain_change_requested' | 'settings.grace_period_changed' | 'security.scim_override_blocked' | 'security.sso_enabled' | 'security.sso_disabled' | 'security.sso_configured' | 'security.sso_jit_provisioning_blocked' | 'security.directory_sync_enabled' | 'security.directory_sync_disabled' | 'security.directory_sync_reconciled' | 'security.two_factor_enforced' | 'security.auth_method_changed' | 'security.ip_allowlist_changed' | 'security.ip_allowlist_blocked' | 'security.identity_verification_changed' | 'security.sso_url_changed' | 'security.sso_jit_provisioning_changed' | 'security.sso_enforcement_enabled' | 'security.sso_enforcement_disabled' | 'security.dsync_group_mappings_changed' | 'security.dsync_mapping_priority_changed' | 'security.user_banned' | 'security.user_unbanned' | 'integration.installed' | 'integration.uninstalled' | 'integration.configured' | 'webhook.created' | 'webhook.updated' | 'webhook.deleted' | 'webhook.secret_rotated' | 'api_key.created' | 'api_key.regenerated' | 'api_key.deleted' | 'organization.deletion_scheduled' | 'organization.deletion_cancelled' | 'data.export_initiated' | 'data.import_initiated' | 'data.bulk_delete' | 'data.user_data_deleted' | 'data.csv_exported' | 'billing.plan_changed' | 'billing.plan_cancelled' | 'billing.seat_limit_changed' | 'billing.seat_activated' | 'workflow.created' | 'workflow.activated' | 'workflow.deactivated' | 'workflow.deleted' | 'workflow.updated' | 'messenger.look_and_feel_changed' | 'messenger.spaces_changed' | 'messenger.language_changed' | 'messenger.platform_availability_changed' | 'messenger.search_browse_changed' | 'messenger.email_collection_changed' | 'messenger.welcome_message_changed' | 'messenger.launcher_changed' | 'messenger.inbound_conversations_changed' | 'messenger.office_hours_changed' | 'messenger.identity_verification_changed' | 'messenger.privacy_policy_changed' | 'brand.created' | 'brand.updated' | 'brand.deleted' | 'brand.messenger_look_and_feel_changed' | 'brand.messenger_launcher_changed' | 'brand.messenger_welcome_message_changed' | 'brand.messenger_privacy_policy_changed' | 'brand.default_changed' | 'ai_agent.enabled' | 'ai_agent.disabled' | 'ai_agent.identity_changed' | 'ai_agent.customization_changed' | 'ai_agent.guidance_changed' | 'ai_agent.multilingual_changed' | 'ai_agent.data_context_changed' | 'email.sending_address_created' | 'email.sending_address_updated' | 'email.sending_address_deleted' | 'email.domain_registered' | 'email.domain_deleted' | 'email.reply_to_changed' | 'email.ignored_address_added' | 'email.ignored_address_removed';
+    /**
+     * Query param: Filter audit logs by domain/category
+     */
+    domain?: 'authentication' | 'team_management' | 'permissions' | 'articles' | 'changelog' | 'workspace_settings' | 'security' | 'integrations' | 'data_management' | 'billing' | 'workflows' | 'messenger' | 'brands' | 'ai_agent' | 'email_config';
+    /**
+     * Query param: Filter events created on or before this ISO 8601 datetime
+     */
+    endDate?: string | null;
+    /**
+     * Query param: Filter events created on or after this ISO 8601 datetime
+     */
+    startDate?: string | null;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+}
+export declare namespace AuditLogs {
+    export { type AuditLogListResponse as AuditLogListResponse, type AuditLogListResponsesCursorPage as AuditLogListResponsesCursorPage, type AuditLogListParams as AuditLogListParams, };
+}
+//# sourceMappingURL=audit-logs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.d.ts","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AAEpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4FG;IACH,IAAI,CACF,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAetE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EACF,YAAY,GACZ,aAAa,GACb,mBAAmB,GACnB,+BAA+B,GAC/B,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,+BAA+B,GAC/B,0BAA0B,GAC1B,gCAAgC,GAChC,8BAA8B,GAC9B,0CAA0C,GAC1C,mCAAmC,GACnC,gCAAgC,GAChC,6BAA6B,GAC7B,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,wBAAwB,GACxB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,yBAAyB,GACzB,yBAAyB,GACzB,2BAA2B,GAC3B,6BAA6B,GAC7B,wBAAwB,GACxB,wBAAwB,GACxB,iCAAiC,GACjC,qCAAqC,GACrC,6BAA6B,GAC7B,sCAAsC,GACtC,mBAAmB,GACnB,wBAAwB,GACxB,4BAA4B,GAC5B,oCAAoC,GACpC,8BAA8B,GAC9B,qBAAqB,GACrB,gCAAgC,GAChC,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,gCAAgC,GAChC,2BAA2B,GAC3B,2BAA2B,GAC3B,iCAAiC,GACjC,8BAA8B,GAC9B,6BAA6B,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,yBAAyB,GACzB,0BAA0B,GAC1B,4BAA4B,GAC5B,qCAAqC,GACrC,+BAA+B,GAC/B,gCAAgC,GAChC,sBAAsB,GACtB,uBAAuB,GACvB,yBAAyB,GACzB,uCAAuC,GACvC,iCAAiC,GACjC,kCAAkC,GAClC,oCAAoC,GACpC,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,+BAA+B,GAC/B,wCAAwC,GACxC,0BAA0B,GAC1B,uCAAuC,GACvC,kCAAkC,GAClC,mCAAmC,GACnC,uCAAuC,GACvC,yCAAyC,GACzC,sBAAsB,GACtB,wBAAwB,GACxB,uBAAuB,GACvB,yBAAyB,GACzB,wBAAwB,GACxB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iCAAiC,GACjC,iCAAiC,GACjC,uBAAuB,GACvB,uBAAuB,GACvB,kBAAkB,GAClB,wBAAwB,GACxB,mBAAmB,GACnB,sBAAsB,GACtB,wBAAwB,GACxB,4BAA4B,GAC5B,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAC5B,yCAAyC,GACzC,iCAAiC,GACjC,oCAAoC,GACpC,mCAAmC,GACnC,4BAA4B,GAC5B,yCAAyC,GACzC,gCAAgC,GAChC,yCAAyC,GACzC,kCAAkC,GAClC,eAAe,GACf,eAAe,GACf,eAAe,GACf,uCAAuC,GACvC,kCAAkC,GAClC,yCAAyC,GACzC,wCAAwC,GACxC,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,2BAA2B,GAC3B,gCAAgC,GAChC,2BAA2B,GAC3B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,yBAAyB,GACzB,sBAAsB,GACtB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,CAAC;IAEpC,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAElC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,UAAU,GACV,WAAW,GACX,oBAAoB,GACpB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,GACV,cAAc,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEtC,QAAQ,EAAE,oBAAoB,CAAC,QAAQ,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;KACtD;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EACH,YAAY,GACZ,aAAa,GACb,mBAAmB,GACnB,+BAA+B,GAC/B,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,+BAA+B,GAC/B,0BAA0B,GAC1B,gCAAgC,GAChC,8BAA8B,GAC9B,0CAA0C,GAC1C,mCAAmC,GACnC,gCAAgC,GAChC,6BAA6B,GAC7B,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,wBAAwB,GACxB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,yBAAyB,GACzB,yBAAyB,GACzB,2BAA2B,GAC3B,6BAA6B,GAC7B,wBAAwB,GACxB,wBAAwB,GACxB,iCAAiC,GACjC,qCAAqC,GACrC,6BAA6B,GAC7B,sCAAsC,GACtC,mBAAmB,GACnB,wBAAwB,GACxB,4BAA4B,GAC5B,oCAAoC,GACpC,8BAA8B,GAC9B,qBAAqB,GACrB,gCAAgC,GAChC,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,gCAAgC,GAChC,2BAA2B,GAC3B,2BAA2B,GAC3B,iCAAiC,GACjC,8BAA8B,GAC9B,6BAA6B,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,yBAAyB,GACzB,0BAA0B,GAC1B,4BAA4B,GAC5B,qCAAqC,GACrC,+BAA+B,GAC/B,gCAAgC,GAChC,sBAAsB,GACtB,uBAAuB,GACvB,yBAAyB,GACzB,uCAAuC,GACvC,iCAAiC,GACjC,kCAAkC,GAClC,oCAAoC,GACpC,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,+BAA+B,GAC/B,wCAAwC,GACxC,0BAA0B,GAC1B,uCAAuC,GACvC,kCAAkC,GAClC,mCAAmC,GACnC,uCAAuC,GACvC,yCAAyC,GACzC,sBAAsB,GACtB,wBAAwB,GACxB,uBAAuB,GACvB,yBAAyB,GACzB,wBAAwB,GACxB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iCAAiC,GACjC,iCAAiC,GACjC,uBAAuB,GACvB,uBAAuB,GACvB,kBAAkB,GAClB,wBAAwB,GACxB,mBAAmB,GACnB,sBAAsB,GACtB,wBAAwB,GACxB,4BAA4B,GAC5B,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAC5B,yCAAyC,GACzC,iCAAiC,GACjC,oCAAoC,GACpC,mCAAmC,GACnC,4BAA4B,GAC5B,yCAAyC,GACzC,gCAAgC,GAChC,yCAAyC,GACzC,kCAAkC,GAClC,eAAe,GACf,eAAe,GACf,eAAe,GACf,uCAAuC,GACvC,kCAAkC,GAClC,yCAAyC,GACzC,wCAAwC,GACxC,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,2BAA2B,GAC3B,gCAAgC,GAChC,2BAA2B,GAC3B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,+BAA+B,GAC/B,yBAAyB,GACzB,sBAAsB,GACtB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EACH,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,UAAU,GACV,WAAW,GACX,oBAAoB,GACpB,UAAU,GACV,cAAc,GACd,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,GACV,cAAc,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;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/audit-logs.js

@@ -0,0 +1,122 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogs = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const headers_1 = require("../internal/headers.js");
+/**
+ * Audit logs provide a chronological record of significant admin actions in your organization. Use them for security auditing, compliance reporting, and tracking workspace changes.
+ */
+class AuditLogs extends resource_1.APIResource {
+    /**
+     * Returns a list of audit log events in your organization using cursor-based
+     * pagination (newest first).
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of events to return (1-100, default 10)
+     * - `cursor` - Cursor from a previous response for pagination
+     * - `action` - Filter by action type (e.g. `webhook.deleted`,
+     *   `security.sso_enabled`)
+     * - `domain` - Filter by domain/category (e.g. `security`, `messenger`)
+     * - `startDate` - Filter events created on or after this ISO 8601 datetime
+     * - `endDate` - Filter events created on or before this ISO 8601 datetime
+     *
+     * ### Filtering by Action
+     *
+     * The `action` parameter filters by event type. Each action follows the
+     * `{domain}.{verb}` convention. See the `action` enum in this schema for the full
+     * list of supported values.
+     *
+     * **Examples:**
+     *
+     * - `?action=security.sso_enabled` — only SSO enablement events
+     * - `?action=webhook.deleted` — only webhook deletion events
+     *
+     * ### Filtering by Domain
+     *
+     * Use the `domain` parameter to narrow results to one category of audit event.
+     *
+     * **Examples:**
+     *
+     * - `?domain=security` — only security-related audit events
+     * - `?domain=messenger` — only messenger-related audit events
+     *
+     * ### Filtering by Date Range
+     *
+     * Use `startDate` and `endDate` together or individually to narrow results to a
+     * time window.
+     *
+     * **Examples:**
+     *
+     * - `?startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z` — January 2025
+     *   only
+     * - `?startDate=2025-06-01T00:00:00Z` — from June 1st onward
+     *
+     * ### Pagination
+     *
+     * Results are ordered by `createdAt` descending (newest first). Use the
+     * `nextCursor` value from each response as the `cursor` parameter in the next
+     * request to paginate forward.
+     *
+     * ```
+     * GET /v2/audit-logs?limit=20
+     * → { "nextCursor": "eyJ..." }
+     *
+     * GET /v2/audit-logs?limit=20&cursor=eyJ...
+     * → { "nextCursor": null }   ← no more results
+     * ```
+     *
+     * ### Metadata
+     *
+     * The `metadata` field contains event-specific details (e.g. before/after state
+     * for updates). Its shape depends on the `action` type and is not strictly modeled
+     * in the schema — treat it as a free-form object.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always `"list"`
+     * - `data` - Array of audit log objects
+     * - `nextCursor` - Cursor for the next page, or `null` if no more results
+     *
+     * ### Audit Log Object
+     *
+     * Each audit log includes:
+     *
+     * - `id` - Unique event identifier (UUID)
+     * - `correlationId` - Groups related events from a single operation (e.g. bulk
+     *   import)
+     * - `action` - What happened (e.g. `webhook.deleted`)
+     * - `domain` - Category the action belongs to (e.g. `integrations`)
+     * - `description` - Human-readable description
+     * - `actor` - Who performed the action (id, type, email, name, apiKey)
+     * - `resource` - What was affected (type, id, name)
+     * - `request` - Request context (ipAddress, userAgent)
+     * - `metadata` - Event-specific payload
+     * - `createdAt` - When the event occurred
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.getAPIList('/v2/audit-logs', (pagination_1.CursorPage), {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.AuditLogs = AuditLogs;
+//# sourceMappingURL=audit-logs.js.map

package/resources/audit-logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.js","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAoF;AACpF,oDAAmD;AAGnD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4FG;IACH,IAAI,CACF,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,uBAAgC,CAAA,EAAE;YACjF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAhHD,8BAgHC"}

package/resources/audit-logs.mjs

@@ -0,0 +1,118 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+/**
+ * Audit logs provide a chronological record of significant admin actions in your organization. Use them for security auditing, compliance reporting, and tracking workspace changes.
+ */
+export class AuditLogs extends APIResource {
+    /**
+     * Returns a list of audit log events in your organization using cursor-based
+     * pagination (newest first).
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of events to return (1-100, default 10)
+     * - `cursor` - Cursor from a previous response for pagination
+     * - `action` - Filter by action type (e.g. `webhook.deleted`,
+     *   `security.sso_enabled`)
+     * - `domain` - Filter by domain/category (e.g. `security`, `messenger`)
+     * - `startDate` - Filter events created on or after this ISO 8601 datetime
+     * - `endDate` - Filter events created on or before this ISO 8601 datetime
+     *
+     * ### Filtering by Action
+     *
+     * The `action` parameter filters by event type. Each action follows the
+     * `{domain}.{verb}` convention. See the `action` enum in this schema for the full
+     * list of supported values.
+     *
+     * **Examples:**
+     *
+     * - `?action=security.sso_enabled` — only SSO enablement events
+     * - `?action=webhook.deleted` — only webhook deletion events
+     *
+     * ### Filtering by Domain
+     *
+     * Use the `domain` parameter to narrow results to one category of audit event.
+     *
+     * **Examples:**
+     *
+     * - `?domain=security` — only security-related audit events
+     * - `?domain=messenger` — only messenger-related audit events
+     *
+     * ### Filtering by Date Range
+     *
+     * Use `startDate` and `endDate` together or individually to narrow results to a
+     * time window.
+     *
+     * **Examples:**
+     *
+     * - `?startDate=2025-01-01T00:00:00Z&endDate=2025-01-31T23:59:59Z` — January 2025
+     *   only
+     * - `?startDate=2025-06-01T00:00:00Z` — from June 1st onward
+     *
+     * ### Pagination
+     *
+     * Results are ordered by `createdAt` descending (newest first). Use the
+     * `nextCursor` value from each response as the `cursor` parameter in the next
+     * request to paginate forward.
+     *
+     * ```
+     * GET /v2/audit-logs?limit=20
+     * → { "nextCursor": "eyJ..." }
+     *
+     * GET /v2/audit-logs?limit=20&cursor=eyJ...
+     * → { "nextCursor": null }   ← no more results
+     * ```
+     *
+     * ### Metadata
+     *
+     * The `metadata` field contains event-specific details (e.g. before/after state
+     * for updates). Its shape depends on the `action` type and is not strictly modeled
+     * in the schema — treat it as a free-form object.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always `"list"`
+     * - `data` - Array of audit log objects
+     * - `nextCursor` - Cursor for the next page, or `null` if no more results
+     *
+     * ### Audit Log Object
+     *
+     * Each audit log includes:
+     *
+     * - `id` - Unique event identifier (UUID)
+     * - `correlationId` - Groups related events from a single operation (e.g. bulk
+     *   import)
+     * - `action` - What happened (e.g. `webhook.deleted`)
+     * - `domain` - Category the action belongs to (e.g. `integrations`)
+     * - `description` - Human-readable description
+     * - `actor` - Who performed the action (id, type, email, name, apiKey)
+     * - `resource` - What was affected (type, id, name)
+     * - `request` - Request context (ipAddress, userAgent)
+     * - `metadata` - Event-specific payload
+     * - `createdAt` - When the event occurred
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.getAPIList('/v2/audit-logs', (CursorPage), {
+            query,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=audit-logs.mjs.map

package/resources/audit-logs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.mjs","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AACpF,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAGnD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4FG;IACH,IAAI,CACF,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,UAAgC,CAAA,EAAE;YACjF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}