@augno/sdk 0.1.9 → 0.7.0

package/src/resources/core/addresses/actions.ts

@@ -89,7 +89,7 @@ export interface ValidateAddressRequest {
   city: string;
 
   /**
-   * Country name or code.
+   * Country name or two-letter country code (for example `United States` or `US`).
    */
   country: string;
 
@@ -119,7 +119,10 @@ export interface ValidatedAddress {
   components: AddressComponents | null;
 
   /**
-   * Formatted address from the validation service.
+   * Formatted, single-line address as standardized by the validation service.
+   *
+   * The validation service may omit this regardless of `status`, so it can be absent
+   * even for a `valid` address.
    */
   formatted_address: string | null;
 
@@ -129,12 +132,16 @@ export interface ValidatedAddress {
   object: 'validated_address';
 
   /**
-   * Address validation status.
+   * Whether the address could be validated.
    */
   status: 'valid' | 'invalid';
 
   /**
-   * Validation messages for issues found.
+   * Human-readable messages describing issues found during validation.
+   *
+   * May be non-empty even when `status` is `valid`, for example when components were
+   * inferred or replaced with standardized values. Empty when no issues were
+   * reported.
    */
   validation_messages: Array<string>;
 }
@@ -151,7 +158,7 @@ export interface ActionValidateParams {
   city: string;
 
   /**
-   * Country name or code.
+   * Country name or two-letter country code (for example `United States` or `US`).
    */
   country: string;
 

package/src/resources/core/addresses/addresses.ts

@@ -90,12 +90,15 @@ export interface ListAddressSuggestion {
 
 export interface AddressRetrieveSuggestionsParams {
   /**
-   * Autocomplete input text.
+   * Partial address text to generate suggestions for.
    */
   input: string;
 
   /**
-   * Session token for grouping autocomplete requests.
+   * Opaque token that groups a series of related autocomplete requests into a single
+   * session.
+   *
+   * Reuse the same token for each keystroke of one address entry.
    */
   session_token?: string;
 }

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

@@ -12,41 +12,44 @@ 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.
    *
    * @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.
    *
    * @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.
+   *
    * @example
    * ```ts
    * const listObjectType =
@@ -59,8 +62,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 {
   /**
@@ -68,8 +72,19 @@ export interface AuditEvent {
    */
   id: string;
 
+  /**
+   * A customer account, including its branding and customer portal sub-resources.
+   */
+  account: APIKeysAPI.Account | null;
+
   /**
    * Mutation type.
+   *
+   * - `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.
    */
   action: 'create' | 'update' | 'delete' | 'restore' | 'archive';
 
@@ -111,7 +126,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 +146,7 @@ export interface AuditEvent {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -140,6 +156,7 @@ export interface AuditEvent {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -206,8 +223,6 @@ export interface AuditEvent {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
@@ -264,6 +279,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 +331,22 @@ 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';
 
   /**
    * Originating client IP address.
@@ -333,8 +364,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 +377,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 +440,7 @@ export interface ListObjectType {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -415,6 +450,7 @@ export interface ListObjectType {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -481,8 +517,6 @@ export interface ListObjectType {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
@@ -539,6 +573,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 +625,22 @@ 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'
   >;
 
   /**
@@ -604,30 +654,36 @@ 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'>;
 
-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.
+   * 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 +696,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 +717,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 +729,7 @@ export interface AuditEventListParams {
     | 'freight'
     | 'sales_order_totals'
     | 'sales_order_related'
+    | 'order_contact'
     | 'user'
     | 'address'
     | 'api_key'
@@ -677,6 +739,7 @@ export interface AuditEventListParams {
     | 'sandbox'
     | 'registration_session'
     | 'pricing_plan'
+    | 'account_plan'
     | 'plan_change'
     | 'enterprise_inquiry'
     | 'request_log'
@@ -743,8 +806,6 @@ export interface AuditEventListParams {
     | 'delivery'
     | 'delivery_line'
     | 'sales_order'
-    | 'sales_order_line'
-    | 'sales_order_type'
     | 'location'
     | 'location_type'
     | 'lot'
@@ -801,6 +862,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 +914,46 @@ 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'
   >;
 
   /**
    * 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 +963,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,
   };
 }

package/src/resources/core/core.ts

@@ -63,9 +63,9 @@ export declare namespace Core {
     type ListSandbox as ListSandbox,
     type Sandbox as Sandbox,
     type SandboxDeleteResponse as SandboxDeleteResponse,
-    type SandboxCreateParams as SandboxCreateParams,
-    type SandboxRetrieveParams as SandboxRetrieveParams,
     type SandboxListParams as SandboxListParams,
+    type SandboxRetrieveParams as SandboxRetrieveParams,
+    type SandboxCreateParams as SandboxCreateParams,
   };
 
   export {
@@ -73,8 +73,8 @@ export declare namespace Core {
     type Actor as Actor,
     type ListRequestLog as ListRequestLog,
     type RequestLog as RequestLog,
-    type RequestLogRetrieveParams as RequestLogRetrieveParams,
     type RequestLogListParams as RequestLogListParams,
+    type RequestLogRetrieveParams as RequestLogRetrieveParams,
   };
 
   export {
@@ -84,8 +84,8 @@ export declare namespace Core {
     type ListAuditEvent as ListAuditEvent,
     type ListAuditFieldChange as ListAuditFieldChange,
     type ListObjectType as ListObjectType,
-    type AuditEventRetrieveParams as AuditEventRetrieveParams,
     type AuditEventListParams as AuditEventListParams,
+    type AuditEventRetrieveParams as AuditEventRetrieveParams,
   };
 
   export {
@@ -99,7 +99,7 @@ export declare namespace Core {
     EmailLogs as EmailLogs,
     type EmailLog as EmailLog,
     type ListEmailLog as ListEmailLog,
-    type EmailLogRetrieveParams as EmailLogRetrieveParams,
     type EmailLogListParams as EmailLogListParams,
+    type EmailLogRetrieveParams as EmailLogRetrieveParams,
   };
 }

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

@@ -12,41 +12,42 @@ import { path } from '../../internal/utils/path';
  */
 export class EmailLogs extends APIResource {
   /**
-   * Returns an email log by ID.
+   * Returns a paginated list of email logs for the current account.
    *
    * @example
    * ```ts
-   * const emailLog = await client.core.emailLogs.retrieve(
-   *   'eml_017b80707ada92dddff8a2c3a0',
-   * );
+   * const listEmailLog = await client.core.emailLogs.list();
    * ```
    */
-  retrieve(
-    id: string,
-    query: EmailLogRetrieveParams | null | undefined = {},
+  list(
+    query: EmailLogListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailLog> {
-    return this._client.get(path`/v1/core/email-logs/${id}`, { query, ...options });
+  ): APIPromise<ListEmailLog> {
+    return this._client.get('/v1/core/email-logs', { query, ...options });
   }
 
   /**
-   * Returns a paginated list of email logs for the current account.
+   * Returns an email log by ID.
    *
    * @example
    * ```ts
-   * const listEmailLog = await client.core.emailLogs.list();
+   * const emailLog = await client.core.emailLogs.retrieve(
+   *   'eml_017b80707ada92dddff8a2c3a0',
+   * );
    * ```
    */
-  list(
-    query: EmailLogListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    query: EmailLogRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ListEmailLog> {
-    return this._client.get('/v1/core/email-logs', { query, ...options });
+  ): APIPromise<EmailLog> {
+    return this._client.get(path`/v1/core/email-logs/${id}`, { query, ...options });
   }
 }
 
 /**
- * Email log entry.
+ * A record of an email sent on the account's behalf, such as an invoice or a user
+ * invitation.
  */
 export interface EmailLog {
   /**
@@ -60,7 +61,7 @@ export interface EmailLog {
   created_at: string;
 
   /**
-   * Filename of any attachment.
+   * Filename of the attached document.
    */
   filename: string | null;
 
@@ -76,6 +77,9 @@ export interface EmailLog {
 
   /**
    * Email send status.
+   *
+   * - `pending`: the email is queued and has not been sent yet.
+   * - `sent`: the email has been handed off for delivery.
    */
   send_status: 'sent' | 'pending';
 
@@ -115,17 +119,13 @@ export interface ListEmailLog {
   page_info: APIKeysAPI.PageInfo;
 }
 
-export interface EmailLogRetrieveParams {
-  /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
-   */
-  include?: Array<'sent_by'>;
-}
-
 export interface EmailLogListParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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;
 
@@ -136,21 +136,31 @@ export interface EmailLogListParams {
   include?: Array<'sent_by'>;
 
   /**
-   * 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;
 }
 
+export interface EmailLogRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'sent_by'>;
+}
+
 export declare namespace EmailLogs {
   export {
     type EmailLog as EmailLog,
     type ListEmailLog as ListEmailLog,
-    type EmailLogRetrieveParams as EmailLogRetrieveParams,
     type EmailLogListParams as EmailLogListParams,
+    type EmailLogRetrieveParams as EmailLogRetrieveParams,
   };
 }

package/src/resources/core/index.ts

@@ -13,24 +13,24 @@ export {
   type ListAuditEvent,
   type ListAuditFieldChange,
   type ListObjectType,
-  type AuditEventRetrieveParams,
   type AuditEventListParams,
+  type AuditEventRetrieveParams,
 } from './audit-events';
 export { Core } from './core';
 export {
   EmailLogs,
   type EmailLog,
   type ListEmailLog,
-  type EmailLogRetrieveParams,
   type EmailLogListParams,
+  type EmailLogRetrieveParams,
 } from './email-logs';
 export {
   RequestLogs,
   type Actor,
   type ListRequestLog,
   type RequestLog,
-  type RequestLogRetrieveParams,
   type RequestLogListParams,
+  type RequestLogRetrieveParams,
 } from './request-logs';
 export {
   Sandboxes,
@@ -38,7 +38,7 @@ export {
   type ListSandbox,
   type Sandbox,
   type SandboxDeleteResponse,
-  type SandboxCreateParams,
-  type SandboxRetrieveParams,
   type SandboxListParams,
+  type SandboxRetrieveParams,
+  type SandboxCreateParams,
 } from './sandboxes';