@augno/sdk 0.7.0 → 0.9.0

package/src/resources/core/core.ts

@@ -34,6 +34,7 @@ import {
   SandboxRetrieveParams,
   Sandboxes,
 } from './sandboxes';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
 import * as AddressesAPI from './addresses/addresses';
 import {
   AddressRetrieveSuggestionsParams,
@@ -41,13 +42,608 @@ import {
   Addresses,
   ListAddressSuggestion,
 } from './addresses/addresses';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Unified free-text search across resource types, returning lightweight entity references.
+ */
 export class Core extends APIResource {
   sandboxes: SandboxesAPI.Sandboxes = new SandboxesAPI.Sandboxes(this._client);
   requestLogs: RequestLogsAPI.RequestLogs = new RequestLogsAPI.RequestLogs(this._client);
   auditEvents: AuditEventsAPI.AuditEvents = new AuditEventsAPI.AuditEvents(this._client);
   addresses: AddressesAPI.Addresses = new AddressesAPI.Addresses(this._client);
   emailLogs: EmailLogsAPI.EmailLogs = new EmailLogsAPI.EmailLogs(this._client);
+
+  /**
+   * Search returns lightweight `entity` references matching the query across the
+   * resource types the caller can read.
+   *
+   * This endpoint requires the permissions: `sales_orders:read`,
+   * `purchase_orders:read`, `invoices:read`, `customers:read`, `items:read`,
+   * `shipments:read`, `messaging:read`, `agents:read`.
+   *
+   * @example
+   * ```ts
+   * const listEntity = await client.core.retrieveSearch();
+   * ```
+   */
+  retrieveSearch(
+    query: CoreRetrieveSearchParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListEntity> {
+    return this._client.get('/v1/core/search', { query, ...options });
+  }
+}
+
+/**
+ * Entity is a polymorphic reference to any resource in the system.
+ */
+export interface Entity {
+  /**
+   * Unique identifier for the entity.
+   */
+  id: string;
+
+  /**
+   * Secondary human-readable identifier (e.g. email address, username, redacted API
+   * key value).
+   */
+  handle: string | null;
+
+  /**
+   * Human-readable display name for the entity (e.g. a user's full name, a sales
+   * order number).
+   */
+  name: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'entity';
+
+  /**
+   * The resource kind that this entity references, as an object-type value (e.g.
+   * `user`, `account`).
+   *
+   * Unlike `object` — which is always `entity` — this names the underlying resource
+   * the `id` points to.
+   */
+  type:
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'record'
+    | 'freight'
+    | 'sales_order_totals'
+    | 'sales_order_related'
+    | 'order_contact'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'account_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'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'conversation_participant'
+    | 'read_cursor'
+    | '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'
+    | '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'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
+    | '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'
+    | '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_line'
+    | 'sales_order_type'
+    | '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'
+    | 'created_by'
+    | 'message'
+    | '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';
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListEntity {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Entity>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface CoreRetrieveSearchParams {
+  /**
+   * 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;
+
+  /**
+   * Restrict the search to a single customer by their account ID.
+   *
+   * When set, only resource types that are safe to expose to a customer are searched
+   * (their sales orders, invoices, and shipments), and results are limited to
+   * records belonging to that customer.
+   */
+  customer?: string;
+
+  /**
+   * Maximum number of results to return in a single page.
+   */
+  limit?: number;
+
+  /**
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
+   */
+  q?: string;
+
+  /**
+   * Filter the search to specific resource types.
+   *
+   * Omit to search every supported type the caller can read.
+   */
+  types?: Array<
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'record'
+    | 'freight'
+    | 'sales_order_totals'
+    | 'sales_order_related'
+    | 'order_contact'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'account_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'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'conversation_participant'
+    | 'read_cursor'
+    | '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'
+    | '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'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
+    | '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'
+    | '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_line'
+    | 'sales_order_type'
+    | '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'
+    | 'created_by'
+    | 'message'
+    | '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'
+  >;
 }
 
 Core.Sandboxes = Sandboxes;
@@ -57,6 +653,12 @@ Core.Addresses = Addresses;
 Core.EmailLogs = EmailLogs;
 
 export declare namespace Core {
+  export {
+    type Entity as Entity,
+    type ListEntity as ListEntity,
+    type CoreRetrieveSearchParams as CoreRetrieveSearchParams,
+  };
+
   export {
     Sandboxes as Sandboxes,
     type CreateSandboxRequest as CreateSandboxRequest,

package/src/resources/core/email-logs.ts

@@ -14,6 +14,8 @@ export class EmailLogs extends APIResource {
   /**
    * Returns a paginated list of email logs for the current account.
    *
+   * This endpoint requires the permission: `email_logs:read`.
+   *
    * @example
    * ```ts
    * const listEmailLog = await client.core.emailLogs.list();
@@ -29,6 +31,8 @@ export class EmailLogs extends APIResource {
   /**
    * Returns an email log by ID.
    *
+   * This endpoint requires the permission: `email_logs:read`.
+   *
    * @example
    * ```ts
    * const emailLog = await client.core.emailLogs.retrieve(
@@ -84,7 +88,8 @@ export interface EmailLog {
   send_status: 'sent' | 'pending';
 
   /**
-   * 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.
    */
   sent_by: RequestLogsAPI.Actor | null;
 

package/src/resources/core/index.ts

@@ -16,7 +16,7 @@ export {
   type AuditEventListParams,
   type AuditEventRetrieveParams,
 } from './audit-events';
-export { Core } from './core';
+export { Core, type Entity, type ListEntity, type CoreRetrieveSearchParams } from './core';
 export {
   EmailLogs,
   type EmailLog,