@augno/sdk 0.12.4 → 0.12.5

package/src/resources/messaging/conversations/messages.ts

@@ -222,6 +222,7 @@ export interface SendMessageRequest {
     | 'record'
     | 'freight'
     | 'sales_order_totals'
+    | 'sales_order_stage_total'
     | 'sales_order_related'
     | 'order_contact'
     | 'user'
@@ -257,6 +258,7 @@ export interface SendMessageRequest {
     | 'notification_unread_summary'
     | 'announcement'
     | 'conversation'
+    | 'support_case'
     | 'conversation_participant'
     | 'read_cursor'
     | 'chat_message'
@@ -292,6 +294,7 @@ export interface SendMessageRequest {
     | 'account_branding'
     | 'account_portal'
     | 'account_logo_url'
+    | 'account_favicon_url'
     | 'public_account'
     | 'property'
     | 'carrier'
@@ -377,6 +380,7 @@ export interface SendMessageRequest {
     | 'customer_freight_preferences'
     | 'customer_defaults'
     | 'customer_notification_preferences'
+    | 'order_notification_recipient'
     | 'order_discount'
     | 'sales_order_line'
     | 'sales_order_type'
@@ -443,9 +447,11 @@ export interface SendMessageRequest {
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
     | 'allocation_customer'
-    | 'checkout_sales_order_response'
-    | 'create_production_run_response'
+    | 'checkout_sales_order'
     | 'sales_order_price_quote'
+    | 'sales_order_freight_quote'
+    | 'sales_order_price_quote_line'
+    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -457,7 +463,12 @@ export interface SendMessageRequest {
     | 'messaging_group_member'
     | 'portal_profile'
     | 'portal_registration_session'
-    | 'portal_registration_session_data';
+    | 'portal_registration_session_data'
+    | 'pack_list'
+    | 'pack_list_party'
+    | 'pack_list_line_item'
+    | 'pack_list_back_order'
+    | 'pack_list_case';
 
   /**
    * Account user ids explicitly @mentioned in the message.
@@ -587,6 +598,7 @@ export interface MessageCreateParams {
     | 'record'
     | 'freight'
     | 'sales_order_totals'
+    | 'sales_order_stage_total'
     | 'sales_order_related'
     | 'order_contact'
     | 'user'
@@ -622,6 +634,7 @@ export interface MessageCreateParams {
     | 'notification_unread_summary'
     | 'announcement'
     | 'conversation'
+    | 'support_case'
     | 'conversation_participant'
     | 'read_cursor'
     | 'chat_message'
@@ -657,6 +670,7 @@ export interface MessageCreateParams {
     | 'account_branding'
     | 'account_portal'
     | 'account_logo_url'
+    | 'account_favicon_url'
     | 'public_account'
     | 'property'
     | 'carrier'
@@ -742,6 +756,7 @@ export interface MessageCreateParams {
     | 'customer_freight_preferences'
     | 'customer_defaults'
     | 'customer_notification_preferences'
+    | 'order_notification_recipient'
     | 'order_discount'
     | 'sales_order_line'
     | 'sales_order_type'
@@ -808,9 +823,11 @@ export interface MessageCreateParams {
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
     | 'allocation_customer'
-    | 'checkout_sales_order_response'
-    | 'create_production_run_response'
+    | 'checkout_sales_order'
     | 'sales_order_price_quote'
+    | 'sales_order_freight_quote'
+    | 'sales_order_price_quote_line'
+    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -822,7 +839,12 @@ export interface MessageCreateParams {
     | 'messaging_group_member'
     | 'portal_profile'
     | 'portal_registration_session'
-    | 'portal_registration_session_data';
+    | 'portal_registration_session_data'
+    | 'pack_list'
+    | 'pack_list_party'
+    | 'pack_list_line_item'
+    | 'pack_list_back_order'
+    | 'pack_list_case';
 
   /**
    * Body param: Account user ids explicitly @mentioned in the message.

package/src/resources/messaging/notifications/notifications.ts

@@ -197,7 +197,8 @@ export interface Notification {
     | 'order.updated'
     | 'agent.run_completed'
     | 'agent.alert'
-    | 'system.broadcast';
+    | 'system.broadcast'
+    | 'customer.registered';
 
   /**
    * Creation timestamp.
@@ -385,7 +386,8 @@ export interface SendNotificationRequest {
     | 'order.updated'
     | 'agent.run_completed'
     | 'agent.alert'
-    | 'system.broadcast';
+    | 'system.broadcast'
+    | 'customer.registered';
 
   /**
    * NotificationTargetInput selects what a notification send is aimed at.
@@ -430,6 +432,7 @@ export interface SendNotificationRequest {
     | 'record'
     | 'freight'
     | 'sales_order_totals'
+    | 'sales_order_stage_total'
     | 'sales_order_related'
     | 'order_contact'
     | 'user'
@@ -465,6 +468,7 @@ export interface SendNotificationRequest {
     | 'notification_unread_summary'
     | 'announcement'
     | 'conversation'
+    | 'support_case'
     | 'conversation_participant'
     | 'read_cursor'
     | 'chat_message'
@@ -500,6 +504,7 @@ export interface SendNotificationRequest {
     | 'account_branding'
     | 'account_portal'
     | 'account_logo_url'
+    | 'account_favicon_url'
     | 'public_account'
     | 'property'
     | 'carrier'
@@ -585,6 +590,7 @@ export interface SendNotificationRequest {
     | 'customer_freight_preferences'
     | 'customer_defaults'
     | 'customer_notification_preferences'
+    | 'order_notification_recipient'
     | 'order_discount'
     | 'sales_order_line'
     | 'sales_order_type'
@@ -651,9 +657,11 @@ export interface SendNotificationRequest {
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
     | 'allocation_customer'
-    | 'checkout_sales_order_response'
-    | 'create_production_run_response'
+    | 'checkout_sales_order'
     | 'sales_order_price_quote'
+    | 'sales_order_freight_quote'
+    | 'sales_order_price_quote_line'
+    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -665,7 +673,12 @@ export interface SendNotificationRequest {
     | 'messaging_group_member'
     | 'portal_profile'
     | 'portal_registration_session'
-    | 'portal_registration_session_data';
+    | 'portal_registration_session_data'
+    | 'pack_list'
+    | 'pack_list_party'
+    | 'pack_list_line_item'
+    | 'pack_list_back_order'
+    | 'pack_list_case';
 
   /**
    * Delivery priority.
@@ -684,7 +697,8 @@ export interface NotificationCreateParams {
     | 'order.updated'
     | 'agent.run_completed'
     | 'agent.alert'
-    | 'system.broadcast';
+    | 'system.broadcast'
+    | 'customer.registered';
 
   /**
    * NotificationTargetInput selects what a notification send is aimed at.
@@ -729,6 +743,7 @@ export interface NotificationCreateParams {
     | 'record'
     | 'freight'
     | 'sales_order_totals'
+    | 'sales_order_stage_total'
     | 'sales_order_related'
     | 'order_contact'
     | 'user'
@@ -764,6 +779,7 @@ export interface NotificationCreateParams {
     | 'notification_unread_summary'
     | 'announcement'
     | 'conversation'
+    | 'support_case'
     | 'conversation_participant'
     | 'read_cursor'
     | 'chat_message'
@@ -799,6 +815,7 @@ export interface NotificationCreateParams {
     | 'account_branding'
     | 'account_portal'
     | 'account_logo_url'
+    | 'account_favicon_url'
     | 'public_account'
     | 'property'
     | 'carrier'
@@ -884,6 +901,7 @@ export interface NotificationCreateParams {
     | 'customer_freight_preferences'
     | 'customer_defaults'
     | 'customer_notification_preferences'
+    | 'order_notification_recipient'
     | 'order_discount'
     | 'sales_order_line'
     | 'sales_order_type'
@@ -950,9 +968,11 @@ export interface NotificationCreateParams {
     | 'tenancy_pending_registration'
     | 'invoice_allocation_entry'
     | 'allocation_customer'
-    | 'checkout_sales_order_response'
-    | 'create_production_run_response'
+    | 'checkout_sales_order'
     | 'sales_order_price_quote'
+    | 'sales_order_freight_quote'
+    | 'sales_order_price_quote_line'
+    | 'sales_order_quote_rate'
     | 'hubspot_sync_job'
     | 'hubspot_sync_report'
     | 'hubspot_company_review'
@@ -964,7 +984,12 @@ export interface NotificationCreateParams {
     | 'messaging_group_member'
     | 'portal_profile'
     | 'portal_registration_session'
-    | 'portal_registration_session_data';
+    | 'portal_registration_session_data'
+    | 'pack_list'
+    | 'pack_list_party'
+    | 'pack_list_line_item'
+    | 'pack_list_back_order'
+    | 'pack_list_case';
 
   /**
    * Delivery priority.
@@ -983,7 +1008,8 @@ export interface NotificationListParams {
     | 'order.updated'
     | 'agent.run_completed'
     | 'agent.alert'
-    | 'system.broadcast';
+    | 'system.broadcast'
+    | 'customer.registered';
 
   /**
    * Opaque cursor token identifying where the page of results starts.

package/src/resources/sales/index.ts

@@ -61,24 +61,39 @@ export {
 export { Sales } from './sales';
 export {
   SalesOrders,
+  type CheckoutSalesOrderRequest,
+  type CheckoutSalesOrderResponse,
   type CreateSalesOrderLineInput,
   type CreateSalesOrderRequest,
   type CreatedBy,
   type Freight,
+  type ListQuotedSalesOrderLine,
   type ListRecord,
   type ListSalesOrder,
   type ListSalesOrderLine,
   type ListSalesOrderStatus,
   type OrderContact,
   type OrderDiscount,
+  type QuoteSalesOrderLineInput,
+  type QuoteSalesOrderPricesRequest,
+  type QuoteSalesOrderPricesResponse,
+  type QuotedSalesOrderLine,
   type Record,
   type SalesOrder,
   type SalesOrderEmailContactInput,
   type SalesOrderLine,
+  type SalesOrderQuoteRate,
   type SalesOrderRelated,
+  type SalesOrderStageTotal,
   type SalesOrderStatus,
   type SalesOrderTotals,
+  type UpdateSalesOrderRequest,
+  type SalesOrderDeleteResponse,
   type SalesOrderRetrieveStatusesParams,
   type SalesOrderListParams,
+  type SalesOrderRetrieveParams,
   type SalesOrderCreateParams,
-} from './sales-orders';
+  type SalesOrderUpdateParams,
+  type SalesOrderCheckoutParams,
+  type SalesOrderPriceQuoteParams,
+} from './sales-orders/index';

package/src/resources/sales/sales-orders/actions.ts

@@ -0,0 +1,316 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BlocksAPI from '../../messaging/blocks';
+import * as SalesOrdersAPI from './sales-orders';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List, view, create, update, and delete sales orders.
+ */
+export class Actions extends APIResource {
+  /**
+   * Deletes multiple sales orders in a single atomic operation.
+   *
+   * Fulfilled orders cannot be deleted; if any requested order fails this check, no
+   * orders are deleted.
+   *
+   * This endpoint requires the permission: `sales_orders:delete`.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.sales.salesOrders.actions.bulkDelete({
+   *     sales_order_ids: ['or_01d5034136c3ccc048abecc312'],
+   *   });
+   * ```
+   */
+  bulkDelete(body: ActionBulkDeleteParams, options?: RequestOptions): APIPromise<ActionBulkDeleteResponse> {
+    return this._client.post('/v1/sales/sales-orders/actions/bulk-delete', { body, ...options });
+  }
+
+  /**
+   * Issues a sales order, transitioning it from `estimate` to `issued`.
+   *
+   * Issuing commits the order for fulfillment: a pick is created for the order's
+   * sale lines and inventory is reserved for each line tied to an inventory item.
+   *
+   * This endpoint requires the permission: `sales_orders:update`.
+   *
+   * @example
+   * ```ts
+   * const salesOrder =
+   *   await client.sales.salesOrders.actions.issue(
+   *     'or_01d5034136c3ccc048abecc312',
+   *     { notify_customer: true },
+   *   );
+   * ```
+   */
+  issue(
+    id: string,
+    body: ActionIssueParams,
+    options?: RequestOptions,
+  ): APIPromise<SalesOrdersAPI.SalesOrder> {
+    return this._client.put(path`/v1/sales/sales-orders/${id}/actions/issue`, { body, ...options });
+  }
+
+  /**
+   * Unissues a sales order, transitioning it from `issued` back to `estimate`.
+   *
+   * Deletes the order's pick and releases any inventory reserved when the order was
+   * issued.
+   *
+   * This endpoint requires the permission: `sales_orders:update`.
+   *
+   * @example
+   * ```ts
+   * const salesOrder =
+   *   await client.sales.salesOrders.actions.unissue(
+   *     'or_01d5034136c3ccc048abecc312',
+   *   );
+   * ```
+   */
+  unissue(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder> {
+    return this._client.put(path`/v1/sales/sales-orders/${id}/actions/unissue`, options);
+  }
+
+  /**
+   * Closes a sales order, transitioning it from `issued` to `fulfilled`.
+   *
+   * Sets the order's completion timestamp and marks its pick as finished.
+   *
+   * This endpoint requires the permission: `sales_orders:update`.
+   *
+   * @example
+   * ```ts
+   * const salesOrder =
+   *   await client.sales.salesOrders.actions.close(
+   *     'or_01d5034136c3ccc048abecc312',
+   *   );
+   * ```
+   */
+  close(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder> {
+    return this._client.put(path`/v1/sales/sales-orders/${id}/actions/close`, options);
+  }
+
+  /**
+   * Reopens a sales order, transitioning it from `fulfilled` back to `issued`.
+   *
+   * Clears the order's completion timestamp and marks its pick as unfinished.
+   *
+   * This endpoint requires the permission: `sales_orders:update`.
+   *
+   * @example
+   * ```ts
+   * const salesOrder =
+   *   await client.sales.salesOrders.actions.open(
+   *     'or_01d5034136c3ccc048abecc312',
+   *   );
+   * ```
+   */
+  open(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder> {
+    return this._client.put(path`/v1/sales/sales-orders/${id}/actions/open`, options);
+  }
+
+  /**
+   * Re-estimates the freight (shipping) charge for an order using the latest carrier
+   * rates.
+   *
+   * Computes what the order's freight charge would be from its current ship-to
+   * address, carrier, service level, and line items — applying the same
+   * freight-exemption, flat-rate, and live carrier-rate logic used when the order is
+   * created. The order is not modified: the returned amount is a quote to review,
+   * and callers apply it by updating the order's shipping line. Use this to refresh
+   * freight after changing the address or line items, or at any time to re-price
+   * against current rates.
+   *
+   * This endpoint requires the permission: `sales_orders:read`.
+   *
+   * @example
+   * ```ts
+   * const quoteSalesOrderFreightResponse =
+   *   await client.sales.salesOrders.actions.quoteFreight(
+   *     'or_01d5034136c3ccc048abecc312',
+   *   );
+   * ```
+   */
+  quoteFreight(id: string, options?: RequestOptions): APIPromise<QuoteSalesOrderFreightResponse> {
+    return this._client.post(path`/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
+  }
+
+  /**
+   * Creates a production run from a sales order.
+   *
+   * Creates a batch for each of the order's item-backed lines, reserves the material
+   * inventory required to produce them, and links the run to the order. An order can
+   * have at most one production run.
+   *
+   * This endpoint requires the permission: `production_runs:create`.
+   *
+   * @example
+   * ```ts
+   * const productionRun =
+   *   await client.sales.salesOrders.actions.createProductionRun(
+   *     'or_01d5034136c3ccc048abecc312',
+   *   );
+   * ```
+   */
+  createProductionRun(
+    id: string,
+    params: ActionCreateProductionRunParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductionRun> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/sales/sales-orders/${id}/actions/create-production-run`, {
+      query: { include },
+      ...options,
+    });
+  }
+}
+
+/**
+ * Request to bulk delete sales orders.
+ */
+export interface BulkDeleteSalesOrdersRequest {
+  /**
+   * IDs of the sales orders to delete.
+   */
+  sales_order_ids: Array<string>;
+}
+
+/**
+ * Request to issue a sales order.
+ */
+export interface IssueSalesOrderRequest {
+  /**
+   * Whether to notify the customer.
+   *
+   * When `true`, the order acknowledgement email is sent to the contacts configured
+   * on the order and the order's `acknowledgment_status` is set to `sent`.
+   */
+  notify_customer: boolean;
+}
+
+/**
+ * Production run resource.
+ */
+export interface ProductionRun {
+  /**
+   * Production run ID.
+   */
+  id: string;
+
+  /**
+   * Number of batches currently recorded against this run.
+   */
+  batch_count: number;
+
+  /**
+   * Time the run was marked complete.
+   *
+   * Set automatically once every batch in the run has been scanned or deleted, and
+   * unset while the run is still in progress. Once set, the run can no longer be
+   * updated and new batches can no longer be added.
+   */
+  completed_at: string | null;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Production run number, unique per account.
+   *
+   * Assigned automatically at creation as the next sequential number for the
+   * account; can be changed via update.
+   */
+  number: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'production_run';
+
+  /**
+   * A user's membership in an account, carrying the account-specific status, role,
+   * and department.
+   *
+   * Profile fields (name, email, username, image URL) live on the expandable `user`
+   * sub-resource, which is shared across every account the user belongs to.
+   */
+  responsible_user: BlocksAPI.AccountUser | null;
+
+  /**
+   * Time the run started production.
+   *
+   * Set automatically when the first batch in the run is scanned, and unset until
+   * then.
+   */
+  started_at: string | null;
+
+  /**
+   * Last-updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * The freshly estimated freight charge for a sales order.
+ */
+export interface QuoteSalesOrderFreightResponse {
+  /**
+   * Resource type identifier.
+   */
+  object: 'sales_order_freight_quote';
+
+  /**
+   * A per-unit rate on a sales-order quote.
+   *
+   * A lightweight, unpersisted variant of a rate: it carries no ID or timestamps
+   * because a quote is computed on demand and never stored.
+   */
+  unit_price: SalesOrdersAPI.SalesOrderQuoteRate | null;
+}
+
+export interface ActionBulkDeleteResponse {}
+
+export interface ActionBulkDeleteParams {
+  /**
+   * IDs of the sales orders to delete.
+   */
+  sales_order_ids: Array<string>;
+}
+
+export interface ActionIssueParams {
+  /**
+   * Whether to notify the customer.
+   *
+   * When `true`, the order acknowledgement email is sent to the contacts configured
+   * on the order and the order's `acknowledgment_status` is set to `sent`.
+   */
+  notify_customer: boolean;
+}
+
+export interface ActionCreateProductionRunParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'responsible_user' | 'responsible_user.user'>;
+}
+
+export declare namespace Actions {
+  export {
+    type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest,
+    type IssueSalesOrderRequest as IssueSalesOrderRequest,
+    type ProductionRun as ProductionRun,
+    type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse,
+    type ActionBulkDeleteResponse as ActionBulkDeleteResponse,
+    type ActionBulkDeleteParams as ActionBulkDeleteParams,
+    type ActionIssueParams as ActionIssueParams,
+    type ActionCreateProductionRunParams as ActionCreateProductionRunParams,
+  };
+}

package/src/resources/sales/sales-orders/index.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type BulkDeleteSalesOrdersRequest,
+  type IssueSalesOrderRequest,
+  type ProductionRun,
+  type QuoteSalesOrderFreightResponse,
+  type ActionBulkDeleteResponse,
+  type ActionBulkDeleteParams,
+  type ActionIssueParams,
+  type ActionCreateProductionRunParams,
+} from './actions';
+export {
+  Lines,
+  type CreateSalesOrderLineRequest,
+  type UpdateSalesOrderLineRequest,
+  type LineDeleteResponse,
+  type LineCreateParams,
+  type LineUpdateParams,
+  type LineDeleteParams,
+} from './lines/index';
+export {
+  SalesOrders,
+  type CheckoutSalesOrderRequest,
+  type CheckoutSalesOrderResponse,
+  type CreateSalesOrderLineInput,
+  type CreateSalesOrderRequest,
+  type CreatedBy,
+  type Freight,
+  type ListQuotedSalesOrderLine,
+  type ListRecord,
+  type ListSalesOrder,
+  type ListSalesOrderLine,
+  type ListSalesOrderStatus,
+  type OrderContact,
+  type OrderDiscount,
+  type QuoteSalesOrderLineInput,
+  type QuoteSalesOrderPricesRequest,
+  type QuoteSalesOrderPricesResponse,
+  type QuotedSalesOrderLine,
+  type Record,
+  type SalesOrder,
+  type SalesOrderEmailContactInput,
+  type SalesOrderLine,
+  type SalesOrderQuoteRate,
+  type SalesOrderRelated,
+  type SalesOrderStageTotal,
+  type SalesOrderStatus,
+  type SalesOrderTotals,
+  type UpdateSalesOrderRequest,
+  type SalesOrderDeleteResponse,
+  type SalesOrderRetrieveStatusesParams,
+  type SalesOrderListParams,
+  type SalesOrderRetrieveParams,
+  type SalesOrderCreateParams,
+  type SalesOrderUpdateParams,
+  type SalesOrderCheckoutParams,
+  type SalesOrderPriceQuoteParams,
+} from './sales-orders';