@augno/sdk 0.1.9 → 0.7.0

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

@@ -11,19 +11,19 @@ import { path } from '../../internal/utils/path';
  */
 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: AccountGroupCreateParams, options?: RequestOptions): APIPromise<AccountGroup> {
-    return this._client.post('/v1/sales/account-groups', { body, ...options });
+  list(
+    query: AccountGroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListAccountGroup> {
+    return this._client.get('/v1/sales/account-groups', { query, ...options });
   }
 
   /**
@@ -41,14 +41,36 @@ export class AccountGroups extends APIResource {
     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: AccountGroupCreateParams, options?: RequestOptions): APIPromise<AccountGroup> {
+    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 =
    *   await client.sales.accountGroups.update(
    *     'acgp_018e88072d1320808dc979cfac',
+   *     { name: 'Updated Wholesale Customers' },
    *   );
    * ```
    */
@@ -61,24 +83,11 @@ export class AccountGroups extends APIResource {
   }
 
   /**
-   * 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> {
-    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
@@ -94,7 +103,8 @@ export class AccountGroups extends APIResource {
 }
 
 /**
- * Account group resource.
+ * A named grouping of customer accounts, used for pricing rules or to categorize
+ * accounts.
  */
 export interface AccountGroup {
   /**
@@ -103,11 +113,12 @@ export interface AccountGroup {
   id: string;
 
   /**
-   * Commission policy.
+   * How sales commission applies to accounts in this group.
    *
-   * - `commission_exempt`: no commission applies.
-   * - `commission_applied`: commission applies; if the account group is within a
-   *   sales rep's territory, it will be assigned to that rep unless overridden.
+   * - `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';
 
@@ -117,12 +128,12 @@ 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
@@ -131,7 +142,9 @@ export interface AccountGroup {
   freight_policy: 'free_freight' | 'billed_freight';
 
   /**
-   * Display name.
+   * Display name of the account group.
+   *
+   * Unique within the account.
    */
   name: string;
 
@@ -141,7 +154,7 @@ export interface AccountGroup {
   object: 'account_group';
 
   /**
-   * Account group type.
+   * How this account group is used.
    *
    * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
    *   receives a special discount.
@@ -161,38 +174,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.
-   *
-   * Cannot be changed after creation.
+   * 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. Defaults to `commission_exempt`.
+   * How sales commission applies to accounts in this group.
    *
-   * - `commission_exempt`: no commission applies.
-   * - `commission_applied`: commission applies; if the account group is within a
-   *   sales rep's territory, it will be assigned to that rep unless overridden.
+   * - `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. Defaults to `billed_freight`.
+   * 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
@@ -226,21 +242,22 @@ export interface ListAccountGroup {
  */
 export interface UpdateAccountGroupRequest {
   /**
-   * Commission policy.
+   * How sales commission applies to accounts in this group.
    *
-   * - `commission_exempt`: no commission applies.
-   * - `commission_applied`: commission applies; if the account group is within a
-   *   sales rep's territory, it will be assigned to that rep unless overridden.
+   * - `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
@@ -249,47 +266,80 @@ export interface UpdateAccountGroupRequest {
   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.
-   *
-   * Cannot be changed after creation.
+   * 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. Defaults to `commission_exempt`.
+   * How sales commission applies to accounts in this group.
    *
-   * - `commission_exempt`: no commission applies.
-   * - `commission_applied`: commission applies; if the account group is within a
-   *   sales rep's territory, it will be assigned to that rep unless overridden.
+   * - `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. Defaults to `billed_freight`.
+   * 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
@@ -300,21 +350,22 @@ export interface AccountGroupCreateParams {
 
 export interface AccountGroupUpdateParams {
   /**
-   * Commission policy.
+   * How sales commission applies to accounts in this group.
    *
-   * - `commission_exempt`: no commission applies.
-   * - `commission_applied`: commission applies; if the account group is within a
-   *   sales rep's territory, it will be assigned to that rep unless overridden.
+   * - `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
@@ -323,33 +374,13 @@ export interface AccountGroupUpdateParams {
   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,
@@ -357,8 +388,8 @@ export declare namespace AccountGroups {
     type ListAccountGroup as ListAccountGroup,
     type UpdateAccountGroupRequest as UpdateAccountGroupRequest,
     type AccountGroupDeleteResponse as AccountGroupDeleteResponse,
+    type AccountGroupListParams as AccountGroupListParams,
     type AccountGroupCreateParams as AccountGroupCreateParams,
     type AccountGroupUpdateParams as AccountGroupUpdateParams,
-    type AccountGroupListParams as AccountGroupListParams,
   };
 }

package/src/resources/sales/account-statuses.ts

@@ -10,6 +10,26 @@ import { path } from '../../internal/utils/path';
  * List and retrieve account statuses.
  */
 export class AccountStatuses extends APIResource {
+  /**
+   * 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 listAccountStatus =
+   *   await client.sales.accountStatuses.list();
+   * ```
+   */
+  list(
+    query: AccountStatusListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListAccountStatus> {
+    return this._client.get('/v1/sales/account-statuses', { query, ...options });
+  }
+
   /**
    * Returns an account status by ID or code.
    *
@@ -28,27 +48,11 @@ export class AccountStatuses extends APIResource {
   ): APIPromise<AccountStatus> {
     return this._client.get(path`/v1/sales/account-statuses/${id}`, { query, ...options });
   }
-
-  /**
-   * Returns a paginated list of account statuses. Global lookup values for setting
-   * account relationship statuses.
-   *
-   * @example
-   * ```ts
-   * const listAccountStatus =
-   *   await client.sales.accountStatuses.list();
-   * ```
-   */
-  list(
-    query: AccountStatusListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ListAccountStatus> {
-    return this._client.get('/v1/sales/account-statuses', { query, ...options });
-  }
 }
 
 /**
- * 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 {
   /**
@@ -58,6 +62,14 @@ export interface AccountStatus {
 
   /**
    * 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';
 
@@ -107,17 +119,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;
 
@@ -128,21 +136,31 @@ 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,
+    type AccountStatusRetrieveParams as AccountStatusRetrieveParams,
   };
 }