@augno/sdk 0.1.6 → 0.7.0

package/src/resources/sales/addresses.ts

@@ -11,18 +11,15 @@ import { path } from '../../internal/utils/path';
  */
 export class Addresses extends APIResource {
   /**
-   * Creates an address for the targeted account.
+   * Returns a paginated list of addresses.
    *
    * @example
    * ```ts
-   * const address = await client.sales.addresses.create({
-   *   country: 'US',
-   *   name: 'Headquarters',
-   * });
+   * const listAddress = await client.sales.addresses.list();
    * ```
    */
-  create(body: AddressCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Address> {
-    return this._client.post('/v1/sales/addresses', { body, ...options });
+  list(query: AddressListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListAddress> {
+    return this._client.get('/v1/sales/addresses', { query, ...options });
   }
 
   /**
@@ -39,9 +36,31 @@ export class Addresses extends APIResource {
     return this._client.get(path`/v1/sales/addresses/${id}`, options);
   }
 
+  /**
+   * Creates an address.
+   *
+   * @example
+   * ```ts
+   * const address = await client.sales.addresses.create({
+   *   country: 'US',
+   *   name: 'Headquarters',
+   *   locality: 'Springfield',
+   *   postal_code: '62701',
+   *   state: 'IL',
+   *   street_line_1: '123 Main St',
+   * });
+   * ```
+   */
+  create(body: AddressCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Address> {
+    return this._client.post('/v1/sales/addresses', { body, ...options });
+  }
+
   /**
    * Partially updates an address.
    *
+   * Changing a street, locality, state, postal code, or country field may replace
+   * the address's geolocation, so the geolocation `id` in the response can change.
+   *
    * @example
    * ```ts
    * const address = await client.sales.addresses.update(
@@ -59,20 +78,10 @@ export class Addresses extends APIResource {
   }
 
   /**
-   * Returns a paginated list of addresses.
+   * Deletes an address.
    *
-   * @example
-   * ```ts
-   * const listAddress = await client.sales.addresses.list();
-   * ```
-   */
-  list(query: AddressListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListAddress> {
-    return this._client.get('/v1/sales/addresses', { query, ...options });
-  }
-
-  /**
-   * Deletes an address. Fails if the address is in use as a billing or shipping
-   * address on a sales order, invoice, or shipment, or as a default account address.
+   * Deletion fails if the address is in use as a billing or shipping address on a
+   * sales order, invoice, or shipment, or as a default account address.
    *
    * @example
    * ```ts
@@ -87,7 +96,8 @@ export class Addresses extends APIResource {
 }
 
 /**
- * Request to create an address.
+ * Address details used to create an address, either directly or inline on another
+ * resource.
  */
 export interface AddressInput {
   /**
@@ -103,40 +113,44 @@ export interface AddressInput {
   /**
    * Email address associated with the address.
    */
-  email?: string | null;
+  email?: string;
 
   /**
    * City or locality.
    */
-  locality?: string | null;
+  locality?: string;
 
   /**
    * Phone number associated with the address.
    */
-  phone?: string | null;
+  phone?: string;
 
   /**
    * Postal or ZIP code.
    */
-  postal_code?: string | null;
+  postal_code?: string;
 
   /**
    * State or administrative area.
    */
-  state?: string | null;
+  state?: string;
 
   /**
    * First line of the street address.
    */
-  street_line_1?: string | null;
+  street_line_1?: string;
 
   /**
    * Second line of the street address.
    */
-  street_line_2?: string | null;
+  street_line_2?: string;
 
   /**
    * Address type.
+   *
+   * - `standard`: a normal shipping or billing address.
+   * - `drop_ship`: an address an order is shipped to directly, typically a third
+   *   party or end customer rather than the account itself.
    */
   type?: 'standard' | 'drop_ship';
 }
@@ -163,6 +177,8 @@ export interface ListAddress {
 
 /**
  * Request to partially update an address.
+ *
+ * Omitted fields are left unchanged.
  */
 export interface UpdateAddressRequest {
   /**
@@ -172,6 +188,8 @@ export interface UpdateAddressRequest {
 
   /**
    * Email address associated with the address.
+   *
+   * Send `null` to clear.
    */
   email?: string | null;
 
@@ -187,6 +205,8 @@ export interface UpdateAddressRequest {
 
   /**
    * Phone number associated with the address.
+   *
+   * Send `null` to clear.
    */
   phone?: string | null;
 
@@ -207,17 +227,51 @@ export interface UpdateAddressRequest {
 
   /**
    * Second line of the street address.
+   *
+   * Send `null` to clear.
    */
   street_line_2?: string | null;
 
   /**
    * Address type.
+   *
+   * - `standard`: a normal shipping or billing address.
+   * - `drop_ship`: an address an order is shipped to directly, typically a third
+   *   party or end customer rather than the account itself.
    */
   type?: 'standard' | 'drop_ship';
 }
 
 export interface AddressDeleteResponse {}
 
+export interface AddressListParams {
+  /**
+   * 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;
+
+  /**
+   * Filter results to a single address type (`standard` or `drop_ship`).
+   */
+  type?: 'standard' | 'drop_ship';
+}
+
 export interface AddressCreateParams {
   /**
    * Two-letter country code.
@@ -232,40 +286,44 @@ export interface AddressCreateParams {
   /**
    * Email address associated with the address.
    */
-  email?: string | null;
+  email?: string;
 
   /**
    * City or locality.
    */
-  locality?: string | null;
+  locality?: string;
 
   /**
    * Phone number associated with the address.
    */
-  phone?: string | null;
+  phone?: string;
 
   /**
    * Postal or ZIP code.
    */
-  postal_code?: string | null;
+  postal_code?: string;
 
   /**
    * State or administrative area.
    */
-  state?: string | null;
+  state?: string;
 
   /**
    * First line of the street address.
    */
-  street_line_1?: string | null;
+  street_line_1?: string;
 
   /**
    * Second line of the street address.
    */
-  street_line_2?: string | null;
+  street_line_2?: string;
 
   /**
    * Address type.
+   *
+   * - `standard`: a normal shipping or billing address.
+   * - `drop_ship`: an address an order is shipped to directly, typically a third
+   *   party or end customer rather than the account itself.
    */
   type?: 'standard' | 'drop_ship';
 }
@@ -278,6 +336,8 @@ export interface AddressUpdateParams {
 
   /**
    * Email address associated with the address.
+   *
+   * Send `null` to clear.
    */
   email?: string | null;
 
@@ -293,6 +353,8 @@ export interface AddressUpdateParams {
 
   /**
    * Phone number associated with the address.
+   *
+   * Send `null` to clear.
    */
   phone?: string | null;
 
@@ -313,33 +375,17 @@ export interface AddressUpdateParams {
 
   /**
    * Second line of the street address.
+   *
+   * Send `null` to clear.
    */
   street_line_2?: string | null;
 
   /**
    * Address type.
-   */
-  type?: 'standard' | 'drop_ship';
-}
-
-export interface AddressListParams {
-  /**
-   * 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;
-
-  /**
-   * Filter by address type.
+   *
+   * - `standard`: a normal shipping or billing address.
+   * - `drop_ship`: an address an order is shipped to directly, typically a third
+   *   party or end customer rather than the account itself.
    */
   type?: 'standard' | 'drop_ship';
 }
@@ -350,8 +396,8 @@ export declare namespace Addresses {
     type ListAddress as ListAddress,
     type UpdateAddressRequest as UpdateAddressRequest,
     type AddressDeleteResponse as AddressDeleteResponse,
+    type AddressListParams as AddressListParams,
     type AddressCreateParams as AddressCreateParams,
     type AddressUpdateParams as AddressUpdateParams,
-    type AddressListParams as AddressListParams,
   };
 }

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

@@ -11,8 +11,12 @@ import { path } from '../../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Merges one or more source customers into a target customer, reassigning all
-   * associated records and deleting the source accounts.
+   * Merges one or more source customers into a target customer.
+   *
+   * Sales orders, invoices, shipments, deliveries, and other transaction records
+   * from the source customers are reassigned to the target; price groups, product
+   * line access, addresses, and users are consolidated without duplicates; the
+   * source customers are then deleted.
    *
    * @example
    * ```ts
@@ -39,14 +43,20 @@ export class Actions extends APIResource {
  */
 export interface MergeCustomersRequest {
   /**
-   * Source customer IDs.
+   * IDs of the source customers to merge into the target.
+   *
+   * Sources are deleted after the merge. The list must not contain duplicates or the
+   * target customer's ID.
    */
   source_customer_ids: Array<string>;
 }
 
 export interface ActionMergeParams {
   /**
-   * Body param: Source customer IDs.
+   * Body param: IDs of the source customers to merge into the target.
+   *
+   * Sources are deleted after the merge. The list must not contain duplicates or the
+   * target customer's ID.
    */
   source_customer_ids: Array<string>;
 
@@ -64,6 +74,7 @@ export interface ActionMergeParams {
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
     | 'defaults.sales_rep'
+    | 'defaults.sales_rep.user'
     | 'defaults.priority'
     | 'contact_info'
     | 'freight_preferences'