@augno/sdk 0.7.0 → 0.7.1

package/src/resources/sales/customers/index.ts

@@ -3,35 +3,20 @@
 export { Actions, type MergeCustomersRequest, type ActionMergeParams } from './actions';
 export {
   Customers,
-  type AccountUser,
   type Carrier,
-  type Consumption,
   type CreateCustomerRequest,
   type Customer,
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
   type CustomerNotificationPreferences,
-  type Department,
-  type ListConsumption,
   type ListCustomer,
-  type ListLocation,
-  type ListMachine,
-  type ListProductionStep,
-  type ListScanningStation,
   type ListServiceLevel,
-  type Location,
-  type LocationTypeCode,
-  type Machine,
   type PaymentTerm,
-  type ProductionOutput,
-  type ProductionStep,
   type QuantityInput,
-  type ScanningStation,
   type ServiceLevel,
   type ShippingTerm,
   type UpdateCustomerRequest,
-  type User,
   type CustomerDeleteResponse,
   type CustomerListParams,
   type CustomerRetrieveParams,

package/src/resources/sales/index.ts

@@ -28,37 +28,23 @@ export {
   type AddressCreateParams,
   type AddressUpdateParams,
 } from './addresses';
+export { Contacts } from './contacts/index';
 export {
   Customers,
-  type AccountUser,
   type Carrier,
-  type Consumption,
   type CreateCustomerRequest,
   type Customer,
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
   type CustomerNotificationPreferences,
-  type Department,
-  type ListConsumption,
   type ListCustomer,
-  type ListLocation,
-  type ListMachine,
-  type ListProductionStep,
-  type ListScanningStation,
   type ListServiceLevel,
-  type Location,
-  type LocationTypeCode,
-  type Machine,
   type PaymentTerm,
-  type ProductionOutput,
-  type ProductionStep,
   type QuantityInput,
-  type ScanningStation,
   type ServiceLevel,
   type ShippingTerm,
   type UpdateCustomerRequest,
-  type User,
   type CustomerDeleteResponse,
   type CustomerListParams,
   type CustomerRetrieveParams,

package/src/resources/sales/priorities.ts

@@ -13,6 +13,8 @@ export class Priorities extends APIResource {
   /**
    * Returns a paginated list of priorities.
    *
+   * This endpoint requires the permission: `priorities:read`.
+   *
    * @example
    * ```ts
    * const listPriority = await client.sales.priorities.list();
@@ -28,6 +30,8 @@ export class Priorities extends APIResource {
   /**
    * Returns a priority by ID or code.
    *
+   * This endpoint requires the permission: `priorities:read`.
+   *
    * @example
    * ```ts
    * const priority = await client.sales.priorities.retrieve(
@@ -88,7 +92,7 @@ export interface Priority {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name of the priority level.
    */
   name: string;
 

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

@@ -30,6 +30,9 @@ export class SalesOrders extends APIResource {
   /**
    * Returns a paginated list of sales orders for the current account.
    *
+   * This endpoint requires the permissions: `sales_orders:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listSalesOrder =
@@ -50,6 +53,8 @@ export class SalesOrders extends APIResource {
    * when none is provided. A shipping line is always added to the order, plus a
    * discount line when an order discount is supplied.
    *
+   * This endpoint requires the permission: `sales_orders:create`.
+   *
    * @example
    * ```ts
    * const salesOrder = await client.sales.salesOrders.create({
@@ -97,18 +102,16 @@ export interface CreateSalesOrderLineInput {
   quantity: CustomersAPI.QuantityInput;
 
   /**
-   * EDI line item ID.
-   */
-  edi_line_item_id?: string;
-
-  /**
-   * Description recorded on the line. Defaults to the product's description when
-   * omitted.
+   * Description recorded on the line.
+   *
+   * Defaults to the product's description when omitted.
    */
   product_description?: string;
 
   /**
-   * SKU recorded on the line. Defaults to the product's SKU when omitted.
+   * SKU recorded on the line.
+   *
+   * Defaults to the product's SKU when omitted.
    */
   product_sku?: string;
 
@@ -124,8 +127,9 @@ export interface CreateSalesOrderLineInput {
  */
 export interface CreateSalesOrderRequest {
   /**
-   * Bill-to address ID. Must reference an existing address on the order's owner or
-   * buyer account.
+   * Bill-to address ID.
+   *
+   * Must reference an existing address on the order's owner or buyer account.
    */
   bill_to_address_id: string;
 
@@ -145,8 +149,9 @@ export interface CreateSalesOrderRequest {
   priority_code: string;
 
   /**
-   * Ship-to address ID. Must reference an existing address on the order's owner or
-   * buyer account.
+   * Ship-to address ID.
+   *
+   * Must reference an existing address on the order's owner or buyer account.
    */
   ship_to_address_id: string;
 
@@ -230,12 +235,14 @@ export interface CreateSalesOrderRequest {
 
 /**
  * CreatedBy describes who created a resource and their relationship to the account
- * that owns it. Resolved from the resource's create audit event when the
- * `created_by` field is included.
+ * that owns it.
+ *
+ * It is resolved from the resource's create audit event.
  */
 export interface CreatedBy {
   /**
-   * 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;
 
@@ -258,10 +265,8 @@ export interface CreatedBy {
  * Freight describes the carrier selection and freight billing for a record.
  *
  * It is a generic, reusable sub-resource shared by anything that carries shipping
- * configuration — e.g. a sales order's chosen freight, or a customer's default
- * freight preferences. It is itself expanded via its parent (e.g.
- * include[]=freight); when present, the full carrier and service level are
- * included.
+ * configuration — for example a sales order's chosen freight, or a customer's
+ * default freight preferences.
  */
 export interface Freight {
   /**
@@ -292,9 +297,10 @@ export interface Freight {
   object: 'freight';
 
   /**
-   * Freight policy (who arranges and pays for freight).
+   * How freight is arranged and billed for the record.
    *
-   * Populated where a policy applies, such as customer defaults; null otherwise.
+   * Populated where a freight policy applies, such as a customer's default
+   * preferences.
    *
    * - `free_freight`: no shipping cost to the buyer.
    * - `billed_freight`: freight is billed to the buyer.
@@ -448,7 +454,7 @@ export interface OrderDiscount {
   discount_type: 'percentage' | 'amount';
 
   /**
-   * Display name.
+   * Display name of the discount.
    */
   name: string;
 
@@ -486,7 +492,7 @@ export interface OrderDiscount {
  */
 export interface Record {
   /**
-   * Record ID.
+   * Unique identifier for the record.
    */
   id: string;
 
@@ -579,8 +585,9 @@ export interface SalesOrder {
 
   /**
    * CreatedBy describes who created a resource and their relationship to the account
-   * that owns it. Resolved from the resource's create audit event when the
-   * `created_by` field is included.
+   * that owns it.
+   *
+   * It is resolved from the resource's create audit event.
    */
   created_by: CreatedBy | null;
 
@@ -611,10 +618,8 @@ export interface SalesOrder {
    * Freight describes the carrier selection and freight billing for a record.
    *
    * It is a generic, reusable sub-resource shared by anything that carries shipping
-   * configuration — e.g. a sales order's chosen freight, or a customer's default
-   * freight preferences. It is itself expanded via its parent (e.g.
-   * include[]=freight); when present, the full carrier and service level are
-   * included.
+   * configuration — for example a sales order's chosen freight, or a customer's
+   * default freight preferences.
    */
   freight: Freight | null;
 
@@ -691,7 +696,8 @@ export interface SalesOrder {
   related: SalesOrderRelated | null;
 
   /**
-   * 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.
    */
   sales_rep: RequestLogsAPI.Actor | null;
 
@@ -854,7 +860,8 @@ export interface SalesOrderRelated {
 }
 
 /**
- * Sales order status lookup value.
+ * A lookup value describing where a sales order is in its lifecycle, from estimate
+ * through fulfillment.
  */
 export interface SalesOrderStatus {
   /**
@@ -877,7 +884,7 @@ export interface SalesOrderStatus {
   created_at: string;
 
   /**
-   * Display name.
+   * Human-readable name of the status.
    */
   name: string;
 
@@ -977,14 +984,6 @@ export interface SalesOrderListParams {
    */
   end_date?: string;
 
-  /**
-   * Whether to exclude internal orders.
-   *
-   * When `true`, omits orders the account placed with itself (the buyer is the same
-   * account that owns the order).
-   */
-  exclude_internal_orders?: boolean;
-
   /**
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
    * `null`.
@@ -1054,8 +1053,9 @@ export interface SalesOrderListParams {
 
 export interface SalesOrderCreateParams {
   /**
-   * Body param: Bill-to address ID. Must reference an existing address on the
-   * order's owner or buyer account.
+   * Body param: Bill-to address ID.
+   *
+   * Must reference an existing address on the order's owner or buyer account.
    */
   bill_to_address_id: string;
 
@@ -1075,8 +1075,9 @@ export interface SalesOrderCreateParams {
   priority_code: string;
 
   /**
-   * Body param: Ship-to address ID. Must reference an existing address on the
-   * order's owner or buyer account.
+   * Body param: Ship-to address ID.
+   *
+   * Must reference an existing address on the order's owner or buyer account.
    */
   ship_to_address_id: string;
 

package/src/resources/sales/sales.ts

@@ -58,11 +58,11 @@ import {
   SalesOrderTotals,
   SalesOrders,
 } from './sales-orders';
+import * as ContactsAPI from './contacts/contacts';
+import { Contacts } from './contacts/contacts';
 import * as CustomersAPI from './customers/customers';
 import {
-  AccountUser,
   Carrier,
-  Consumption,
   CreateCustomerRequest,
   Customer,
   CustomerContactInfo,
@@ -75,26 +75,13 @@ import {
   CustomerRetrieveParams,
   CustomerUpdateParams,
   Customers,
-  Department,
-  ListConsumption,
   ListCustomer,
-  ListLocation,
-  ListMachine,
-  ListProductionStep,
-  ListScanningStation,
   ListServiceLevel,
-  Location,
-  LocationTypeCode,
-  Machine,
   PaymentTerm,
-  ProductionOutput,
-  ProductionStep,
   QuantityInput,
-  ScanningStation,
   ServiceLevel,
   ShippingTerm,
   UpdateCustomerRequest,
-  User,
 } from './customers/customers';
 
 export class Sales extends APIResource {
@@ -103,6 +90,7 @@ export class Sales extends APIResource {
   accountStatuses: AccountStatusesAPI.AccountStatuses = new AccountStatusesAPI.AccountStatuses(this._client);
   priorities: PrioritiesAPI.Priorities = new PrioritiesAPI.Priorities(this._client);
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
+  contacts: ContactsAPI.Contacts = new ContactsAPI.Contacts(this._client);
   salesOrders: SalesOrdersAPI.SalesOrders = new SalesOrdersAPI.SalesOrders(this._client);
 }
 
@@ -111,6 +99,7 @@ Sales.Addresses = Addresses;
 Sales.AccountStatuses = AccountStatuses;
 Sales.Priorities = Priorities;
 Sales.Customers = Customers;
+Sales.Contacts = Contacts;
 Sales.SalesOrders = SalesOrders;
 
 export declare namespace Sales {
@@ -155,35 +144,20 @@ export declare namespace Sales {
 
   export {
     Customers as Customers,
-    type AccountUser as AccountUser,
     type Carrier as Carrier,
-    type Consumption as Consumption,
     type CreateCustomerRequest as CreateCustomerRequest,
     type Customer as Customer,
     type CustomerContactInfo as CustomerContactInfo,
     type CustomerDefaults as CustomerDefaults,
     type CustomerFreightPreferences as CustomerFreightPreferences,
     type CustomerNotificationPreferences as CustomerNotificationPreferences,
-    type Department as Department,
-    type ListConsumption as ListConsumption,
     type ListCustomer as ListCustomer,
-    type ListLocation as ListLocation,
-    type ListMachine as ListMachine,
-    type ListProductionStep as ListProductionStep,
-    type ListScanningStation as ListScanningStation,
     type ListServiceLevel as ListServiceLevel,
-    type Location as Location,
-    type LocationTypeCode as LocationTypeCode,
-    type Machine as Machine,
     type PaymentTerm as PaymentTerm,
-    type ProductionOutput as ProductionOutput,
-    type ProductionStep as ProductionStep,
     type QuantityInput as QuantityInput,
-    type ScanningStation as ScanningStation,
     type ServiceLevel as ServiceLevel,
     type ShippingTerm as ShippingTerm,
     type UpdateCustomerRequest as UpdateCustomerRequest,
-    type User as User,
     type CustomerDeleteResponse as CustomerDeleteResponse,
     type CustomerListParams as CustomerListParams,
     type CustomerRetrieveParams as CustomerRetrieveParams,
@@ -191,6 +165,8 @@ export declare namespace Sales {
     type CustomerUpdateParams as CustomerUpdateParams,
   };
 
+  export { Contacts as Contacts };
+
   export {
     SalesOrders as SalesOrders,
     type CreateSalesOrderLineInput as CreateSalesOrderLineInput,

package/src/resources/settings/integrations.ts

@@ -13,6 +13,8 @@ export class Integrations extends APIResource {
   /**
    * Returns a paginated list of account integrations for the target account.
    *
+   * This endpoint requires the `admin` role type.
+   *
    * @example
    * ```ts
    * const listAccountIntegration =
@@ -34,6 +36,8 @@ export class Integrations extends APIResource {
    * returned in API responses. An account can have at most one integration per
    * integration code.
    *
+   * This endpoint requires the `admin` role type.
+   *
    * @example
    * ```ts
    * const accountIntegration =
@@ -56,6 +60,8 @@ export class Integrations extends APIResource {
    * endpoint; to rotate credentials, call Create Account Integration again with the
    * same integration code.
    *
+   * This endpoint requires the `admin` role type.
+   *
    * @example
    * ```ts
    * const accountIntegration =
@@ -76,6 +82,8 @@ export class Integrations extends APIResource {
   /**
    * Deletes an account integration and returns the deleted resource.
    *
+   * This endpoint requires the `admin` role type.
+   *
    * @example
    * ```ts
    * const accountIntegration =

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.7.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.7.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.7.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.7.0'; // x-release-please-version
+exports.VERSION = '0.7.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.7.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map