@augno/sdk 0.7.0 → 0.9.0

package/src/resources/operations/shipping-terms.ts

@@ -15,6 +15,8 @@ export class ShippingTerms extends APIResource {
    * Returns a paginated list of shipping terms for the account, including default
    * system shipping terms.
    *
+   * This endpoint requires the permission: `shipping_terms:read`.
+   *
    * @example
    * ```ts
    * const listShippingTerm =
@@ -31,6 +33,8 @@ export class ShippingTerms extends APIResource {
   /**
    * Returns a shipping term by ID.
    *
+   * This endpoint requires the permission: `shipping_terms:read`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
@@ -50,12 +54,25 @@ export class ShippingTerms extends APIResource {
   /**
    * Creates an account-owned shipping term.
    *
+   * This endpoint requires the permission: `shipping_terms:create`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
    *   await client.operations.shippingTerms.create({
    *     name: 'Prepaid',
-   *     type: 'carrier_rate_freight',
+   *     type: 'flat_rate_freight',
+   *     flat_rate: {
+   *       value: '15.00',
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *     free_shipping_service_level_ids: [
+   *       'crop_01cfaf03f104e90ef9680e2a30',
+   *     ],
+   *     minimum_order_value: {
+   *       value: '500.00',
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
    *   });
    * ```
    */
@@ -69,12 +86,28 @@ export class ShippingTerms extends APIResource {
    *
    * System-provided default shipping terms cannot be updated.
    *
+   * This endpoint requires the permission: `shipping_terms:update`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
    *   await client.operations.shippingTerms.update(
    *     'shtm_014341ab4bb5bf94d5b6936f86',
-   *     { name: 'Collect' },
+   *     {
+   *       flat_rate: {
+   *         value: '15.00',
+   *         unit_id: 'un_01966263f74a5a0cae356000a1',
+   *       },
+   *       free_shipping_service_level_ids: [
+   *         'crop_01cfaf03f104e90ef9680e2a30',
+   *       ],
+   *       minimum_order_value: {
+   *         value: '500.00',
+   *         unit_id: 'un_01966263f74a5a0cae356000a1',
+   *       },
+   *       name: 'Collect',
+   *       type: 'flat_rate_freight',
+   *     },
    *   );
    * ```
    */
@@ -96,6 +129,8 @@ export class ShippingTerms extends APIResource {
    *
    * System-provided default shipping terms cannot be deleted.
    *
+   * This endpoint requires the permission: `shipping_terms:delete`.
+   *
    * @example
    * ```ts
    * const shippingTerm =

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

@@ -13,6 +13,8 @@ export class AccountGroups extends APIResource {
   /**
    * Returns a paginated list of account groups.
    *
+   * This endpoint requires the permission: `customer_groups:read`.
+   *
    * @example
    * ```ts
    * const listAccountGroup =
@@ -29,6 +31,8 @@ export class AccountGroups extends APIResource {
   /**
    * Returns an account group by ID.
    *
+   * This endpoint requires the permission: `customer_groups:read`.
+   *
    * @example
    * ```ts
    * const accountGroup =
@@ -46,12 +50,18 @@ export class AccountGroups extends APIResource {
    *
    * Returns a conflict error if an account group with the same name already exists.
    *
+   * This endpoint requires the permission: `customer_groups:create`.
+   *
    * @example
    * ```ts
    * const accountGroup =
    *   await client.sales.accountGroups.create({
    *     name: 'Wholesale Customers',
    *     type: 'type_group',
+   *     commission_policy: 'commission_exempt',
+   *     description:
+   *       'Customers who buy in bulk at wholesale pricing.',
+   *     freight_policy: 'billed_freight',
    *   });
    * ```
    */
@@ -65,12 +75,20 @@ export class AccountGroups extends APIResource {
    * Only the provided fields are changed. The account group's `type` cannot be
    * changed after creation.
    *
+   * This endpoint requires the permission: `customer_groups:update`.
+   *
    * @example
    * ```ts
    * const accountGroup =
    *   await client.sales.accountGroups.update(
    *     'acgp_018e88072d1320808dc979cfac',
-   *     { name: 'Updated Wholesale Customers' },
+   *     {
+   *       commission_policy: 'commission_exempt',
+   *       description:
+   *         'Customers who buy in bulk at wholesale pricing.',
+   *       freight_policy: 'billed_freight',
+   *       name: 'Updated Wholesale Customers',
+   *     },
    *   );
    * ```
    */
@@ -89,6 +107,8 @@ export class AccountGroups extends APIResource {
    * for example by customer records, product line access, volume discounts, pricing
    * assignments, or an active registration flow.
    *
+   * This endpoint requires the permission: `customer_groups:delete`.
+   *
    * @example
    * ```ts
    * const accountGroup =

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

@@ -79,7 +79,7 @@ export interface AccountStatus {
   created_at: string;
 
   /**
-   * Display name.
+   * Human-readable label for the status.
    */
   name: string;
 

package/src/resources/sales/addresses.ts

@@ -13,6 +13,9 @@ export class Addresses extends APIResource {
   /**
    * Returns a paginated list of addresses.
    *
+   * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listAddress = await client.sales.addresses.list();
@@ -25,6 +28,9 @@ export class Addresses extends APIResource {
   /**
    * 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,15 +45,22 @@ export class Addresses extends APIResource {
   /**
    * 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',
+   *   email: 'warehouse@acme.com',
    *   locality: 'Springfield',
+   *   phone: '555-123-4567',
    *   postal_code: '62701',
    *   state: 'IL',
    *   street_line_1: '123 Main St',
+   *   street_line_2: 'Suite 400',
+   *   type: 'standard',
    * });
    * ```
    */
@@ -61,11 +74,25 @@ export class Addresses extends APIResource {
    * 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' },
+   *   {
+   *     country: 'US',
+   *     email: 'warehouse@acme.com',
+   *     locality: 'Springfield',
+   *     name: 'Warehouse',
+   *     phone: '555-123-4567',
+   *     postal_code: '62701',
+   *     state: 'IL',
+   *     street_line_1: '123 Main St',
+   *     street_line_2: 'Suite 400',
+   *     type: 'standard',
+   *   },
    * );
    * ```
    */
@@ -83,6 +110,9 @@ export class Addresses extends APIResource {
    * 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
    * const address = await client.sales.addresses.delete(
@@ -146,7 +176,7 @@ 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
@@ -233,7 +263,7 @@ export interface UpdateAddressRequest {
   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
@@ -267,7 +297,7 @@ export interface AddressListParams {
   q?: string;
 
   /**
-   * Filter results to a single address type (`standard` or `drop_ship`).
+   * Filter results to a single address type.
    */
   type?: 'standard' | 'drop_ship';
 }
@@ -319,7 +349,7 @@ 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
@@ -381,7 +411,7 @@ export interface AddressUpdateParams {
   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

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

@@ -18,6 +18,8 @@ export class Actions extends APIResource {
    * 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
    * const customer = await client.sales.customers.actions.merge(
@@ -70,6 +72,7 @@ export interface ActionMergeParams {
     | 'type'
     | 'parent_account'
     | 'freight_preferences.carrier'
+    | 'freight_preferences.carrier.service_levels'
     | 'freight_preferences.service_level'
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
@@ -83,6 +86,7 @@ export interface ActionMergeParams {
     | 'price_groups'
     | 'child_accounts'
     | 'credit_limit'
+    | 'credit_limit.unit'
   >;
 }