@augno/sdk 0.1.6 → 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,9 +41,30 @@ 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 =
@@ -62,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
@@ -95,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 {
   /**
@@ -104,7 +113,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';
 
@@ -114,17 +128,23 @@ 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;
 
@@ -134,13 +154,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';
 
@@ -155,27 +174,45 @@ 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';
 }
@@ -205,97 +242,143 @@ 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 AccountGroupCreateParams {
+export interface AccountGroupListParams {
   /**
-   * Display name.
+   * 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.
    */
-  name: string;
+  cursor?: string;
 
   /**
-   * Account group type.
+   * Maximum number of results to return in a single page.
    */
-  type: 'pricing_group' | 'type_group';
+  limit?: number;
 
   /**
-   * Commission policy.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  commission_policy?: 'commission_applied' | 'commission_exempt';
+  q?: string;
 
   /**
-   * Description.
+   * Filters results to account groups of the given type.
    */
-  description?: string;
+  type?: 'pricing_group' | 'type_group';
+}
 
+export interface AccountGroupCreateParams {
   /**
-   * Freight policy.
+   * Display name of the account group.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
-}
+  name: string;
 
-export interface AccountGroupUpdateParams {
   /**
-   * Commission policy.
+   * 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.
    */
-  commission_policy?: 'commission_applied' | 'commission_exempt';
+  type: 'pricing_group' | 'type_group';
 
   /**
-   * Description.
+   * 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.
    */
-  description?: string | null;
+  commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Freight policy.
+   * Free-form description of the account group.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
+  description?: string;
 
   /**
-   * Display name.
+   * 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.
    */
-  name?: string;
+  freight_policy?: 'free_freight' | 'billed_freight';
 }
 
-export interface AccountGroupListParams {
+export interface AccountGroupUpdateParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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.
    */
-  cursor?: string;
+  commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Free-form description of the account group.
    */
-  limit?: number;
+  description?: string | null;
 
   /**
-   * Search query used to filter results.
+   * 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.
    */
-  q?: string;
+  freight_policy?: 'free_freight' | 'billed_freight';
 
   /**
-   * Account group type filter.
+   * Display name of the account group.
+   *
+   * Must be unique within your account; maximum 255 characters.
    */
-  type?: 'pricing_group' | 'type_group';
+  name?: string;
 }
 
 export declare namespace AccountGroups {
@@ -305,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,
   };
 }