@augno/sdk 0.1.9 → 0.7.1

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

@@ -12,41 +12,50 @@ import { path } from '../../internal/utils/path';
  */
 export class AuditEvents extends APIResource {
   /**
-   * Returns an audit event by ID.
+   * Returns a paginated list of audit events for the current account.
+   *
+   * This endpoint requires the permission: `audit_events:read`.
    *
    * @example
    * ```ts
-   * const auditEvent = await client.core.auditEvents.retrieve(
-   *   'ae_01b1c07dc3085bbd84111edcbd',
-   * );
+   * const listAuditEvent = await client.core.auditEvents.list();
    * ```
    */
-  retrieve(
-    id: string,
-    query: AuditEventRetrieveParams | null | undefined = {},
+  list(
+    query: AuditEventListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<AuditEvent> {
-    return this._client.get(path`/v1/core/audit-events/${id}`, { query, ...options });
+  ): APIPromise<ListAuditEvent> {
+    return this._client.get('/v1/core/audit-events', { query, ...options });
   }
 
   /**
-   * Returns a paginated list of audit events for the current account.
+   * Returns an audit event by ID.
+   *
+   * This endpoint requires the permission: `audit_events:read`.
    *
    * @example
    * ```ts
-   * const listAuditEvent = await client.core.auditEvents.list();
+   * const auditEvent = await client.core.auditEvents.retrieve(
+   *   'ae_01b1c07dc3085bbd84111edcbd',
+   * );
    * ```
    */
-  list(
-    query: AuditEventListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    query: AuditEventRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ListAuditEvent> {
-    return this._client.get('/v1/core/audit-events', { query, ...options });
+  ): APIPromise<AuditEvent> {
+    return this._client.get(path`/v1/core/audit-events/${id}`, { query, ...options });
   }
 
   /**
    * Returns the full set of resource types that may appear on audit events.
    *
+   * Values are plain strings, suitable for the `resource_types` filter when listing
+   * audit events.
+   *
+   * This endpoint requires the permission: `audit_events:read`.
+   *
    * @example
    * ```ts
    * const listObjectType =
@@ -59,8 +68,9 @@ export class AuditEvents extends APIResource {
 }
 
 /**
- * Immutable audit event record. Captures the actor, changed resource, and
- * timestamp.
+ * Immutable audit event record.
+ *
+ * Captures the actor, changed resource, and timestamp.
  */
 export interface AuditEvent {
   /**
@@ -69,12 +79,28 @@ export interface AuditEvent {
   id: string;
 
   /**
-   * Mutation type.
+   * A customer account, including its branding and customer portal sub-resources.
+   */
+  account: APIKeysAPI.Account | null;
+
+  /**
+   * The type of action this event records.
+   *
+   * - `create`: the resource was created.
+   * - `update`: one or more fields were changed.
+   * - `delete`: the resource was deleted.
+   * - `restore`: a previously deleted resource was restored.
+   * - `archive`: the resource was archived.
+   * - `approve`: a human approved a gated action, such as allowing a review-gated
+   *   agent tool to run.
+   * - `deny`: a human denied a gated action, such as rejecting a review-gated agent
+   *   tool.
    */
-  action: 'create' | 'update' | 'delete' | 'restore' | 'archive';
+  action: 'create' | 'update' | 'delete' | 'restore' | 'archive' | 'approve' | 'deny';
 
   /**
-   * Reference to an actor (user, API key, or agent).
+   * Reference to an actor — the user, API key, agent, or group identity associated
+   * with an action.
    */
   actor: RequestLogsAPI.Actor | null;
 
@@ -111,7 +137,7 @@ export interface AuditEvent {
   occurred_at: string;
 
   /**
-   * RequestLog is an API request log entry.
+   * A log of a single API request, capturing its route, outcome, latency, and actor.
    */
   request: RequestLogsAPI.RequestLog | null;
 
@@ -131,6 +157,7 @@ export interface AuditEvent {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -140,6 +167,7 @@ export interface AuditEvent {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -157,12 +185,30 @@ export interface AuditEvent {
     | 'agent_run_step'
     | 'agent_token_usage'
     | 'agent_memory'
-    | 'agent_alert'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'conversation_participant'
+    | 'chat_message'
+    | 'notification_unread_summary_account'
+    | 'messaging_block'
+    | 'notification_preference'
+    | 'message_attachment'
+    | 'attachment_upload_target'
+    | 'scheduled_message'
+    | 'messaging_contact'
+    | 'message_report'
     | 'tool_group'
+    | 'model'
     | 'payment_term'
     | 'shipping_term'
     | 'quantity'
     | 'account_group'
+    | 'support_route'
+    | 'support_availability'
     | 'account_status'
     | 'geolocation'
     | 'account_user'
@@ -206,12 +252,12 @@ export interface AuditEvent {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
     | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
     | 'inventory_change_log'
     | 'invoice'
     | 'invoice_summary'
@@ -234,7 +280,6 @@ export interface AuditEvent {
     | 'transaction_type'
     | 'transaction_allocation'
     | 'usage_item'
-    | 'agent_token_detail'
     | 'account_usage_response'
     | 'subscription_info'
     | 'billing_portal_session_response'
@@ -264,6 +309,8 @@ export interface AuditEvent {
     | 'customer_defaults'
     | 'customer_notification_preferences'
     | 'order_discount'
+    | 'sales_order_line'
+    | 'sales_order_type'
     | 'sales_order_status'
     | 'material'
     | 'supplier_material'
@@ -314,8 +361,31 @@ export interface AuditEvent {
     | 'rate_shop_option'
     | 'rate_shop_result'
     | 'owner'
+    | 'created_by'
     | 'message'
-    | 'account_plan';
+    | 'account_photo_upload_result'
+    | 'user_photo_upload_result'
+    | 'user_photo_url'
+    | 'batch_lot'
+    | 'check_duplicate_result'
+    | 'item_trend_point'
+    | 'pack_pick_response'
+    | 'pick_shipments_response'
+    | 'tenancy_pending_registration'
+    | 'invoice_allocation_entry'
+    | 'allocation_customer'
+    | 'checkout_sales_order_response'
+    | 'create_production_run_response'
+    | 'sales_order_price_quote'
+    | 'hubspot_sync_job'
+    | 'hubspot_sync_report'
+    | 'hubspot_company_review'
+    | 'hubspot_company_candidate'
+    | 'contact_match'
+    | 'reply_draft'
+    | 'conversation_link'
+    | 'messaging_group'
+    | 'messaging_group_member';
 
   /**
    * Originating client IP address.
@@ -333,8 +403,10 @@ export interface AuditFieldChange {
   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 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;
 
@@ -344,9 +416,10 @@ export interface AuditFieldChange {
   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.
+   * 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;
 }
@@ -406,6 +479,7 @@ export interface ListObjectType {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -415,6 +489,7 @@ export interface ListObjectType {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -432,12 +507,30 @@ export interface ListObjectType {
     | 'agent_run_step'
     | 'agent_token_usage'
     | 'agent_memory'
-    | 'agent_alert'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'conversation_participant'
+    | 'chat_message'
+    | 'notification_unread_summary_account'
+    | 'messaging_block'
+    | 'notification_preference'
+    | 'message_attachment'
+    | 'attachment_upload_target'
+    | 'scheduled_message'
+    | 'messaging_contact'
+    | 'message_report'
     | 'tool_group'
+    | 'model'
     | 'payment_term'
     | 'shipping_term'
     | 'quantity'
     | 'account_group'
+    | 'support_route'
+    | 'support_availability'
     | 'account_status'
     | 'geolocation'
     | 'account_user'
@@ -481,12 +574,12 @@ export interface ListObjectType {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
     | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
     | 'inventory_change_log'
     | 'invoice'
     | 'invoice_summary'
@@ -509,7 +602,6 @@ export interface ListObjectType {
     | 'transaction_type'
     | 'transaction_allocation'
     | 'usage_item'
-    | 'agent_token_detail'
     | 'account_usage_response'
     | 'subscription_info'
     | 'billing_portal_session_response'
@@ -539,6 +631,8 @@ export interface ListObjectType {
     | 'customer_defaults'
     | 'customer_notification_preferences'
     | 'order_discount'
+    | 'sales_order_line'
+    | 'sales_order_type'
     | 'sales_order_status'
     | 'material'
     | 'supplier_material'
@@ -589,8 +683,31 @@ export interface ListObjectType {
     | 'rate_shop_option'
     | 'rate_shop_result'
     | 'owner'
+    | 'created_by'
     | 'message'
-    | 'account_plan'
+    | 'account_photo_upload_result'
+    | 'user_photo_upload_result'
+    | 'user_photo_url'
+    | 'batch_lot'
+    | 'check_duplicate_result'
+    | 'item_trend_point'
+    | 'pack_pick_response'
+    | 'pick_shipments_response'
+    | 'tenancy_pending_registration'
+    | 'invoice_allocation_entry'
+    | 'allocation_customer'
+    | 'checkout_sales_order_response'
+    | 'create_production_run_response'
+    | 'sales_order_price_quote'
+    | 'hubspot_sync_job'
+    | 'hubspot_sync_report'
+    | 'hubspot_company_review'
+    | 'hubspot_company_candidate'
+    | 'contact_match'
+    | 'reply_draft'
+    | 'conversation_link'
+    | 'messaging_group'
+    | 'messaging_group_member'
   >;
 
   /**
@@ -604,30 +721,41 @@ export interface ListObjectType {
   page_info: APIKeysAPI.PageInfo;
 }
 
-export interface AuditEventRetrieveParams {
+export interface AuditEventListParams {
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Filter by the mutation type recorded on the event.
    */
-  include?: Array<'actor' | 'changes' | 'metadata' | 'request'>;
-}
+  actions?: Array<'create' | 'update' | 'delete' | 'restore' | 'archive' | 'approve' | 'deny'>;
 
-export interface AuditEventListParams {
   /**
-   * Filter by the audit actions.
+   * Filter by the _acting_ account: the account that performed the mutation.
+   *
+   * Results are always scoped to events where your account is either the acting
+   * account or the target account; this narrows that set to specific acting accounts
+   * — for example a specific customer's account that mutated a resource on your
+   * account.
    */
-  actions?: Array<'create' | 'update' | 'delete' | 'restore' | 'archive'>;
+  actor_account_ids?: Array<string>;
 
   /**
    * Filter by the actor identifier.
    *
-   * Will be `user.id` when `identity_type`=`user` or an `api_key.id` when
-   * `identity_type`=`api_key`.
+   * Matches the event's `actor.id`: a user ID for `user` actors or an API key ID for
+   * `api_key` actors.
    */
   actor_ids?: Array<string>;
 
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Filter by the actor type.
+   */
+  actor_types?: Array<'user' | 'api_key' | 'agent' | 'group'>;
+
+  /**
+   * Opaque cursor token identifying where the page of results starts.
+   *
+   * Use the `cursor` value embedded in a previous response's `next_page_url` or
+   * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+   * page.
    */
   cursor?: string;
 
@@ -640,15 +768,17 @@ export interface AuditEventListParams {
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
    * `null`.
    */
-  include?: Array<'actor' | 'changes' | 'metadata' | 'request'>;
+  include?: Array<'account' | 'actor' | 'changes' | 'metadata' | 'request'>;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Maximum number of results to return in a single page.
    */
   limit?: number;
 
   /**
-   * Search query used to filter results.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
   q?: string;
 
@@ -659,6 +789,9 @@ export interface AuditEventListParams {
 
   /**
    * Filter by the resource type of the audited entity.
+   *
+   * The full set of valid values is available from the List Audit Event Resource
+   * Types endpoint.
    */
   resource_types?: Array<
     | 'account'
@@ -668,6 +801,7 @@ export interface AuditEventListParams {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -677,6 +811,7 @@ export interface AuditEventListParams {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -694,12 +829,30 @@ export interface AuditEventListParams {
     | 'agent_run_step'
     | 'agent_token_usage'
     | 'agent_memory'
-    | 'agent_alert'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'conversation_participant'
+    | 'chat_message'
+    | 'notification_unread_summary_account'
+    | 'messaging_block'
+    | 'notification_preference'
+    | 'message_attachment'
+    | 'attachment_upload_target'
+    | 'scheduled_message'
+    | 'messaging_contact'
+    | 'message_report'
     | 'tool_group'
+    | 'model'
     | 'payment_term'
     | 'shipping_term'
     | 'quantity'
     | 'account_group'
+    | 'support_route'
+    | 'support_availability'
     | 'account_status'
     | 'geolocation'
     | 'account_user'
@@ -743,12 +896,12 @@ export interface AuditEventListParams {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
     | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
     | 'inventory_change_log'
     | 'invoice'
     | 'invoice_summary'
@@ -771,7 +924,6 @@ export interface AuditEventListParams {
     | 'transaction_type'
     | 'transaction_allocation'
     | 'usage_item'
-    | 'agent_token_detail'
     | 'account_usage_response'
     | 'subscription_info'
     | 'billing_portal_session_response'
@@ -801,6 +953,8 @@ export interface AuditEventListParams {
     | 'customer_defaults'
     | 'customer_notification_preferences'
     | 'order_discount'
+    | 'sales_order_line'
+    | 'sales_order_type'
     | 'sales_order_status'
     | 'material'
     | 'supplier_material'
@@ -851,14 +1005,55 @@ export interface AuditEventListParams {
     | 'rate_shop_option'
     | 'rate_shop_result'
     | 'owner'
+    | 'created_by'
     | 'message'
-    | 'account_plan'
+    | 'account_photo_upload_result'
+    | 'user_photo_upload_result'
+    | 'user_photo_url'
+    | 'batch_lot'
+    | 'check_duplicate_result'
+    | 'item_trend_point'
+    | 'pack_pick_response'
+    | 'pick_shipments_response'
+    | 'tenancy_pending_registration'
+    | 'invoice_allocation_entry'
+    | 'allocation_customer'
+    | 'checkout_sales_order_response'
+    | 'create_production_run_response'
+    | 'sales_order_price_quote'
+    | 'hubspot_sync_job'
+    | 'hubspot_sync_report'
+    | 'hubspot_company_review'
+    | 'hubspot_company_candidate'
+    | 'contact_match'
+    | 'reply_draft'
+    | 'conversation_link'
+    | 'messaging_group'
+    | 'messaging_group_member'
   >;
 
   /**
    * Restricts results to audit events on or after this timestamp.
    */
   start_date?: string;
+
+  /**
+   * Filter by the _target_ account the mutation was performed against (the event's
+   * `account`).
+   *
+   * Results are always scoped to events where your account is either the acting
+   * account or the target account; this narrows that set to specific target accounts
+   * — for example a specific customer's or supplier's account.
+   */
+  target_account_ids?: Array<string>;
+}
+
+export interface AuditEventRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'account' | 'actor' | 'changes' | 'metadata' | 'request'>;
 }
 
 export declare namespace AuditEvents {
@@ -868,7 +1063,7 @@ export declare namespace AuditEvents {
     type ListAuditEvent as ListAuditEvent,
     type ListAuditFieldChange as ListAuditFieldChange,
     type ListObjectType as ListObjectType,
-    type AuditEventRetrieveParams as AuditEventRetrieveParams,
     type AuditEventListParams as AuditEventListParams,
+    type AuditEventRetrieveParams as AuditEventRetrieveParams,
   };
 }