@augno/sdk 0.1.6 → 0.7.0

package/resources/sales/account-groups.d.ts

@@ -7,18 +7,15 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class AccountGroups extends APIResource {
     /**
-     * Creates an account group.
+     * Returns a paginated list of account groups.
      *
      * @example
      * ```ts
-     * const accountGroup =
-     *   await client.sales.accountGroups.create({
-     *     name: 'Wholesale Customers',
-     *     type: 'type_group',
-     *   });
+     * const listAccountGroup =
+     *   await client.sales.accountGroups.list();
      * ```
      */
-    create(body: AccountGroupCreateParams, options?: RequestOptions): APIPromise<AccountGroup>;
+    list(query?: AccountGroupListParams | null | undefined, options?: RequestOptions): APIPromise<ListAccountGroup>;
     /**
      * Returns an account group by ID.
      *
@@ -31,9 +28,27 @@ export declare class AccountGroups extends APIResource {
      * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<AccountGroup>;
+    /**
+     * Creates an account group.
+     *
+     * Returns a conflict error if an account group with the same name already exists.
+     *
+     * @example
+     * ```ts
+     * const accountGroup =
+     *   await client.sales.accountGroups.create({
+     *     name: 'Wholesale Customers',
+     *     type: 'type_group',
+     *   });
+     * ```
+     */
+    create(body: AccountGroupCreateParams, options?: RequestOptions): APIPromise<AccountGroup>;
     /**
      * Partially updates an account group.
      *
+     * Only the provided fields are changed. The account group's `type` cannot be
+     * changed after creation.
+     *
      * @example
      * ```ts
      * const accountGroup =
@@ -45,18 +60,11 @@ export declare class AccountGroups extends APIResource {
      */
     update(id: string, body?: AccountGroupUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AccountGroup>;
     /**
-     * Returns a paginated list of account groups.
+     * Deletes an account group.
      *
-     * @example
-     * ```ts
-     * const listAccountGroup =
-     *   await client.sales.accountGroups.list();
-     * ```
-     */
-    list(query?: AccountGroupListParams | null | undefined, options?: RequestOptions): APIPromise<ListAccountGroup>;
-    /**
-     * Deletes an account group. Fails if the account group is actively used in
-     * production.
+     * Deletion fails with a validation error while the account group is still in use —
+     * for example by customer records, product line access, volume discounts, pricing
+     * assignments, or an active registration flow.
      *
      * @example
      * ```ts
@@ -69,7 +77,8 @@ export declare class AccountGroups extends APIResource {
     delete(id: string, options?: RequestOptions): APIPromise<AccountGroupDeleteResponse>;
 }
 /**
- * Account group resource.
+ * A named grouping of customer accounts, used for pricing rules or to categorize
+ * accounts.
  */
 export interface AccountGroup {
     /**
@@ -77,7 +86,12 @@ export interface AccountGroup {
      */
     id: string;
     /**
-     * Commission policy.
+     * How sales commission applies to accounts in this group.
+     *
+     * - `commission_applied`: sales commission is calculated on orders from accounts
+     *   in this group.
+     * - `commission_exempt`: orders from accounts in this group are exempt from
+     *   commission.
      */
     commission_policy: 'commission_applied' | 'commission_exempt';
     /**
@@ -85,15 +99,21 @@ export interface AccountGroup {
      */
     created_at: string;
     /**
-     * Description.
+     * Free-form description of the account group.
      */
     description: string | null;
     /**
-     * Freight policy.
+     * How freight charges apply to orders from accounts in this group.
+     *
+     * - `free_freight`: customers within this group will not have to pay for freight.
+     * - `billed_freight`: freight will be applied to any order within this account
+     *   group, unless overridden elsewhere.
      */
     freight_policy: 'free_freight' | 'billed_freight';
     /**
-     * Display name.
+     * Display name of the account group.
+     *
+     * Unique within the account.
      */
     name: string;
     /**
@@ -101,13 +121,12 @@ export interface AccountGroup {
      */
     object: 'account_group';
     /**
-     * Account group type.
+     * How this account group is used.
      *
-     * The type `pricing_group` indicates this account group is utilized for pricing
-     * rules. For example, you may have a 'Preferred' price group that receives a
-     * special discount rate. The type `type_group` indicates the account group is
-     * utilized to categorize a set of accounts. For example, you may have a group of
-     * accounts that are 'Consumers' or 'Distributors'.
+     * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+     *   receives a special discount.
+     * - `type_group`: used to categorize accounts, such as "Consumers" or
+     *   "Distributors".
      */
     type: 'pricing_group' | 'type_group';
     /**
@@ -120,23 +139,41 @@ export interface AccountGroup {
  */
 export interface CreateAccountGroupRequest {
     /**
-     * Display name.
+     * Display name of the account group.
+     *
+     * Must be unique within your account; maximum 255 characters.
      */
     name: string;
     /**
-     * Account group type.
+     * How this account group will be used.
+     *
+     * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+     *   receives a special discount.
+     * - `type_group`: used to categorize accounts, such as "Consumers" or
+     *   "Distributors".
+     *
+     * The type cannot be changed after creation.
      */
     type: 'pricing_group' | 'type_group';
     /**
-     * Commission policy.
+     * How sales commission applies to accounts in this group.
+     *
+     * - `commission_applied`: sales commission is calculated on orders from accounts
+     *   in this group.
+     * - `commission_exempt`: orders from accounts in this group are exempt from
+     *   commission.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Description.
+     * Free-form description of the account group.
      */
     description?: string;
     /**
-     * Freight policy.
+     * How freight charges apply to orders from accounts in this group.
+     *
+     * - `free_freight`: customers within this group will not have to pay for freight.
+     * - `billed_freight`: freight will be applied to any order within this account
+     *   group, unless overridden elsewhere.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
 }
@@ -162,83 +199,129 @@ export interface ListAccountGroup {
  */
 export interface UpdateAccountGroupRequest {
     /**
-     * Commission policy.
+     * How sales commission applies to accounts in this group.
+     *
+     * - `commission_applied`: sales commission is calculated on orders from accounts
+     *   in this group.
+     * - `commission_exempt`: orders from accounts in this group are exempt from
+     *   commission.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Description.
+     * Free-form description of the account group.
      */
     description?: string | null;
     /**
-     * Freight policy.
+     * How freight charges apply to orders from accounts in this group.
+     *
+     * - `free_freight`: customers within this group will not have to pay for freight.
+     * - `billed_freight`: freight will be applied to any order within this account
+     *   group, unless overridden elsewhere.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Display name.
+     * Display name of the account group.
+     *
+     * Must be unique within your account; maximum 255 characters.
      */
     name?: string;
 }
 export interface AccountGroupDeleteResponse {
 }
+export interface AccountGroupListParams {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Filters results to account groups of the given type.
+     */
+    type?: 'pricing_group' | 'type_group';
+}
 export interface AccountGroupCreateParams {
     /**
-     * Display name.
+     * Display name of the account group.
+     *
+     * Must be unique within your account; maximum 255 characters.
      */
     name: string;
     /**
-     * Account group type.
+     * How this account group will be used.
+     *
+     * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+     *   receives a special discount.
+     * - `type_group`: used to categorize accounts, such as "Consumers" or
+     *   "Distributors".
+     *
+     * The type cannot be changed after creation.
      */
     type: 'pricing_group' | 'type_group';
     /**
-     * Commission policy.
+     * How sales commission applies to accounts in this group.
+     *
+     * - `commission_applied`: sales commission is calculated on orders from accounts
+     *   in this group.
+     * - `commission_exempt`: orders from accounts in this group are exempt from
+     *   commission.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Description.
+     * Free-form description of the account group.
      */
     description?: string;
     /**
-     * Freight policy.
+     * How freight charges apply to orders from accounts in this group.
+     *
+     * - `free_freight`: customers within this group will not have to pay for freight.
+     * - `billed_freight`: freight will be applied to any order within this account
+     *   group, unless overridden elsewhere.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
 }
 export interface AccountGroupUpdateParams {
     /**
-     * Commission policy.
+     * How sales commission applies to accounts in this group.
+     *
+     * - `commission_applied`: sales commission is calculated on orders from accounts
+     *   in this group.
+     * - `commission_exempt`: orders from accounts in this group are exempt from
+     *   commission.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Description.
+     * Free-form description of the account group.
      */
     description?: string | null;
     /**
-     * Freight policy.
+     * How freight charges apply to orders from accounts in this group.
+     *
+     * - `free_freight`: customers within this group will not have to pay for freight.
+     * - `billed_freight`: freight will be applied to any order within this account
+     *   group, unless overridden elsewhere.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Display name.
+     * Display name of the account group.
+     *
+     * Must be unique within your account; maximum 255 characters.
      */
     name?: string;
 }
-export interface AccountGroupListParams {
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-    /**
-     * Account group type filter.
-     */
-    type?: 'pricing_group' | 'type_group';
-}
 export declare namespace AccountGroups {
-    export { type AccountGroup as AccountGroup, type CreateAccountGroupRequest as CreateAccountGroupRequest, type ListAccountGroup as ListAccountGroup, type UpdateAccountGroupRequest as UpdateAccountGroupRequest, type AccountGroupDeleteResponse as AccountGroupDeleteResponse, type AccountGroupCreateParams as AccountGroupCreateParams, type AccountGroupUpdateParams as AccountGroupUpdateParams, type AccountGroupListParams as AccountGroupListParams, };
+    export { type AccountGroup as AccountGroup, type CreateAccountGroupRequest as CreateAccountGroupRequest, type ListAccountGroup as ListAccountGroup, type UpdateAccountGroupRequest as UpdateAccountGroupRequest, type AccountGroupDeleteResponse as AccountGroupDeleteResponse, type AccountGroupListParams as AccountGroupListParams, type AccountGroupCreateParams as AccountGroupCreateParams, type AccountGroupUpdateParams as AccountGroupUpdateParams, };
 }
 //# sourceMappingURL=account-groups.d.ts.map

package/resources/sales/account-groups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account-groups.d.ts","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE9D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;;;;;;;OAQG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAEnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;CACpD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAEnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,YAAY,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"account-groups.d.ts","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAI1F;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;OAOG;IACH,iBAAiB,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE9D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;;OAMG;IACH,cAAc,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAElD;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;;;;;;OAOG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;OASG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAEnD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,YAAY,CAAC;CACvC;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;OASG;IACH,IAAI,EAAE,eAAe,GAAG,YAAY,CAAC;IAErC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;CACpD;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,oBAAoB,GAAG,mBAAmB,CAAC;IAE/D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;IAEnD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/sales/account-groups.js

@@ -9,19 +9,16 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class AccountGroups extends resource_1.APIResource {
     /**
-     * Creates an account group.
+     * Returns a paginated list of account groups.
      *
      * @example
      * ```ts
-     * const accountGroup =
-     *   await client.sales.accountGroups.create({
-     *     name: 'Wholesale Customers',
-     *     type: 'type_group',
-     *   });
+     * const listAccountGroup =
+     *   await client.sales.accountGroups.list();
      * ```
      */
-    create(body, options) {
-        return this._client.post('/v1/sales/account-groups', { body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/sales/account-groups', { query, ...options });
     }
     /**
      * Returns an account group by ID.
@@ -37,9 +34,29 @@ class AccountGroups extends resource_1.APIResource {
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/v1/sales/account-groups/${id}`, options);
     }
+    /**
+     * Creates an account group.
+     *
+     * Returns a conflict error if an account group with the same name already exists.
+     *
+     * @example
+     * ```ts
+     * const accountGroup =
+     *   await client.sales.accountGroups.create({
+     *     name: 'Wholesale Customers',
+     *     type: 'type_group',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/sales/account-groups', { body, ...options });
+    }
     /**
      * Partially updates an account group.
      *
+     * Only the provided fields are changed. The account group's `type` cannot be
+     * changed after creation.
+     *
      * @example
      * ```ts
      * const accountGroup =
@@ -53,20 +70,11 @@ class AccountGroups extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/v1/sales/account-groups/${id}`, { body, ...options });
     }
     /**
-     * Returns a paginated list of account groups.
+     * Deletes an account group.
      *
-     * @example
-     * ```ts
-     * const listAccountGroup =
-     *   await client.sales.accountGroups.list();
-     * ```
-     */
-    list(query = {}, options) {
-        return this._client.get('/v1/sales/account-groups', { query, ...options });
-    }
-    /**
-     * Deletes an account group. Fails if the account group is actively used in
-     * production.
+     * Deletion fails with a validation error while the account group is still in use —
+     * for example by customer records, product line access, volume discounts, pricing
+     * assignments, or an active registration flow.
      *
      * @example
      * ```ts

package/resources/sales/account-groups.js.map

@@ -1 +1 @@
-{"version":3,"file":"account-groups.js","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AAnFD,sCAmFC"}
+{"version":3,"file":"account-groups.js","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AA3FD,sCA2FC"}

package/resources/sales/account-groups.mjs

@@ -6,19 +6,16 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class AccountGroups extends APIResource {
     /**
-     * Creates an account group.
+     * Returns a paginated list of account groups.
      *
      * @example
      * ```ts
-     * const accountGroup =
-     *   await client.sales.accountGroups.create({
-     *     name: 'Wholesale Customers',
-     *     type: 'type_group',
-     *   });
+     * const listAccountGroup =
+     *   await client.sales.accountGroups.list();
      * ```
      */
-    create(body, options) {
-        return this._client.post('/v1/sales/account-groups', { body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/sales/account-groups', { query, ...options });
     }
     /**
      * Returns an account group by ID.
@@ -34,9 +31,29 @@ export class AccountGroups extends APIResource {
     retrieve(id, options) {
         return this._client.get(path `/v1/sales/account-groups/${id}`, options);
     }
+    /**
+     * Creates an account group.
+     *
+     * Returns a conflict error if an account group with the same name already exists.
+     *
+     * @example
+     * ```ts
+     * const accountGroup =
+     *   await client.sales.accountGroups.create({
+     *     name: 'Wholesale Customers',
+     *     type: 'type_group',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/sales/account-groups', { body, ...options });
+    }
     /**
      * Partially updates an account group.
      *
+     * Only the provided fields are changed. The account group's `type` cannot be
+     * changed after creation.
+     *
      * @example
      * ```ts
      * const accountGroup =
@@ -50,20 +67,11 @@ export class AccountGroups extends APIResource {
         return this._client.patch(path `/v1/sales/account-groups/${id}`, { body, ...options });
     }
     /**
-     * Returns a paginated list of account groups.
+     * Deletes an account group.
      *
-     * @example
-     * ```ts
-     * const listAccountGroup =
-     *   await client.sales.accountGroups.list();
-     * ```
-     */
-    list(query = {}, options) {
-        return this._client.get('/v1/sales/account-groups', { query, ...options });
-    }
-    /**
-     * Deletes an account group. Fails if the account group is actively used in
-     * production.
+     * Deletion fails with a validation error while the account group is still in use —
+     * for example by customer records, product line access, volume discounts, pricing
+     * assignments, or an active registration flow.
      *
      * @example
      * ```ts

package/resources/sales/account-groups.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"account-groups.mjs","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}
+{"version":3,"file":"account-groups.mjs","sourceRoot":"","sources":["../../src/resources/sales/account-groups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/resources/sales/account-statuses.d.mts

@@ -7,31 +7,35 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class AccountStatuses extends APIResource {
     /**
-     * Returns an account status by ID or code.
+     * Returns a paginated list of account statuses.
+     *
+     * Account statuses are system-provided lookup values shared across all accounts,
+     * used to set a customer's status (for example, placing a customer on a credit
+     * hold).
      *
      * @example
      * ```ts
-     * const accountStatus =
-     *   await client.sales.accountStatuses.retrieve(
-     *     'acss_01004f532c58d60514b685cb27',
-     *   );
+     * const listAccountStatus =
+     *   await client.sales.accountStatuses.list();
      * ```
      */
-    retrieve(id: string, query?: AccountStatusRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AccountStatus>;
+    list(query?: AccountStatusListParams | null | undefined, options?: RequestOptions): APIPromise<ListAccountStatus>;
     /**
-     * Returns a paginated list of account statuses. Global lookup values for setting
-     * account relationship statuses.
+     * Returns an account status by ID or code.
      *
      * @example
      * ```ts
-     * const listAccountStatus =
-     *   await client.sales.accountStatuses.list();
+     * const accountStatus =
+     *   await client.sales.accountStatuses.retrieve(
+     *     'acss_01004f532c58d60514b685cb27',
+     *   );
      * ```
      */
-    list(query?: AccountStatusListParams | null | undefined, options?: RequestOptions): APIPromise<ListAccountStatus>;
+    retrieve(id: string, query?: AccountStatusRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AccountStatus>;
 }
 /**
- * AccountStatus is an account status lookup value.
+ * AccountStatus is a lookup value describing the standing of a customer account,
+ * such as whether shipments or all activity should be held.
  */
 export interface AccountStatus {
     /**
@@ -40,6 +44,14 @@ export interface AccountStatus {
     id: string;
     /**
      * Machine-readable status code.
+     *
+     * This is the value used as a customer's `status`.
+     *
+     * - `normal`: standard account with no restrictions.
+     * - `preferred`: account flagged as preferred (e.g. for prioritized handling).
+     * - `hold_shipment`: shipments to this account are held; orders may still be
+     *   placed.
+     * - `hold_all`: all activity for this account is held.
      */
     code: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
@@ -80,16 +92,13 @@ export interface ListAccountStatus {
      */
     page_info: APIKeysAPI.PageInfo;
 }
-export interface AccountStatusRetrieveParams {
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner'>;
-}
 export interface AccountStatusListParams {
     /**
-     * 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;
     /**
@@ -98,15 +107,24 @@ export interface AccountStatusListParams {
      */
     include?: Array<'owner'>;
     /**
-     * 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 AccountStatusRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner'>;
+}
 export declare namespace AccountStatuses {
-    export { type AccountStatus as AccountStatus, type ListAccountStatus as ListAccountStatus, type AccountStatusRetrieveParams as AccountStatusRetrieveParams, type AccountStatusListParams as AccountStatusListParams, };
+    export { type AccountStatus as AccountStatus, type ListAccountStatus as ListAccountStatus, type AccountStatusListParams as AccountStatusListParams, type AccountStatusRetrieveParams as AccountStatusRetrieveParams, };
 }
 //# sourceMappingURL=account-statuses.d.mts.map