@augno/sdk 0.1.6

package/src/resources/core/audit-events.ts

@@ -0,0 +1,862 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RequestLogsAPI from './request-logs';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and retrieve audit events.
+ */
+export class AuditEvents extends APIResource {
+  /**
+   * Returns an audit event by ID.
+   *
+   * @example
+   * ```ts
+   * const auditEvent = await client.core.auditEvents.retrieve(
+   *   'ae_01b1c07dc3085bbd84111edcbd',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: AuditEventRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AuditEvent> {
+    return this._client.get(path`/v1/core/audit-events/${id}`, { query, ...options });
+  }
+
+  /**
+   * Returns a paginated list of audit events for the current account.
+   *
+   * @example
+   * ```ts
+   * const listAuditEvent = await client.core.auditEvents.list();
+   * ```
+   */
+  list(
+    query: AuditEventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListAuditEvent> {
+    return this._client.get('/v1/core/audit-events', { query, ...options });
+  }
+
+  /**
+   * Returns the full set of resource types that may appear on audit events.
+   *
+   * @example
+   * ```ts
+   * const listObjectType =
+   *   await client.core.auditEvents.retrieveResourceTypes();
+   * ```
+   */
+  retrieveResourceTypes(options?: RequestOptions): APIPromise<ListObjectType> {
+    return this._client.get('/v1/core/audit-events/resource-types', options);
+  }
+}
+
+/**
+ * Immutable audit event record. Captures the actor, changed resource, and
+ * timestamp.
+ */
+export interface AuditEvent {
+  /**
+   * Audit event ID.
+   */
+  id: string;
+
+  /**
+   * Mutation type.
+   */
+  action: 'create' | 'update' | 'delete' | 'restore' | 'archive';
+
+  /**
+   * Reference to an actor (user, API key, or agent).
+   */
+  actor: RequestLogsAPI.Actor | null;
+
+  /**
+   * List represents a paginated list of resources.
+   */
+  changes: ListAuditFieldChange | null;
+
+  /**
+   * When the audit event record was created.
+   */
+  created_at: string;
+
+  /**
+   * Idempotency key of the originating request.
+   */
+  idempotency_key: string | null;
+
+  /**
+   * Arbitrary JSON metadata for the mutation (e.g. reason, source, tags). Encoded as
+   * a JSON value (object, array, string, number, boolean, or null), not a
+   * JSON-encoded string.
+   */
+  metadata: unknown | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'audit_event';
+
+  /**
+   * When the audited mutation occurred.
+   */
+  occurred_at: string;
+
+  /**
+   * RequestLog is an API request log entry.
+   */
+  request: RequestLogsAPI.RequestLog | null;
+
+  /**
+   * Audited resource ID.
+   */
+  resource_id: string;
+
+  /**
+   * Resource type of the audited entity.
+   */
+  resource_type:
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'plan_change'
+    | 'enterprise_inquiry'
+    | 'request_log'
+    | 'audit_event'
+    | 'audit_field_change'
+    | 'role'
+    | 'unit'
+    | 'account_affiliation'
+    | 'agent_definition'
+    | 'available_tool'
+    | 'agent_definition_tool'
+    | 'agent_account_status'
+    | 'agent_run'
+    | 'agent_action'
+    | 'agent_run_step'
+    | 'agent_token_usage'
+    | 'agent_memory'
+    | 'agent_alert'
+    | 'tool_group'
+    | 'payment_term'
+    | 'shipping_term'
+    | 'quantity'
+    | 'account_group'
+    | 'account_status'
+    | 'geolocation'
+    | 'account_user'
+    | 'department'
+    | 'account_integration'
+    | 'account_price'
+    | 'product_line'
+    | 'item_category'
+    | 'attribute'
+    | 'rate'
+    | 'account_group_product_line_access'
+    | 'sales_target'
+    | 'adjustment_type'
+    | 'account_branding'
+    | 'account_portal'
+    | 'account_logo_url'
+    | 'public_account'
+    | 'property'
+    | 'carrier'
+    | 'service_level'
+    | 'item'
+    | 'item_inventory'
+    | 'product'
+    | 'batch'
+    | 'batch_flow_node'
+    | 'scanning_consumption'
+    | 'open_batch_summary'
+    | 'scanning_production_step_info'
+    | 'scanning_station'
+    | 'production_step'
+    | 'production_run'
+    | 'machine'
+    | 'child_account'
+    | 'unit_group'
+    | 'unit_group_unit'
+    | 'consumption'
+    | 'customer_product_line_access'
+    | 'customer'
+    | 'frequently_ordered_product'
+    | 'priority'
+    | 'delivery'
+    | 'delivery_line'
+    | 'sales_order'
+    | 'sales_order_line'
+    | 'sales_order_type'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'inventory_change_log'
+    | 'invoice'
+    | 'invoice_summary'
+    | 'invoice_line'
+    | 'invoice_allocation'
+    | 'invoice_for_payment'
+    | 'shipment'
+    | 'shipment_summary'
+    | 'shipment_line'
+    | 'shipping_case'
+    | 'shipping_case_label_url'
+    | 'settlement'
+    | 'settlement_summary'
+    | 'role_permission'
+    | 'registration_flow'
+    | 'registration_flow_option'
+    | 'transaction'
+    | 'transaction_summary'
+    | 'transaction_method'
+    | 'transaction_type'
+    | 'transaction_allocation'
+    | 'usage_item'
+    | 'agent_token_detail'
+    | 'account_usage_response'
+    | 'subscription_info'
+    | 'billing_portal_session_response'
+    | 'switch_plan_response'
+    | 'ensure_billing_customer_response'
+    | 'spending_cap_response'
+    | 'agent_spend_info'
+    | 'webhook_response'
+    | 'address_suggestion'
+    | 'address_components'
+    | 'address_details_result'
+    | 'validated_address'
+    | 'plan_limit'
+    | 'plan_change_proration'
+    | 'plan_change_line_item'
+    | 'setup_billing_response'
+    | 'confirm_payment_response'
+    | 'oauth_response'
+    | 'oauth_status_response'
+    | 'stripe_publishable_key'
+    | 'stripe_status'
+    | 'healthcheck'
+    | 'agent_definition_config'
+    | 'trigger_config'
+    | 'customer_contact_info'
+    | 'customer_freight_preferences'
+    | 'customer_defaults'
+    | 'customer_notification_preferences'
+    | 'order_discount'
+    | 'sales_order_status'
+    | 'material'
+    | 'supplier_material'
+    | 'part'
+    | 'permission_group'
+    | 'permission'
+    | 'pick'
+    | 'pick_line'
+    | 'product_type'
+    | 'production'
+    | 'production_flow'
+    | 'map'
+    | 'purchase_order'
+    | 'purchase_order_line'
+    | 'supplier'
+    | 'supplier_summary'
+    | 'receivable_entry'
+    | 'receiving_order'
+    | 'receiving_order_line'
+    | 'email_contact'
+    | 'allocation_entry'
+    | 'open_credit_entry'
+    | 'volume_discount'
+    | 'volume_discount_tier'
+    | 'analyze_deliveries_response'
+    | 'analyze_manufacturing_response'
+    | 'analyze_manufacturing_batch_response'
+    | 'analyze_quarterly_orders_response'
+    | 'analyze_new_customers_response'
+    | 'analyze_oee_response'
+    | 'catalog_product_line'
+    | 'catalog_category'
+    | 'catalog_product'
+    | 'catalog_property'
+    | 'catalog_attribute'
+    | 'dc_location'
+    | 'edi_run'
+    | 'inventory_item'
+    | 'analyze_weeks_of_sales_response'
+    | 'bulk_reconcile_items_response'
+    | 'sys_property'
+    | 'sys_property_type'
+    | 'sys_property_value'
+    | 'territory'
+    | 'tenancy'
+    | 'checkout_session'
+    | 'estimate_rate_result'
+    | 'rate_shop_option'
+    | 'rate_shop_result'
+    | 'owner'
+    | 'message'
+    | 'account_plan';
+
+  /**
+   * Originating client IP address.
+   */
+  source_ip: string | null;
+}
+
+/**
+ * Field-level before/after transition recorded during a mutation.
+ */
+export interface AuditFieldChange {
+  /**
+   * Name of the changed field.
+   */
+  field: string;
+
+  /**
+   * New value as a JSON fragment. Null for deletion events. Encoded as a JSON value
+   * (object, array, string, number, boolean, or null), not a JSON-encoded string.
+   */
+  new_value: unknown | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'audit_field_change';
+
+  /**
+   * Previous value as a JSON fragment. Null for creation events. Encoded as a JSON
+   * value (object, array, string, number, boolean, or null), not a JSON-encoded
+   * string.
+   */
+  old_value: unknown | null;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAuditEvent {
+  /**
+   * Resources in this page.
+   */
+  data: Array<AuditEvent>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAuditFieldChange {
+  /**
+   * Resources in this page.
+   */
+  data: Array<AuditFieldChange>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListObjectType {
+  /**
+   * Resources in this page.
+   */
+  data: Array<
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'plan_change'
+    | 'enterprise_inquiry'
+    | 'request_log'
+    | 'audit_event'
+    | 'audit_field_change'
+    | 'role'
+    | 'unit'
+    | 'account_affiliation'
+    | 'agent_definition'
+    | 'available_tool'
+    | 'agent_definition_tool'
+    | 'agent_account_status'
+    | 'agent_run'
+    | 'agent_action'
+    | 'agent_run_step'
+    | 'agent_token_usage'
+    | 'agent_memory'
+    | 'agent_alert'
+    | 'tool_group'
+    | 'payment_term'
+    | 'shipping_term'
+    | 'quantity'
+    | 'account_group'
+    | 'account_status'
+    | 'geolocation'
+    | 'account_user'
+    | 'department'
+    | 'account_integration'
+    | 'account_price'
+    | 'product_line'
+    | 'item_category'
+    | 'attribute'
+    | 'rate'
+    | 'account_group_product_line_access'
+    | 'sales_target'
+    | 'adjustment_type'
+    | 'account_branding'
+    | 'account_portal'
+    | 'account_logo_url'
+    | 'public_account'
+    | 'property'
+    | 'carrier'
+    | 'service_level'
+    | 'item'
+    | 'item_inventory'
+    | 'product'
+    | 'batch'
+    | 'batch_flow_node'
+    | 'scanning_consumption'
+    | 'open_batch_summary'
+    | 'scanning_production_step_info'
+    | 'scanning_station'
+    | 'production_step'
+    | 'production_run'
+    | 'machine'
+    | 'child_account'
+    | 'unit_group'
+    | 'unit_group_unit'
+    | 'consumption'
+    | 'customer_product_line_access'
+    | 'customer'
+    | 'frequently_ordered_product'
+    | 'priority'
+    | 'delivery'
+    | 'delivery_line'
+    | 'sales_order'
+    | 'sales_order_line'
+    | 'sales_order_type'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'inventory_change_log'
+    | 'invoice'
+    | 'invoice_summary'
+    | 'invoice_line'
+    | 'invoice_allocation'
+    | 'invoice_for_payment'
+    | 'shipment'
+    | 'shipment_summary'
+    | 'shipment_line'
+    | 'shipping_case'
+    | 'shipping_case_label_url'
+    | 'settlement'
+    | 'settlement_summary'
+    | 'role_permission'
+    | 'registration_flow'
+    | 'registration_flow_option'
+    | 'transaction'
+    | 'transaction_summary'
+    | 'transaction_method'
+    | 'transaction_type'
+    | 'transaction_allocation'
+    | 'usage_item'
+    | 'agent_token_detail'
+    | 'account_usage_response'
+    | 'subscription_info'
+    | 'billing_portal_session_response'
+    | 'switch_plan_response'
+    | 'ensure_billing_customer_response'
+    | 'spending_cap_response'
+    | 'agent_spend_info'
+    | 'webhook_response'
+    | 'address_suggestion'
+    | 'address_components'
+    | 'address_details_result'
+    | 'validated_address'
+    | 'plan_limit'
+    | 'plan_change_proration'
+    | 'plan_change_line_item'
+    | 'setup_billing_response'
+    | 'confirm_payment_response'
+    | 'oauth_response'
+    | 'oauth_status_response'
+    | 'stripe_publishable_key'
+    | 'stripe_status'
+    | 'healthcheck'
+    | 'agent_definition_config'
+    | 'trigger_config'
+    | 'customer_contact_info'
+    | 'customer_freight_preferences'
+    | 'customer_defaults'
+    | 'customer_notification_preferences'
+    | 'order_discount'
+    | 'sales_order_status'
+    | 'material'
+    | 'supplier_material'
+    | 'part'
+    | 'permission_group'
+    | 'permission'
+    | 'pick'
+    | 'pick_line'
+    | 'product_type'
+    | 'production'
+    | 'production_flow'
+    | 'map'
+    | 'purchase_order'
+    | 'purchase_order_line'
+    | 'supplier'
+    | 'supplier_summary'
+    | 'receivable_entry'
+    | 'receiving_order'
+    | 'receiving_order_line'
+    | 'email_contact'
+    | 'allocation_entry'
+    | 'open_credit_entry'
+    | 'volume_discount'
+    | 'volume_discount_tier'
+    | 'analyze_deliveries_response'
+    | 'analyze_manufacturing_response'
+    | 'analyze_manufacturing_batch_response'
+    | 'analyze_quarterly_orders_response'
+    | 'analyze_new_customers_response'
+    | 'analyze_oee_response'
+    | 'catalog_product_line'
+    | 'catalog_category'
+    | 'catalog_product'
+    | 'catalog_property'
+    | 'catalog_attribute'
+    | 'dc_location'
+    | 'edi_run'
+    | 'inventory_item'
+    | 'analyze_weeks_of_sales_response'
+    | 'bulk_reconcile_items_response'
+    | 'sys_property'
+    | 'sys_property_type'
+    | 'sys_property_value'
+    | 'territory'
+    | 'tenancy'
+    | 'checkout_session'
+    | 'estimate_rate_result'
+    | 'rate_shop_option'
+    | 'rate_shop_result'
+    | 'owner'
+    | 'message'
+    | 'account_plan'
+  >;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface AuditEventRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'actor' | 'changes' | 'metadata' | 'request'>;
+}
+
+export interface AuditEventListParams {
+  /**
+   * Filter by the audit actions.
+   */
+  actions?: Array<'create' | 'update' | 'delete' | 'restore' | 'archive'>;
+
+  /**
+   * Filter by the actor identifier.
+   *
+   * Will be `account_user.id` when `identity_type`=`user` or an `api_key.id` when
+   * `identity_type`=`api_key`.
+   */
+  actor_ids?: Array<string>;
+
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Restricts results to audit events on or before this timestamp.
+   */
+  end_date?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'actor' | 'changes' | 'metadata' | 'request'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Filter by the audited resource IDs.
+   */
+  resource_ids?: Array<string>;
+
+  /**
+   * Filter by the resource type of the audited entity.
+   */
+  resource_types?: Array<
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'plan_change'
+    | 'enterprise_inquiry'
+    | 'request_log'
+    | 'audit_event'
+    | 'audit_field_change'
+    | 'role'
+    | 'unit'
+    | 'account_affiliation'
+    | 'agent_definition'
+    | 'available_tool'
+    | 'agent_definition_tool'
+    | 'agent_account_status'
+    | 'agent_run'
+    | 'agent_action'
+    | 'agent_run_step'
+    | 'agent_token_usage'
+    | 'agent_memory'
+    | 'agent_alert'
+    | 'tool_group'
+    | 'payment_term'
+    | 'shipping_term'
+    | 'quantity'
+    | 'account_group'
+    | 'account_status'
+    | 'geolocation'
+    | 'account_user'
+    | 'department'
+    | 'account_integration'
+    | 'account_price'
+    | 'product_line'
+    | 'item_category'
+    | 'attribute'
+    | 'rate'
+    | 'account_group_product_line_access'
+    | 'sales_target'
+    | 'adjustment_type'
+    | 'account_branding'
+    | 'account_portal'
+    | 'account_logo_url'
+    | 'public_account'
+    | 'property'
+    | 'carrier'
+    | 'service_level'
+    | 'item'
+    | 'item_inventory'
+    | 'product'
+    | 'batch'
+    | 'batch_flow_node'
+    | 'scanning_consumption'
+    | 'open_batch_summary'
+    | 'scanning_production_step_info'
+    | 'scanning_station'
+    | 'production_step'
+    | 'production_run'
+    | 'machine'
+    | 'child_account'
+    | 'unit_group'
+    | 'unit_group_unit'
+    | 'consumption'
+    | 'customer_product_line_access'
+    | 'customer'
+    | 'frequently_ordered_product'
+    | 'priority'
+    | 'delivery'
+    | 'delivery_line'
+    | 'sales_order'
+    | 'sales_order_line'
+    | 'sales_order_type'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'inventory_change_log'
+    | 'invoice'
+    | 'invoice_summary'
+    | 'invoice_line'
+    | 'invoice_allocation'
+    | 'invoice_for_payment'
+    | 'shipment'
+    | 'shipment_summary'
+    | 'shipment_line'
+    | 'shipping_case'
+    | 'shipping_case_label_url'
+    | 'settlement'
+    | 'settlement_summary'
+    | 'role_permission'
+    | 'registration_flow'
+    | 'registration_flow_option'
+    | 'transaction'
+    | 'transaction_summary'
+    | 'transaction_method'
+    | 'transaction_type'
+    | 'transaction_allocation'
+    | 'usage_item'
+    | 'agent_token_detail'
+    | 'account_usage_response'
+    | 'subscription_info'
+    | 'billing_portal_session_response'
+    | 'switch_plan_response'
+    | 'ensure_billing_customer_response'
+    | 'spending_cap_response'
+    | 'agent_spend_info'
+    | 'webhook_response'
+    | 'address_suggestion'
+    | 'address_components'
+    | 'address_details_result'
+    | 'validated_address'
+    | 'plan_limit'
+    | 'plan_change_proration'
+    | 'plan_change_line_item'
+    | 'setup_billing_response'
+    | 'confirm_payment_response'
+    | 'oauth_response'
+    | 'oauth_status_response'
+    | 'stripe_publishable_key'
+    | 'stripe_status'
+    | 'healthcheck'
+    | 'agent_definition_config'
+    | 'trigger_config'
+    | 'customer_contact_info'
+    | 'customer_freight_preferences'
+    | 'customer_defaults'
+    | 'customer_notification_preferences'
+    | 'order_discount'
+    | 'sales_order_status'
+    | 'material'
+    | 'supplier_material'
+    | 'part'
+    | 'permission_group'
+    | 'permission'
+    | 'pick'
+    | 'pick_line'
+    | 'product_type'
+    | 'production'
+    | 'production_flow'
+    | 'map'
+    | 'purchase_order'
+    | 'purchase_order_line'
+    | 'supplier'
+    | 'supplier_summary'
+    | 'receivable_entry'
+    | 'receiving_order'
+    | 'receiving_order_line'
+    | 'email_contact'
+    | 'allocation_entry'
+    | 'open_credit_entry'
+    | 'volume_discount'
+    | 'volume_discount_tier'
+    | 'analyze_deliveries_response'
+    | 'analyze_manufacturing_response'
+    | 'analyze_manufacturing_batch_response'
+    | 'analyze_quarterly_orders_response'
+    | 'analyze_new_customers_response'
+    | 'analyze_oee_response'
+    | 'catalog_product_line'
+    | 'catalog_category'
+    | 'catalog_product'
+    | 'catalog_property'
+    | 'catalog_attribute'
+    | 'dc_location'
+    | 'edi_run'
+    | 'inventory_item'
+    | 'analyze_weeks_of_sales_response'
+    | 'bulk_reconcile_items_response'
+    | 'sys_property'
+    | 'sys_property_type'
+    | 'sys_property_value'
+    | 'territory'
+    | 'tenancy'
+    | 'checkout_session'
+    | 'estimate_rate_result'
+    | 'rate_shop_option'
+    | 'rate_shop_result'
+    | 'owner'
+    | 'message'
+    | 'account_plan'
+  >;
+
+  /**
+   * Restricts results to audit events on or after this timestamp.
+   */
+  start_date?: string;
+}
+
+export declare namespace AuditEvents {
+  export {
+    type AuditEvent as AuditEvent,
+    type AuditFieldChange as AuditFieldChange,
+    type ListAuditEvent as ListAuditEvent,
+    type ListAuditFieldChange as ListAuditFieldChange,
+    type ListObjectType as ListObjectType,
+    type AuditEventRetrieveParams as AuditEventRetrieveParams,
+    type AuditEventListParams as AuditEventListParams,
+  };
+}