@augno/sdk 0.1.9 → 0.7.1

package/src/resources/sales/addresses.ts

@@ -11,23 +11,26 @@ import { path } from '../../internal/utils/path';
  */
 export class Addresses extends APIResource {
   /**
-   * Creates an address for the targeted account.
+   * Returns a paginated list of addresses.
+   *
+   * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+   * `suppliers:read`.
    *
    * @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 });
   }
 
   /**
    * Retrieves an address by ID.
    *
+   * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const address = await client.sales.addresses.retrieve(
@@ -39,13 +42,42 @@ export class Addresses extends APIResource {
     return this._client.get(path`/v1/sales/addresses/${id}`, options);
   }
 
+  /**
+   * Creates an address.
+   *
+   * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+   * `suppliers:update`.
+   *
+   * @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.
+   *
+   * This endpoint requires the permissions: `addresses:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const address = await client.sales.addresses.update(
    *   'ad_012100950cfaa34aa0e0ad7258',
+   *   { name: 'Warehouse' },
    * );
    * ```
    */
@@ -58,20 +90,13 @@ 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.
+   *
+   * This endpoint requires the permissions: `addresses:delete`, `customers:update`,
+   * `suppliers:update`.
    *
    * @example
    * ```ts
@@ -86,7 +111,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 {
   /**
@@ -135,7 +161,11 @@ export interface AddressInput {
   street_line_2?: string;
 
   /**
-   * Address type.
+   * How the address is used.
+   *
+   * - `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';
 }
@@ -162,6 +192,8 @@ export interface ListAddress {
 
 /**
  * Request to partially update an address.
+ *
+ * Omitted fields are left unchanged.
  */
 export interface UpdateAddressRequest {
   /**
@@ -171,6 +203,8 @@ export interface UpdateAddressRequest {
 
   /**
    * Email address associated with the address.
+   *
+   * Send `null` to clear.
    */
   email?: string | null;
 
@@ -186,6 +220,8 @@ export interface UpdateAddressRequest {
 
   /**
    * Phone number associated with the address.
+   *
+   * Send `null` to clear.
    */
   phone?: string | null;
 
@@ -206,17 +242,51 @@ export interface UpdateAddressRequest {
 
   /**
    * Second line of the street address.
+   *
+   * Send `null` to clear.
    */
   street_line_2?: string | null;
 
   /**
-   * Address type.
+   * How the address is used.
+   *
+   * - `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.
+   */
+  type?: 'standard' | 'drop_ship';
+}
+
 export interface AddressCreateParams {
   /**
    * Two-letter country code.
@@ -264,7 +334,11 @@ export interface AddressCreateParams {
   street_line_2?: string;
 
   /**
-   * Address type.
+   * How the address is used.
+   *
+   * - `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';
 }
@@ -277,6 +351,8 @@ export interface AddressUpdateParams {
 
   /**
    * Email address associated with the address.
+   *
+   * Send `null` to clear.
    */
   email?: string | null;
 
@@ -292,6 +368,8 @@ export interface AddressUpdateParams {
 
   /**
    * Phone number associated with the address.
+   *
+   * Send `null` to clear.
    */
   phone?: string | null;
 
@@ -312,33 +390,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.
+   * How the address is used.
+   *
+   * - `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';
 }
@@ -349,8 +411,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/contacts/actions.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BlocksAPI from '../../messaging/blocks';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * Look up the people you do business with.
+ */
+export class Actions extends APIResource {
+  /**
+   * Finds the contacts that match an email address.
+   *
+   * Only people on accounts you have a relationship with are returned — your
+   * customers, your suppliers, or your own account. A match's `relationship` says
+   * how you relate to the account it belongs to. Several accounts can share an
+   * email, so this can return more than one match.
+   *
+   * This endpoint requires the permission: `customers:read`.
+   *
+   * @example
+   * ```ts
+   * const listContactMatch =
+   *   await client.sales.contacts.actions.findByEmail({
+   *     email: 'buyer@acme-co.example',
+   *   });
+   * ```
+   */
+  findByEmail(params: ActionFindByEmailParams, options?: RequestOptions): APIPromise<ListContactMatch> {
+    const { include, relationships, ...body } = params;
+    return this._client.post('/v1/sales/contacts/actions/find-by-email', {
+      query: { include, relationships },
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * A contact found by email on an account you have a relationship with — one of
+ * your customers, your suppliers, or your own account.
+ *
+ * The same email can be a contact on many accounts across the platform; only
+ * accounts you relate to are returned. The matched person is available through
+ * `account_user` (and the shared profile through `account_user.user`), and the
+ * account they belong to through `account`.
+ */
+export interface ContactMatch {
+  /**
+   * Resource ID.
+   *
+   * This is the matched account user's ID, so the same value also appears as
+   * `account_user.id`.
+   */
+  id: string;
+
+  /**
+   * A customer account, including its branding and customer portal sub-resources.
+   */
+  account: APIKeysAPI.Account | null;
+
+  /**
+   * A user's membership in an account, carrying the account-specific status, role,
+   * and department.
+   *
+   * Profile fields (name, email, username, image URL) live on the expandable `user`
+   * sub-resource, which is shared across every account the user belongs to.
+   */
+  account_user: BlocksAPI.AccountUser | null;
+
+  /**
+   * The email address that was matched.
+   */
+  email: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'contact_match';
+
+  /**
+   * How you relate to the account this contact belongs to.
+   *
+   * - `customer` — the account is one of your customers.
+   * - `supplier` — the account is one of your suppliers.
+   * - `self` — the account is your own.
+   */
+  relationship: 'customer' | 'supplier' | 'self';
+}
+
+/**
+ * Request to find contacts by email.
+ */
+export interface FindContactByEmailRequest {
+  /**
+   * The email address to look up.
+   */
+  email: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListContactMatch {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ContactMatch>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface ActionFindByEmailParams {
+  /**
+   * Body param: The email address to look up.
+   */
+  email: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    'account_user' | 'account_user.user' | 'account_user.role' | 'account_user.department' | 'account'
+  >;
+
+  /**
+   * Query param: Filter to contacts whose relationship to you is one of these.
+   */
+  relationships?: Array<'customer' | 'supplier' | 'self'>;
+}
+
+export declare namespace Actions {
+  export {
+    type ContactMatch as ContactMatch,
+    type FindContactByEmailRequest as FindContactByEmailRequest,
+    type ListContactMatch as ListContactMatch,
+    type ActionFindByEmailParams as ActionFindByEmailParams,
+  };
+}

package/src/resources/sales/contacts/contacts.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ActionsAPI from './actions';
+import {
+  ActionFindByEmailParams,
+  Actions,
+  ContactMatch,
+  FindContactByEmailRequest,
+  ListContactMatch,
+} from './actions';
+
+export class Contacts extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+}
+
+Contacts.Actions = Actions;
+
+export declare namespace Contacts {
+  export {
+    Actions as Actions,
+    type ContactMatch as ContactMatch,
+    type FindContactByEmailRequest as FindContactByEmailRequest,
+    type ListContactMatch as ListContactMatch,
+    type ActionFindByEmailParams as ActionFindByEmailParams,
+  };
+}

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

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type ContactMatch,
+  type FindContactByEmailRequest,
+  type ListContactMatch,
+  type ActionFindByEmailParams,
+} from './actions';
+export { Contacts } from './contacts';

package/src/resources/sales/contacts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './contacts/index';

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

@@ -11,8 +11,14 @@ 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.
+   *
+   * This endpoint requires the permissions: `customers:update`, `customers:delete`.
    *
    * @example
    * ```ts
@@ -39,14 +45,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>;
 
@@ -60,10 +72,12 @@ export interface ActionMergeParams {
     | 'type'
     | 'parent_account'
     | 'freight_preferences.carrier'
+    | 'freight_preferences.carrier.service_levels'
     | 'freight_preferences.service_level'
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
     | 'defaults.sales_rep'
+    | 'defaults.sales_rep.user'
     | 'defaults.priority'
     | 'contact_info'
     | 'freight_preferences'
@@ -72,6 +86,7 @@ export interface ActionMergeParams {
     | 'price_groups'
     | 'child_accounts'
     | 'credit_limit'
+    | 'credit_limit.unit'
   >;
 }